NXOpen .NET Reference Guide
1899
|
Represents a NXOpen.PlotBuilder . More...
Public Types | |
enum | ImageResolutionOption { Draft, Low, Medium, High } |
Specifies the plot image resolution More... | |
enum | JustificationOption { Left, Center, Right } |
Specifies the justification of the banner More... | |
enum | PlotTypes { Standard, UsingLayout } |
Specifies the type of plot More... | |
enum | RotationOption { Degree0, Degree90, Degree180, Degree270 } |
Specifies the rotation of the banner 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... | |
Public Member Functions | |
unsafe void | AddToPlotLayout () |
Add Plot to Layout. More... | |
unsafe void | AdvancedPlot () |
Initialize the SDI dialog. More... | |
unsafe void | ClearPlotLayout () |
Clear Plot from Layout. More... | |
unsafe string[] | GetFilenames () |
Gets all the temporary CGM filenames to be plotted. More... | |
unsafe string[] | GetGraphicFilenames () |
Gets all the Graphic filenames to be saved. More... | |
unsafe void | SaveCgm () |
Saves the selected sheets as CGM files. More... | |
unsafe void | SetFilenames (string[] filenames) |
Sets all the temporary CGM filenames to be plotted. 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... | |
Public Member Functions inherited from NXOpen.TaggedObject | |
void | PrintTestData (String variableName) |
<exclude> More... | |
void | PrintTestData (String variableName, int lineNumber) |
<exclude> More... | |
override string | ToString () |
Returns a String that represents the current Object. More... | |
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageCtrl | AsyncProcessMessage (IMessage msg, IMessageSink replySink) |
Asynchronously processes the given message. More... | |
IMessage | SyncProcessMessage (IMessage msg) |
Synchronously processes the given message. 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 string | PlotterText [get, set] |
Returns or sets the plotter text. More... | |
unsafe NXOpen.PlotBuilder.PlotTypes | PlotType [get, set] |
Returns or sets the type of plot. 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... | |
Properties inherited from NXOpen.Builder | |
unsafe NXOpen.PreviewBuilder | PreviewBuilder [get] |
Returns the preview builder subobject. More... | |
Properties inherited from NXOpen.TaggedObject | |
Tag | Tag [get] |
Returns the tag of this object. More... | |
Properties inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageSink | NextSink [get] |
Gets the next message sink in the sink chain. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from NXOpen.TaggedObject | |
new void | initialize () |
<exclude> More... | |
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
|
inline |
Add Plot to Layout.
This routine adds a sheet to the plot layout.
Created in NX5.0.0
License requirements: None.
|
inline |
Initialize the SDI dialog.
Created in NX5.0.0
License requirements: None.
|
inline |
Clear Plot from Layout.
This routine clears all sheets from the plot layout.
Created in NX5.0.0
License requirements: None.
|
inline |
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.
|
inline |
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.
|
inline |
Saves the selected sheets as CGM files.
Created in NX5.0.0
License requirements: None.
|
inline |
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.
filenames |
|
inline |
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.
filenames |
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.