Represents a NXOpen.PlotBuilder . More...

Inheritance diagram for NXOpen.PlotBuilder:

Public Types
enum	PlotTypes { Standard, UsingLayout }
	Specifies the type of plot More...

enum	UnitsOption { Metric, English }
	Specifies which units are associated to the dimensions More...

enum	XdisplayOption { Left, Center, Right }
	Specifies the x-coordinate for the banner location More...

enum	YdisplayOption { Bottom, Center, Top }
	Specifies the y-coordinate for the banner location More...

enum	RotationOption { Degree0, Degree90, Degree180, Degree270 }
	Specifies the rotation of the banner More...

enum	JustificationOption { Left, Center, Right }
	Specifies the justification of the banner More...

enum	ImageResolutionOption { Draft, Low, Medium, High }
	Specifies the plot image resolution More...

Public Member Functions
unsafe void	AddToPlotLayout ()
	Add Plot to Layout. More...

unsafe void	ClearPlotLayout ()
	Clear Plot from Layout. More...

unsafe void	SaveCgm ()
	Saves the selected sheets as CGM files. More...

unsafe void	AdvancedPlot ()
	Initialize the SDI dialog. More...

unsafe string[]	GetFilenames ()
	Gets all the temporary CGM filenames to be plotted. More...

unsafe void	SetFilenames (string[] filenames)
	Sets all the temporary CGM filenames to be plotted. More...

unsafe string[]	GetGraphicFilenames ()
	Gets all the Graphic filenames to be saved. More...

unsafe void	SetGraphicFilenames (string[] filenames)
	Sets all the Graphic filenames to be saved. 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 string	BannerMessage `[get, set]`
	Returns or sets the banner message. More...

unsafe double	CharacterSize `[get, set]`
	Returns or sets the character size of the banner. More...

unsafe bool	ClsfData `[get, set]`
	Returns or sets the option to plot clsf data. More...

unsafe NXOpen.PlotColorsWidthsBuilder	ColorsWidthsBuilder `[get]`
	Returns the Colors Widths builder. More...

unsafe int	Copies `[get, set]`
	Returns or sets the number of copies to be plotted. More...

unsafe bool	CustomSymbolsInForeground `[get, set]`
	Returns or sets the plotting custom symbols in the foreground option. More...

unsafe bool	DisplayBanner `[get, set]`
	Returns or sets the display banner. More...

unsafe NXOpen.PlotBuilder.ImageResolutionOption	ImageResolution `[get, set]`
	Returns or sets the resolution of images created for plotting shaded views. More...

unsafe string	JobName `[get, set]`
	Returns or sets the job name to be used for plotting. More...

unsafe NXOpen.PlotBuilder.JustificationOption	Justification `[get, set]`
	Returns or sets the justification of the banner text. More...

unsafe NXOpen.PlotBuilder.PlotTypes	PlotType `[get, set]`
	Returns or sets the type of plot. More...

unsafe string	PlotterText `[get, set]`
	Returns or sets the plotter text. More...

unsafe string	PrinterGroupText `[get, set]`
	Returns or sets the printer group text. More...

unsafe string	ProfileText `[get, set]`
	Returns or sets the profile text. More...

unsafe bool	RasterImages `[get, set]`
	Returns or sets the raster images option. More...

unsafe NXOpen.PlotBuilder.RotationOption	Rotation `[get, set]`
	Returns or sets the rotation of the banner. More...

unsafe bool	ShadedGeometry `[get, set]`
	Returns or sets the shaded geometry as wireframe option. More...

unsafe NXOpen.PlotSourceBuilder	SourceBuilder `[get]`
	Returns the Source builder. More...

unsafe double	Tolerance `[get, set]`
	Returns or sets the plotting tolerance. More...

unsafe NXOpen.PlotBuilder.UnitsOption	Units `[get, set]`
	Returns or sets the units used to create the banner. More...

unsafe NXOpen.PlotBuilder.XdisplayOption	XDisplay `[get, set]`
	Returns or sets the X coordinate of a banner. More...

unsafe double	XOffset `[get, set]`
	Returns or sets the X coordinate offset of a banner. More...

unsafe NXOpen.PlotBuilder.YdisplayOption	YDisplay `[get, set]`
	Returns or sets the Y coordinate of a banner. More...

unsafe double	YOffset `[get, set]`
	Returns or sets the Y coordinate offset of a banner. More...

Detailed Description

Represents a NXOpen.PlotBuilder .

This class contains all information relating to plotting. The user must specify the sheets to be plotted by setting the appropriate fields through the NXOpen.PlotSourceBuilder . For each sheet selected, a temporary CGM file name must be supplied. Once the sheets are selected, the user must set the plotter and profile fields. If the plotter selected is an image file (JPEG, TIFF, EMF, CGM, or PNG), then a graphic filename must also be supplied for each sheet selected. The PlotBuilder class also handles all Banner data and Manufacturing data to be used during plotting. This class 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.CreatePlotBuilder

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.PlotBuilder.ImageResolutionOption

Specifies the plot image resolution

Enumerator
Draft	Draft Resolution
Low	Low Resolution
Medium	Medium Resolution
High	High Resolution

enum NXOpen.PlotBuilder.JustificationOption

Specifies the justification of the banner

Enumerator
Left	Left Justify
Center	Center Justify
Right	Right Justify

enum NXOpen.PlotBuilder.PlotTypes

Specifies the type of plot

Enumerator
Standard	Standard Plot
UsingLayout	Plot Using a Layout

enum NXOpen.PlotBuilder.RotationOption

Specifies the rotation of the banner

Enumerator
Degree0	0 degree rotation
Degree90	90 degree rotation
Degree180	180 degree rotation
Degree270	270 degree rotation

enum NXOpen.PlotBuilder.UnitsOption

Specifies which units are associated to the dimensions

Enumerator
Metric	Metric
English	English

enum NXOpen.PlotBuilder.XdisplayOption

Specifies the x-coordinate for the banner location

Enumerator
Left	X dimension left
Center	X dimension center
Right	X dimension right

enum NXOpen.PlotBuilder.YdisplayOption

Specifies the y-coordinate for the banner location

Enumerator
Bottom	Y dimension bottom
Center	Y dimension center
Top	Y dimension top

Member Function Documentation

unsafe void NXOpen.PlotBuilder.AddToPlotLayout ( )

Add Plot to Layout.

This routine adds a sheet to the plot layout.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotBuilder.AdvancedPlot ( )

Initialize the SDI dialog.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotBuilder.ClearPlotLayout ( )

Clear Plot from Layout.

This routine clears all sheets from the plot layout.

Created in NX5.0.0

License requirements: None.

unsafe string [] NXOpen.PlotBuilder.GetFilenames ( )

Gets all the temporary CGM filenames to be plotted.

This list will contain the full path of the temporary CGM file to be used during plotting. This list must equal the number of sheets selected to plot and these files will be deleted after the plotting operation is finished.

Created in NX5.0.0

License requirements: None.

Returns

unsafe string [] NXOpen.PlotBuilder.GetGraphicFilenames ( )

Gets all the Graphic filenames to be saved.

If the plotter selected is an image type (JPEG, CGM, TIFF, EMF, or PNG) then the graphic filenames text list will contain the full path of where these images will be saved to disk. This list must equal the number of sheets selected to plot.

Created in NX5.0.0

License requirements: None.

Returns

unsafe void NXOpen.PlotBuilder.SaveCgm ( )

Saves the selected sheets as CGM files.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.PlotBuilder.SetFilenames ( string[] filenames )

Sets all the temporary CGM filenames to be plotted.

This list will contain the full path of the temporary CGM file to be used during plotting. This list must equal the number of sheets selected to plot and the files will be deleted after the plotting operation is finished.

Created in NX5.0.0

License requirements: None.

Parameters

filenames

unsafe void NXOpen.PlotBuilder.SetGraphicFilenames ( string[] filenames )

Sets all the Graphic filenames to be saved.

If the plotter selected is an image type (JPEG, CGM, TIFF, EMF, or PNG) then the graphic filenames text list will contain the full path of where these images will be saved to disk. This list must equal the number of sheets selected to plot.

Created in NX5.0.0

License requirements: None.

Parameters

filenames

Property Documentation

unsafe string NXOpen.PlotBuilder.BannerMessage

getset

Returns or sets the banner message.

This text field will be added to the banner if Display Banner is set to true.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.PlotBuilder.CharacterSize

getset

Returns or sets the character size of the banner.

If Display Banner is true, the character size value will be used to determine the size of the banner text.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PlotBuilder.ClsfData

getset

Returns or sets the option to plot clsf data.

If clsf data is true, the current clsf data will be included in the plot.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotColorsWidthsBuilder NXOpen.PlotBuilder.ColorsWidthsBuilder

get

Returns the Colors Widths builder.

The Colors Widths builder contains all information relating to both colors and widths.

Created in NX5.0.0

License requirements: None.

unsafe int NXOpen.PlotBuilder.Copies

getset

Returns or sets the number of copies to be plotted.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PlotBuilder.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 bool NXOpen.PlotBuilder.DisplayBanner

getset

Returns or sets the display banner.

If true, the specified banner options will be used in adding a banner to the plot. If false, no banner will be used to plot.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotBuilder.ImageResolutionOption NXOpen.PlotBuilder.ImageResolution

getset

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

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PlotBuilder.JobName

getset

Returns or sets the job name to be used for plotting.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotBuilder.JustificationOption NXOpen.PlotBuilder.Justification

getset

Returns or sets the justification of the banner text.

If Display Banner is true, the justification will be used to position the banner text. This can be set to Left Justify, Center Justify, or Right Justify.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PlotBuilder.PlotterText

getset

Returns or sets the plotter text.

The plotter field represents which plotter the user wishes to plot to, it can be an available printer or an image type (JPEG, CGM, TIFF, EMF, or PNG). If the plotter is a printer, then the appropriate printer group containing the chosen printer must also be set.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotBuilder.PlotTypes NXOpen.PlotBuilder.PlotType

getset

Returns or sets the type of plot.

This can be Standard or Plot Using a Layout.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PlotBuilder.PrinterGroupText

getset

Returns or sets the printer group text.

The printer group must be set if a printer is used as the plotter.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PlotBuilder.ProfileText

getset

Returns or sets the profile text.

The profile must be a valid SDI created profile associated with the current plotter.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PlotBuilder.RasterImages

getset

Returns or sets the raster images option.

This option determines whether or not raster images will be used when plotting.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotBuilder.RotationOption NXOpen.PlotBuilder.Rotation

getset

Returns or sets the rotation of the banner.

This can be set to 0, 90, 180, or 270 and will determine the rotation of the banner if Display Banner is true.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PlotBuilder.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.PlotSourceBuilder NXOpen.PlotBuilder.SourceBuilder

get

Returns the Source builder.

The Source builder contains all data involving the sheets to to be plotted.

Created in NX5.0.0

License requirements: None.

unsafe double NXOpen.PlotBuilder.Tolerance

getset

Returns or sets the plotting tolerance.

The tolerance is a unitless value that controls the accuracy or smoothness of plotted curve geometry. Values must be greater than or equal to 0.0001. Smaller values produce smoother curves.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotBuilder.UnitsOption NXOpen.PlotBuilder.Units

getset

Returns or sets the units used to create the banner.

The units can be either English or Metric and they pertain to the X-offset, the Y-offset, and the character size when creating a banner.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotBuilder.XdisplayOption NXOpen.PlotBuilder.XDisplay

getset

Returns or sets the X coordinate of a banner.

If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Left, Center, or Right.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.PlotBuilder.XOffset

getset

Returns or sets the X coordinate offset of a banner.

If Display Banner is true, the X offset will be used as the offset value in combination with the X coordinate to determine where the banner will appear when plotting.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PlotBuilder.YdisplayOption NXOpen.PlotBuilder.YDisplay

getset

Returns or sets the Y coordinate of a banner.

If Display Banner is true, the X and Y coordinates will determine where the banner will appear when plotting. This can be set to Bottom, Center, or Top.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.PlotBuilder.YOffset

getset

Returns or sets the Y coordinate offset of a banner.

If Display Banner is true, the Y offset will be used as the offset value in combination with the Y coordinate to determine where the banner will appear when plotting.

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:

dotnet_pool/PlotBuilder.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation