NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.PrintPDFBuilder Class Reference

Represents a NXOpen.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.GeometricUtilities.IComponentBuilder

Public Types

enum  Color {
  AsDisplayed, PartColors, CustomPalette, BlackOnWhite,
  LegacyColors, ColorsByWidth
}
 Specifies the color option to use when creating the PDF document More...
 
enum  Width { StandardWidths, SingleWidth, CustomThreeWidths, CustomPalette }
 Specifies the primary selection of which type of width assignment to use. More...
 
enum  SizeOption { FullScale, ScaleFactor, Dimension }
 Specifies the size option of the PDF document. More...
 
enum  UnitsOption { Metric, English }
 Specifies which units are associated to the dimensions More...
 
enum  ImageResolutionOption { Draft, Low, Medium, High }
 Specifies the image resolution when exporting a raster image More...
 
enum  ActionOption { New, Overwrite, Append, Native }
 Specifies the action option to be used when running Teamcenter More...
 
enum  OutputTextOption { Text, Polylines }
 Specifies the output text option, as either text or polylines More...
 
enum  RelationOption { Specification, Manifestation, Undefined }
 Specifies the relation to use when exporting a PDF to Teamcenter More...
 

Public Member Functions

unsafe void Assign ()
 The Assign button will assign an appropriate name to the Dataset field if Create New is chosen as the Action. More...
 
unsafe void DefinePalette ()
 Initialize the Color Palette. More...
 
unsafe void DefineWidths ()
 Initialize the Width dialog. More...
 
unsafe NXOpen.CDF CreateCdf ()
 Creates and returns a NXOpen.CDF object representing the Color Palette. More...
 
unsafe NXOpen.CDF GetCdf ()
 Returns a NXOpen.CDF object representing the Color Palette. More...
 
unsafe NXOpen.WidthDefinition CreateWidthDefinition ()
 Creates and returns a NXOpen.WidthDefinition object representing the Width Palette. More...
 
unsafe NXOpen.WidthDefinition GetWidthDefinition ()
 Returns a NXOpen.WidthDefinition object representing the Width Palette. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe
NXOpen.PrintPDFBuilder.ActionOption 
Action [get, set]
 Returns or sets the action option to be used when saving the PDF file in a Teamcenter environment. More...
 
unsafe bool AddWatermark [get, set]
 Returns or sets the Add Watermark option. More...
 
unsafe bool Append [get, set]
 Returns or sets the Append option. More...
 
unsafe NXOpen.PrintPDFBuilder.Color Colors [get, set]
 Returns or sets the color option to be used when creating the PDF document. More...
 
unsafe bool CustomSymbolsInForeground [get, set]
 Returns or sets the plotting custom symbols in the foreground option. More...
 
unsafe string DatasetName [get, set]
 Returns or sets the dataset name to be used when Creating a New PDF document in a Teamcenter environment. More...
 
unsafe string DatasetType [get, set]
 Returns or sets the dataset type to be used when exporting a PDF to Teamcenter More...
 
unsafe string Filename [get, set]
 Returns or sets the filename to be used upon creation of the PDF document. More...
 
unsafe
NXOpen.PrintPDFBuilder.ImageResolutionOption 
ImageResolution [get, set]
 Returns or sets the resolution of images created for export of shaded views. More...
 
unsafe string NamedReferenceType [get, set]
 Returns or sets the named reference type to be used when exporting a PDF to Teamcenter More...
 
unsafe
NXOpen.PrintPDFBuilder.OutputTextOption 
OutputText [get, set]
 Returns or sets the output text of the PDF. More...
 
unsafe bool RasterImages [get, set]
 Returns or sets the Raster Images option. More...
 
unsafe
NXOpen.PrintPDFBuilder.RelationOption 
Relation [get, set]
 Returns or sets the relation to be used when exporting a PDF to Teamcenter More...
 
unsafe double Scale [get, set]
 Returns or sets the scale factor to be used when creating a PDF document. More...
 
unsafe bool ShadedGeometry [get, set]
 Returns or sets the Shaded Geometry as Wireframe option. More...
 
unsafe
NXOpen.PrintPDFBuilder.SizeOption 
Size [get, set]
 Returns or sets the size of the PDF document. More...
 
unsafe NXOpen.PlotSourceBuilder SourceBuilder [get]
 Returns the Source builder. More...
 
unsafe
NXOpen.PrintPDFBuilder.UnitsOption 
Units [get, set]
 Returns or sets the units of the X and Y dimensions to be used when Dimension has been selected from the Size option. More...
 
unsafe string Watermark [get, set]
 Returns or sets the watermark text. More...
 
unsafe NXOpen.PrintPDFBuilder.Width Widths [get, set]
 Returns or sets the width option. More...
 
unsafe double XDimension [get, set]
 Returns or sets the x dimension to be used when Dimension has been selected from the Size option. More...
 
unsafe double YDimension [get, set]
 Returns or sets the y dimension to be used when Dimension has been selected from the Size option. More...
 

Detailed Description

Represents a NXOpen.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 NXOpen.PlotManager .

All sheets provided must be in the displayed part.

To create a new instance of this class, use NXOpen.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
New 

Create a new PDF document

Overwrite 

Overwrite existing PDF document

Append 

Append to existing PDF document

Native 

Export to native folder

Specifies the color option to use when creating the PDF document

Enumerator
AsDisplayed 

As Displayed

PartColors 

Part Colors

CustomPalette 

Custom Palette

BlackOnWhite 

Black on White

LegacyColors 

Legacy Colors

ColorsByWidth 

Part Colors

Specifies the image resolution when exporting a raster image

Enumerator
Draft 

Draft Resolution

Low 

Low Resolution

Medium 

Medium Resolution

High 

High Resolution

Specifies the output text option, as either text or polylines

Enumerator
Text 

Text is kept as text

Polylines 

Text is exported as polylines

Specifies the relation to use when exporting a PDF to Teamcenter

Enumerator
Specification 

Specification

Manifestation 

Manifestation

Undefined 

This option is not defined

Specifies the size option of the PDF document.

Enumerator
FullScale 

Full Scale

ScaleFactor 

Scale Factor

Dimension 

Dimension

Specifies which units are associated to the dimensions

Enumerator
Metric 

Metric

English 

English

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

Enumerator
StandardWidths 

Standard Widths

SingleWidth 

Single Width

CustomThreeWidths 

Custom Three Widths

CustomPalette 

Custom palette

Member Function Documentation

unsafe 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.

unsafe NXOpen.CDF NXOpen.PrintPDFBuilder.CreateCdf ( )

Creates and returns a NXOpen.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.

Created in NX5.0.0

License requirements: None.

Returns
CDF object
unsafe NXOpen.WidthDefinition NXOpen.PrintPDFBuilder.CreateWidthDefinition ( )

Creates and returns a NXOpen.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.

Created in NX5.0.0

License requirements: None.

Returns
WidthDefinition object
unsafe 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.

unsafe 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.

unsafe NXOpen.CDF NXOpen.PrintPDFBuilder.GetCdf ( )

Returns a NXOpen.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.

Created in NX5.0.0

License requirements: None.

Returns
CDF object
unsafe NXOpen.WidthDefinition NXOpen.PrintPDFBuilder.GetWidthDefinition ( )

Returns a NXOpen.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.

Created in NX5.0.0

License requirements: None.

Returns
WidthDefinition object

Property Documentation

unsafe NXOpen.PrintPDFBuilder.ActionOption NXOpen.PrintPDFBuilder.Action
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PrintPDFBuilder.AddWatermark
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PrintPDFBuilder.Append
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PrintPDFBuilder.Color NXOpen.PrintPDFBuilder.Colors
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PrintPDFBuilder.CustomSymbolsInForeground
getset

Returns or sets the plotting custom symbols in the foreground option.

Setting this option on will cause custom symbols to be plotted in the foreground. When this option is off, geometry may overlap custom symbols when plotted.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PrintPDFBuilder.DatasetName
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PrintPDFBuilder.DatasetType
getset

Returns or sets the dataset type to be used when exporting a PDF to Teamcenter

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PrintPDFBuilder.Filename
getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PrintPDFBuilder.ImageResolutionOption NXOpen.PrintPDFBuilder.ImageResolution
getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PrintPDFBuilder.NamedReferenceType
getset

Returns or sets the named reference type to be used when exporting a PDF to Teamcenter

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PrintPDFBuilder.OutputTextOption NXOpen.PrintPDFBuilder.OutputText
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PrintPDFBuilder.RasterImages
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PrintPDFBuilder.RelationOption NXOpen.PrintPDFBuilder.Relation
getset

Returns or sets the relation to be used when exporting a PDF to Teamcenter

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.PrintPDFBuilder.Scale
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PrintPDFBuilder.ShadedGeometry
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PrintPDFBuilder.SizeOption NXOpen.PrintPDFBuilder.Size
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotSourceBuilder NXOpen.PrintPDFBuilder.SourceBuilder
get

Returns the Source builder.

The Source builder contains all data involving the selected sheets.

Created in NX5.0.1

License requirements: None.

unsafe NXOpen.PrintPDFBuilder.UnitsOption NXOpen.PrintPDFBuilder.Units
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PrintPDFBuilder.Watermark
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PrintPDFBuilder.Width NXOpen.PrintPDFBuilder.Widths
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.PrintPDFBuilder.XDimension
getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.PrintPDFBuilder.YDimension
getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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