NX Open C++ Reference Guide
|
Represents a PrintPDFBuilder to be used when exporting the Current Display or selected sheets to a PDF document. More...
Public Member Functions | |
NXOpen::PrintPDFBuilder::ActionOption | Action () |
Returns the action option to be used when saving the PDF file in a Teamcenter environment. | |
bool | AddWatermark () |
Returns the Add Watermark option. | |
bool | Append () |
Returns the Append option. | |
void | Assign () |
The Assign button will assign an appropriate name to the Dataset field if Create New is chosen as the Action. | |
NXOpen::PrintPDFBuilder::Color | Colors () |
Returns the color option to be used when creating the PDF document. | |
NXOpen::CDF * | CreateCdf () |
Creates and returns a CDF object representing the Color Palette. | |
NXOpen::WidthDefinition * | CreateWidthDefinition () |
Creates and returns a WidthDefinition object representing the Width Palette. | |
NXString | DatasetName () |
Returns the dataset name to be used when Creating a New PDF document in a Teamcenter environment. | |
NXString | DatasetType () |
Returns the dataset type to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
void | DefinePalette () |
Initialize the Color Palette. | |
void | DefineWidths () |
Initialize the Width dialog. | |
NXString | Filename () |
Returns the filename to be used upon creation of the PDF document. | |
NXOpen::CDF * | GetCdf () |
Returns a CDF object representing the Color Palette. | |
NXOpen::WidthDefinition * | GetWidthDefinition () |
Returns a WidthDefinition object representing the Width Palette. | |
NXOpen::PrintPDFBuilder::ImageResolutionOption | ImageResolution () |
Returns the resolution of images created for export of shaded views. | |
NXString | NamedReferenceType () |
Returns the named reference type to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
NXOpen::PrintPDFBuilder::OutputTextOption | OutputText () |
Returns the output text of the PDF. | |
bool | RasterImages () |
Returns the Raster Images option. | |
NXOpen::PrintPDFBuilder::RelationOption | Relation () |
Returns the relation to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
double | Scale () |
Returns the scale factor to be used when creating a PDF document. | |
void | SetAction (NXOpen::PrintPDFBuilder::ActionOption action) |
Sets the action option to be used when saving the PDF file in a Teamcenter environment. | |
void | SetAddWatermark (bool addWatermark) |
Sets the Add Watermark option. | |
void | SetAppend (bool append) |
Sets the Append option. | |
void | SetColors (NXOpen::PrintPDFBuilder::Color colors) |
Sets the color option to be used when creating the PDF document. | |
void | SetDatasetName (const NXString &datasetName) |
Sets the dataset name to be used when Creating a New PDF document in a Teamcenter environment. | |
void | SetDatasetName (const char *datasetName) |
Sets the dataset name to be used when Creating a New PDF document in a Teamcenter environment. | |
void | SetDatasetType (const NXString &datasetType) |
Sets the dataset type to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
void | SetDatasetType (const char *datasetType) |
Sets the dataset type to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
void | SetFilename (const NXString &filename) |
Sets the filename to be used upon creation of the PDF document. | |
void | SetFilename (const char *filename) |
Sets the filename to be used upon creation of the PDF document. | |
void | SetImageResolution (NXOpen::PrintPDFBuilder::ImageResolutionOption imageResolution) |
Sets the resolution of images created for export of shaded views. | |
void | SetNamedReferenceType (const NXString &namedReferenceType) |
Sets the named reference type to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
void | SetNamedReferenceType (const char *namedReferenceType) |
Sets the named reference type to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
void | SetOutputText (NXOpen::PrintPDFBuilder::OutputTextOption outputText) |
Sets the output text of the PDF. | |
void | SetRasterImages (bool rasterImages) |
Sets the Raster Images option. | |
void | SetRelation (NXOpen::PrintPDFBuilder::RelationOption relation) |
Sets the relation to be used when exporting a PDF to Teamcenter Created in NX7.5.0. | |
void | SetScale (double scale) |
Sets the scale factor to be used when creating a PDF document. | |
void | SetShadedGeometry (bool shadedGeometry) |
Sets the Shaded Geometry as Wireframe option. | |
void | SetSize (NXOpen::PrintPDFBuilder::SizeOption size) |
Sets the size of the PDF document. | |
void | SetUnits (NXOpen::PrintPDFBuilder::UnitsOption units) |
Sets the units of the X and Y dimensions to be used when Dimension has been selected from the Size option. | |
void | SetWatermark (const NXString &watermark) |
Sets the watermark text. | |
void | SetWatermark (const char *watermark) |
Sets the watermark text. | |
void | SetWidths (NXOpen::PrintPDFBuilder::Width widths) |
Sets the width option. | |
void | SetXDimension (double xDimension) |
Sets the x dimension to be used when Dimension has been selected from the Size option. | |
void | SetYDimension (double yDimension) |
Sets the y dimension to be used when Dimension has been selected from the Size option. | |
bool | ShadedGeometry () |
Returns the Shaded Geometry as Wireframe option. | |
NXOpen::PrintPDFBuilder::SizeOption | Size () |
Returns the size of the PDF document. | |
NXOpen::PlotSourceBuilder * | SourceBuilder () |
Returns the Source builder. | |
NXOpen::PrintPDFBuilder::UnitsOption | Units () |
Returns the units of the X and Y dimensions to be used when Dimension has been selected from the Size option. | |
NXString | Watermark () |
Returns the watermark text. | |
NXOpen::PrintPDFBuilder::Width | Widths () |
Returns the width option. | |
double | XDimension () |
Returns the x dimension to be used when Dimension has been selected from the Size option. | |
double | YDimension () |
Returns the y dimension to be used when Dimension has been selected from the Size option. | |
![]() | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
Represents a PrintPDFBuilder to be used when exporting the Current Display or selected sheets to a PDF document.
This class is for use on Windows only and is created using PlotManager .
To create a new instance of this class, use PlotManager::CreatePrintPdfbuilder
Default values.
Property | Value |
---|---|
Relation |
Undefined |
Created in NX5.0.0.
NXOpen::PrintPDFBuilder::ActionOption NXOpen::PrintPDFBuilder::Action | ( | ) |
Returns the action option to be used when saving the PDF file in a Teamcenter environment.
This can be set to Create New, Overwrite Existing PDF, or Append to Existing PDF.
Created in NX5.0.0.
License requirements : None
bool NXOpen::PrintPDFBuilder::AddWatermark | ( | ) |
Returns the Add Watermark option.
If Add Watermark is set to false, no Watermark will be added to the PDF document. If Add Watermark is set to true, the user defined watermark text will be added as a watermark to the PDF document.
Created in NX5.0.0.
License requirements : None
bool NXOpen::PrintPDFBuilder::Append | ( | ) |
Returns the Append option.
If Append is set to false, a new PDF document will be created and will overwrite an existing PDF document. If Append is set to true, the selected sheets will be appended to the existing PDF document.
Created in NX5.0.0.
License requirements : None
void NXOpen::PrintPDFBuilder::Assign | ( | ) |
The Assign button will assign an appropriate name to the Dataset field if Create New is chosen as the Action.
Created in NX5.0.0.
License requirements : None
NXOpen::PrintPDFBuilder::Color NXOpen::PrintPDFBuilder::Colors | ( | ) |
Returns the color option to be used when creating the PDF document.
If the color option is set to Custom Palette or Colors By Width then the PDF document will be created with the user defined color attributes belonging to the CDF object.
Created in NX5.0.0.
License requirements : None
NXOpen::CDF* NXOpen::PrintPDFBuilder::CreateCdf | ( | ) |
Creates and returns a CDF object representing the Color Palette.
This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option. @return CDF object
Created in NX5.0.0.
License requirements : None
NXOpen::WidthDefinition* NXOpen::PrintPDFBuilder::CreateWidthDefinition | ( | ) |
Creates and returns a WidthDefinition object representing the Width Palette.
This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.
NXString NXOpen::PrintPDFBuilder::DatasetName | ( | ) |
Returns the dataset name to be used when Creating a New PDF document in a Teamcenter environment.
The dataset name will be used if Create New, Overwrite Existing PDF, or Append to Existing PDF are selected as the Action.
Created in NX5.0.0.
License requirements : None
NXString NXOpen::PrintPDFBuilder::DatasetType | ( | ) |
Returns the dataset type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
void NXOpen::PrintPDFBuilder::DefinePalette | ( | ) |
Initialize the Color Palette.
This allows the user to change the attributes of any color. These changed colors will be used if Custom Palette or Colors By Width is selected as the color option.
Created in NX5.0.0.
License requirements : None
void NXOpen::PrintPDFBuilder::DefineWidths | ( | ) |
Initialize the Width dialog.
This allows the user to change the attributes of Single Width, Custom Three Widths, or Custom Palette. These changed width values will be used depending on the width option selected.
Created in NX5.0.0.
License requirements : None
NXString NXOpen::PrintPDFBuilder::Filename | ( | ) |
Returns the filename to be used upon creation of the PDF document.
Created in NX5.0.0.
License requirements : None
NXOpen::CDF* NXOpen::PrintPDFBuilder::GetCdf | ( | ) |
Returns a CDF object representing the Color Palette.
This object contains all custom color information to be used when Custom Palette or Colors By Width is selected from the Color option. @return CDF object
Created in NX5.0.0.
License requirements : None
NXOpen::WidthDefinition* NXOpen::PrintPDFBuilder::GetWidthDefinition | ( | ) |
Returns a WidthDefinition object representing the Width Palette.
This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option. @return WidthDefinition object
Created in NX5.0.0.
License requirements : None
NXOpen::PrintPDFBuilder::ImageResolutionOption NXOpen::PrintPDFBuilder::ImageResolution | ( | ) |
Returns the resolution of images created for export of shaded views.
Created in NX5.0.0.
License requirements : None
NXString NXOpen::PrintPDFBuilder::NamedReferenceType | ( | ) |
Returns the named reference type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
NXOpen::PrintPDFBuilder::OutputTextOption NXOpen::PrintPDFBuilder::OutputText | ( | ) |
Returns the output text of the PDF.
This will determine whether the drawing text will be exported as text or as polylines.
Created in NX6.0.0.
License requirements : None
bool NXOpen::PrintPDFBuilder::RasterImages | ( | ) |
Returns the Raster Images option.
This option determines whether or not raster images will be exported to the PDF document.
Created in NX5.0.0.
License requirements : None
NXOpen::PrintPDFBuilder::RelationOption NXOpen::PrintPDFBuilder::Relation | ( | ) |
Returns the relation to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
double NXOpen::PrintPDFBuilder::Scale | ( | ) |
Returns the scale factor to be used when creating a PDF document.
This value ranges from 0.00 to 1.00 and will only be used if the Size option is set to Scale.
Created in NX5.0.0.
License requirements : None
void NXOpen::PrintPDFBuilder::SetAction | ( | NXOpen::PrintPDFBuilder::ActionOption | action | ) |
Sets the action option to be used when saving the PDF file in a Teamcenter environment.
This can be set to Create New, Overwrite Existing PDF, or Append to Existing PDF.
Created in NX5.0.0.
License requirements : None
action | action |
void NXOpen::PrintPDFBuilder::SetAddWatermark | ( | bool | addWatermark | ) |
Sets the Add Watermark option.
If Add Watermark is set to false, no Watermark will be added to the PDF document. If Add Watermark is set to true, the user defined watermark text will be added as a watermark to the PDF document.
Created in NX5.0.0.
License requirements : None
addWatermark | addwatermark |
void NXOpen::PrintPDFBuilder::SetAppend | ( | bool | append | ) |
Sets the Append option.
If Append is set to false, a new PDF document will be created and will overwrite an existing PDF document. If Append is set to true, the selected sheets will be appended to the existing PDF document.
Created in NX5.0.0.
License requirements : None
append | append |
void NXOpen::PrintPDFBuilder::SetColors | ( | NXOpen::PrintPDFBuilder::Color | colors | ) |
Sets the color option to be used when creating the PDF document.
If the color option is set to Custom Palette or Colors By Width then the PDF document will be created with the user defined color attributes belonging to the CDF object.
Created in NX5.0.0.
License requirements : None
colors | colors |
void NXOpen::PrintPDFBuilder::SetDatasetName | ( | const NXString & | datasetName | ) |
Sets the dataset name to be used when Creating a New PDF document in a Teamcenter environment.
The dataset name will be used if Create New, Overwrite Existing PDF, or Append to Existing PDF are selected as the Action.
Created in NX5.0.0.
License requirements : None
datasetName | datasetname |
void NXOpen::PrintPDFBuilder::SetDatasetName | ( | const char * | datasetName | ) |
Sets the dataset name to be used when Creating a New PDF document in a Teamcenter environment.
The dataset name will be used if Create New, Overwrite Existing PDF, or Append to Existing PDF are selected as the Action.
Created in NX5.0.0.
License requirements : None
datasetName | datasetname |
void NXOpen::PrintPDFBuilder::SetDatasetType | ( | const NXString & | datasetType | ) |
Sets the dataset type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
datasetType | datasettype |
void NXOpen::PrintPDFBuilder::SetDatasetType | ( | const char * | datasetType | ) |
Sets the dataset type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
datasetType | datasettype |
void NXOpen::PrintPDFBuilder::SetFilename | ( | const NXString & | filename | ) |
Sets the filename to be used upon creation of the PDF document.
Created in NX5.0.0.
License requirements : None
filename | filename |
void NXOpen::PrintPDFBuilder::SetFilename | ( | const char * | filename | ) |
Sets the filename to be used upon creation of the PDF document.
Created in NX5.0.0.
License requirements : None
filename | filename |
void NXOpen::PrintPDFBuilder::SetImageResolution | ( | NXOpen::PrintPDFBuilder::ImageResolutionOption | imageResolution | ) |
Sets the resolution of images created for export of shaded views.
Created in NX5.0.0.
License requirements : None
imageResolution | imageresolution |
void NXOpen::PrintPDFBuilder::SetNamedReferenceType | ( | const NXString & | namedReferenceType | ) |
Sets the named reference type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
namedReferenceType | namedreferencetype |
void NXOpen::PrintPDFBuilder::SetNamedReferenceType | ( | const char * | namedReferenceType | ) |
Sets the named reference type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
namedReferenceType | namedreferencetype |
void NXOpen::PrintPDFBuilder::SetOutputText | ( | NXOpen::PrintPDFBuilder::OutputTextOption | outputText | ) |
Sets the output text of the PDF.
This will determine whether the drawing text will be exported as text or as polylines.
Created in NX6.0.0.
License requirements : None
outputText | outputtext |
void NXOpen::PrintPDFBuilder::SetRasterImages | ( | bool | rasterImages | ) |
Sets the Raster Images option.
This option determines whether or not raster images will be exported to the PDF document.
Created in NX5.0.0.
License requirements : None
rasterImages | rasterimages |
void NXOpen::PrintPDFBuilder::SetRelation | ( | NXOpen::PrintPDFBuilder::RelationOption | relation | ) |
Sets the relation to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.
License requirements : None
relation | relation |
void NXOpen::PrintPDFBuilder::SetScale | ( | double | scale | ) |
Sets the scale factor to be used when creating a PDF document.
This value ranges from 0.00 to 1.00 and will only be used if the Size option is set to Scale.
Created in NX5.0.0.
License requirements : None
scale | scale |
void NXOpen::PrintPDFBuilder::SetShadedGeometry | ( | bool | shadedGeometry | ) |
Sets the Shaded Geometry as Wireframe option.
If set to true, this option will show shaded objects as wireframes. The shaded objects will be represented as shaded if this option is set to false.
Created in NX5.0.0.
License requirements : None
shadedGeometry | shadedgeometry |
void NXOpen::PrintPDFBuilder::SetSize | ( | NXOpen::PrintPDFBuilder::SizeOption | size | ) |
Sets the size of the PDF document.
If the size is set to Scale, then the PDF will use the user-defined Scale Factor. If the size is set to dimension, then the PDF will use the user-defined X and Y dimensions.
Created in NX5.0.0.
License requirements : None
size | size |
void NXOpen::PrintPDFBuilder::SetUnits | ( | NXOpen::PrintPDFBuilder::UnitsOption | units | ) |
Sets the units of the X and Y dimensions to be used when Dimension has been selected from the Size option.
Created in NX5.0.0.
License requirements : None
units | units |
void NXOpen::PrintPDFBuilder::SetWatermark | ( | const NXString & | watermark | ) |
Sets the watermark text.
This user-defined text will appear as a watermark to the PDF document only if Add Watermark is set to true.
Created in NX5.0.0.
License requirements : None
watermark | watermark |
void NXOpen::PrintPDFBuilder::SetWatermark | ( | const char * | watermark | ) |
Sets the watermark text.
This user-defined text will appear as a watermark to the PDF document only if Add Watermark is set to true.
Created in NX5.0.0.
License requirements : None
watermark | watermark |
void NXOpen::PrintPDFBuilder::SetWidths | ( | NXOpen::PrintPDFBuilder::Width | widths | ) |
Sets the width option.
If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the PDF document will be created with the user defined width attributes belonging to the WidthDefinition object.
Created in NX5.0.0.
License requirements : None
widths | widths |
void NXOpen::PrintPDFBuilder::SetXDimension | ( | double | xDimension | ) |
Sets the x dimension to be used when Dimension has been selected from the Size option.
Created in NX5.0.0.
License requirements : None
xDimension | xdimension |
void NXOpen::PrintPDFBuilder::SetYDimension | ( | double | yDimension | ) |
Sets the y dimension to be used when Dimension has been selected from the Size option.
Created in NX5.0.0.
License requirements : None
yDimension | ydimension |
bool NXOpen::PrintPDFBuilder::ShadedGeometry | ( | ) |
Returns the Shaded Geometry as Wireframe option.
If set to true, this option will show shaded objects as wireframes. The shaded objects will be represented as shaded if this option is set to false.
Created in NX5.0.0.
License requirements : None
NXOpen::PrintPDFBuilder::SizeOption NXOpen::PrintPDFBuilder::Size | ( | ) |
Returns the size of the PDF document.
If the size is set to Scale, then the PDF will use the user-defined Scale Factor. If the size is set to dimension, then the PDF will use the user-defined X and Y dimensions.
Created in NX5.0.0.
License requirements : None
NXOpen::PlotSourceBuilder* NXOpen::PrintPDFBuilder::SourceBuilder | ( | ) |
Returns the Source builder.
The Source builder contains all data involving the selected sheets.
Created in NX5.0.1.
License requirements : None
NXOpen::PrintPDFBuilder::UnitsOption NXOpen::PrintPDFBuilder::Units | ( | ) |
Returns the units of the X and Y dimensions to be used when Dimension has been selected from the Size option.
Created in NX5.0.0.
License requirements : None
NXString NXOpen::PrintPDFBuilder::Watermark | ( | ) |
Returns the watermark text.
This user-defined text will appear as a watermark to the PDF document only if Add Watermark is set to true.
Created in NX5.0.0.
License requirements : None
NXOpen::PrintPDFBuilder::Width NXOpen::PrintPDFBuilder::Widths | ( | ) |
Returns the width option.
If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the PDF document will be created with the user defined width attributes belonging to the WidthDefinition object.
Created in NX5.0.0.
License requirements : None
double NXOpen::PrintPDFBuilder::XDimension | ( | ) |
Returns the x dimension to be used when Dimension has been selected from the Size option.
Created in NX5.0.0.
License requirements : None
double NXOpen::PrintPDFBuilder::YDimension | ( | ) |
Returns the y dimension to be used when Dimension has been selected from the Size option.
Created in NX5.0.0.
License requirements : None