NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::PrintPDFBuilder Class Reference

Represents a PrintPDFBuilder to be used when exporting the Current Display or selected sheets to a PDF document. More...

Inheritance diagram for NXOpen::PrintPDFBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ActionOption { ActionOptionNew, ActionOptionOverwrite, ActionOptionAppend, ActionOptionNative }
 Specifies the action option to be used when running Teamcenter. More...
enum  Color {
  ColorAsDisplayed, ColorPartColors, ColorCustomPalette, ColorBlackOnWhite,
  ColorLegacyColors, ColorColorsByWidth
}
 Specifies the color option to use when creating the PDF document. More...
enum  ImageResolutionOption { ImageResolutionOptionDraft, ImageResolutionOptionLow, ImageResolutionOptionMedium, ImageResolutionOptionHigh }
 Specifies the image resolution when exporting a raster image. More...
enum  OutputTextOption { OutputTextOptionText, OutputTextOptionPolylines }
 Specifies the output text option, as either text or polylines. More...
enum  RelationOption { RelationOptionSpecification, RelationOptionManifestation, RelationOptionUndefined }
 Specifies the relation to use when exporting a PDF to Teamcenter. More...
enum  SizeOption { SizeOptionFullScale, SizeOptionScaleFactor, SizeOptionDimension }
 Specifies the size option of the PDF document. More...
enum  UnitsOption { UnitsOptionMetric, UnitsOptionEnglish }
 Specifies which units are associated to the dimensions. More...
enum  Width { WidthStandardWidths, WidthSingleWidth, WidthCustomThreeWidths, WidthCustomPalette }
 Specifies the primary selection of which type of width assignment to use. 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::CDFCreateCdf ()
 Creates and returns a CDF object representing the Color Palette.
NXOpen::WidthDefinitionCreateWidthDefinition ()
 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::CDFGetCdf ()
 Returns a CDF object representing the Color Palette.
NXOpen::WidthDefinitionGetWidthDefinition ()
 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 SetDatasetType (const NXString &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 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 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 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::PlotSourceBuilderSourceBuilder ()
 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.

Detailed Description

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.


Member Enumeration Documentation

Specifies the action option to be used when running Teamcenter.

Enumerator:
ActionOptionNew 

Create a new PDF document.

ActionOptionOverwrite 

Overwrite existing PDF document.

ActionOptionAppend 

Append to existing PDF document.

ActionOptionNative 

Export to native folder.

Specifies the color option to use when creating the PDF document.

Enumerator:
ColorAsDisplayed 

As Displayed.

ColorPartColors 

Part Colors.

ColorCustomPalette 

Custom Palette.

ColorBlackOnWhite 

Black on White.

ColorLegacyColors 

Legacy Colors.

ColorColorsByWidth 

Part Colors.

Specifies the image resolution when exporting a raster image.

Enumerator:
ImageResolutionOptionDraft 

Draft Resolution.

ImageResolutionOptionLow 

Low Resolution.

ImageResolutionOptionMedium 

Medium Resolution.

ImageResolutionOptionHigh 

High Resolution.

Specifies the output text option, as either text or polylines.

Enumerator:
OutputTextOptionText 

Text is kept as text.

OutputTextOptionPolylines 

Text is exported as polylines.

Specifies the relation to use when exporting a PDF to Teamcenter.

Enumerator:
RelationOptionSpecification 

Specification.

RelationOptionManifestation 

Manifestation.

RelationOptionUndefined 

This option is not defined.

Specifies the size option of the PDF document.

Enumerator:
SizeOptionFullScale 

Full Scale.

SizeOptionScaleFactor 

Scale Factor.

SizeOptionDimension 

Dimension.

Specifies which units are associated to the dimensions.

Enumerator:
UnitsOptionMetric 

Metric.

UnitsOptionEnglish 

English.

Specifies the primary selection of which type of width assignment to use.

Enumerator:
WidthStandardWidths 

Standard Widths.

WidthSingleWidth 

Single Width.

WidthCustomThreeWidths 

Custom Three Widths.

WidthCustomPalette 

Custom palette.


Member Function Documentation

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

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

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

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

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

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.

Returns:
CDF object
Created in NX5.0.0.

License requirements : None

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.

Returns:
WidthDefinition object
Created in NX5.0.0.

License requirements : None

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

Returns the dataset type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.



License requirements : None

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

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

Returns the filename to be used upon creation of the PDF document.


Created in NX5.0.0.

License requirements : None

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.

Returns:
CDF object
Created in NX5.0.0.

License requirements : None

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.

Returns:
WidthDefinition object
Created in NX5.0.0.

License requirements : None

Returns the resolution of images created for export of shaded views.


Created in NX5.0.0.

License requirements : None

Returns the named reference type to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.



License requirements : None

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

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

Returns the relation to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.



License requirements : None

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

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

Parameters:
actionaction
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

Parameters:
addWatermarkaddwatermark
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

Parameters:
appendappend

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

Parameters:
colorscolors
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

Parameters:
datasetNamedatasetname
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

Parameters:
datasetTypedatasettype
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

Parameters:
filenamefilename

Sets the resolution of images created for export of shaded views.


Created in NX5.0.0.

License requirements : None

Parameters:
imageResolutionimageresolution
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

Parameters:
namedReferenceTypenamedreferencetype

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

Parameters:
outputTextoutputtext
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

Parameters:
rasterImagesrasterimages

Sets the relation to be used when exporting a PDF to Teamcenter
Created in NX7.5.0.



License requirements : None

Parameters:
relationrelation
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

Parameters:
scalescale
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

Parameters:
shadedGeometryshadedgeometry

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

Parameters:
sizesize

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

Parameters:
unitsunits
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

Parameters:
watermarkwatermark

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

Parameters:
widthswidths
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

Parameters:
xDimensionxdimension
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

Parameters:
yDimensionydimension

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

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

Returns the Source builder.

The Source builder contains all data involving the selected sheets.
Created in NX5.0.1.

License requirements : None

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

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

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

Returns the x dimension to be used when Dimension has been selected from the Size option.


Created in NX5.0.0.

License requirements : None

Returns the y dimension to be used when Dimension has been selected from the Size option.


Created in NX5.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.