Represents a PrintBuilder . More...
Public Member Functions | |
| int | Copies () |
| Returns the number of copies. | |
| int | CustomPaper () |
| Returns the custom paper. | |
| NXOpen::PrintBuilder::ImageResolutionOption | ImageResolution () |
| Returns the resolution of images created for printing shaded views. | |
| double | NormalWidth () |
| Returns the normal width scale factor. | |
| NXOpen::PrintBuilder::OrientationOption | Orientation () |
| Returns the orientation. | |
| NXOpen::PrintBuilder::OutputOption | Output () |
| Returns the shaded image option. | |
| NXOpen::PrintBuilder::PaperSize | Paper () |
| Returns the paper. | |
| NXString | PrinterText () |
| Returns the printer text. | |
| bool | RasterImages () |
| Returns the raster images option. | |
| void | SetCopies (int copies) |
| Sets the number of copies. | |
| void | SetCustomPaper (int customPaper) |
| Sets the custom paper. | |
| void | SetImageResolution (NXOpen::PrintBuilder::ImageResolutionOption imageResolution) |
| Sets the resolution of images created for printing shaded views. | |
| void | SetNormalWidth (double normalWidth) |
| Sets the normal width scale factor. | |
| void | SetOrientation (NXOpen::PrintBuilder::OrientationOption orientationOption) |
| Sets the orientation. | |
| void | SetOutput (NXOpen::PrintBuilder::OutputOption outputOption) |
| Sets the shaded image option. | |
| void | SetPaper (NXOpen::PrintBuilder::PaperSize paper) |
| Sets the paper. | |
| void | SetPrinterText (const NXString &printer) |
| Sets the printer text. | |
| void | SetPrinterText (const char *printer) |
| Sets the printer text. | |
| void | SetRasterImages (bool rasterImages) |
| Sets the raster images option. | |
| void | SetShadedGeometry (bool shadedGeometry) |
| Sets the shaded geometry as wireframe option. | |
| void | SetThickWidth (double thickWidth) |
| Sets the thick width scale factor. | |
| void | SetThinWidth (double thinWidth) |
| Sets the thin width scale factor. | |
| void | SetWhiteBackground (bool whiteBackground) |
| Sets the white background option. | |
| void | SetWidth1ScaleFactor (double width1ScaleFactor) |
| Sets the width1 scale factor. | |
| void | SetWidth2ScaleFactor (double width2ScaleFactor) |
| Sets the width2 scale factor. | |
| void | SetWidth3ScaleFactor (double width3ScaleFactor) |
| Sets the width3 scale factor. | |
| void | SetWidth4ScaleFactor (double width4ScaleFactor) |
| Sets the width4 scale factor. | |
| void | SetWidth5ScaleFactor (double width5ScaleFactor) |
| Sets the width5 scale factor. | |
| void | SetWidth6ScaleFactor (double width6ScaleFactor) |
| Sets the width6 scale factor. | |
| void | SetWidth7ScaleFactor (double width7ScaleFactor) |
| Sets the width7 scale factor. | |
| void | SetWidth8ScaleFactor (double width8ScaleFactor) |
| Sets the width8 scale factor. | |
| void | SetWidth9ScaleFactor (double width9ScaleFactor) |
| Sets the width9 scale factor. | |
| bool | ShadedGeometry () |
| Returns the shaded geometry as wireframe option. | |
| NXOpen::PlotSourceBuilder * | SourceBuilder () |
| Returns the Source builder. | |
| double | ThickWidth () |
| Returns the thick width scale factor. | |
| double | ThinWidth () |
| Returns the thin width scale factor. | |
| bool | WhiteBackground () |
| Returns the white background option. | |
| double | Width1ScaleFactor () |
| Returns the width1 scale factor. | |
| double | Width2ScaleFactor () |
| Returns the width2 scale factor. | |
| double | Width3ScaleFactor () |
| Returns the width3 scale factor. | |
| double | Width4ScaleFactor () |
| Returns the width4 scale factor. | |
| double | Width5ScaleFactor () |
| Returns the width5 scale factor. | |
| double | Width6ScaleFactor () |
| Returns the width6 scale factor. | |
| double | Width7ScaleFactor () |
| Returns the width7 scale factor. | |
| double | Width8ScaleFactor () |
| Returns the width8 scale factor. | |
| double | Width9ScaleFactor () |
| Returns the width9 scale factor. | |
 Public Member Functions inherited from NXOpen::Builder | |
| 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. | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
Detailed Description
Represents a PrintBuilder .
This class is for use on Windows only and contains all information relating to printing. It is created using PlotManager .
The user must specify the sheets to be printed by setting the appropriate fields through the PlotSourceBuilder . The printer text and copies fields must be set in order to successfully print the provided sheets. The printer text is the path of the desired printer and the copies field represents the number of copies to be printed. This class also allows for the line widths to be scaled by setting the appropriate thin, normal, or thick scale factors.
To create a new instance of this class, use PlotManager::CreatePrintBuilder
Default values.
| Property | Value |
|---|---|
|
Orientation |
Landscape |
|
Width1ScaleFactor |
1.0 |
|
Width2ScaleFactor |
2.0 |
|
Width3ScaleFactor |
3.0 |
|
Width4ScaleFactor |
4.0 |
|
Width5ScaleFactor |
5.0 |
|
Width6ScaleFactor |
6.0 |
|
Width7ScaleFactor |
7.0 |
|
Width8ScaleFactor |
8.0 |
|
Width9ScaleFactor |
9.0 |
Created in NX5.0.1.
Member Enumeration Documentation
Specifies the output option when printing Current Display.
Specifies the paper size of the printed sheet.
- Enumerator:
Member Function Documentation
| int NXOpen::PrintBuilder::Copies | ( | ) |
Returns the number of copies.
This option specifies the number of copies to be printed.
Created in NX5.0.1.
License requirements : None
| int NXOpen::PrintBuilder::CustomPaper | ( | ) |
Returns the custom paper.
This will be used if the paper size is set to Custom.
Created in NX6.0.2.
License requirements : None
| NXOpen::PrintBuilder::ImageResolutionOption NXOpen::PrintBuilder::ImageResolution | ( | ) |
Returns the resolution of images created for printing shaded views.
Created in NX5.0.1.
License requirements : None
| double NXOpen::PrintBuilder::NormalWidth | ( | ) |
Returns the normal width scale factor.
This number is used as a scale factor for normal width lines. It cannot be less than 0.0.
Created in NX5.0.1.
License requirements : None
| NXOpen::PrintBuilder::OrientationOption NXOpen::PrintBuilder::Orientation | ( | ) |
Returns the orientation.
This options determines the orientation of the printed page.
Created in NX6.0.0.
License requirements : None
| NXOpen::PrintBuilder::OutputOption NXOpen::PrintBuilder::Output | ( | ) |
Returns the shaded image option.
The Current Display will be printed using the correct current shading if this option is set.
Created in NX5.0.1.
License requirements : None
| NXOpen::PrintBuilder::PaperSize NXOpen::PrintBuilder::Paper | ( | ) |
Returns the paper.
This options determines the paper size used for printing. Note that all options may not available on all printers.
Created in NX6.0.0.
License requirements : None
| NXString NXOpen::PrintBuilder::PrinterText | ( | ) |
Returns the printer text.
The printer field represents the full path name of the printer the user wishes to print to.
Created in NX5.0.1.
License requirements : None
| bool NXOpen::PrintBuilder::RasterImages | ( | ) |
Returns the raster images option.
This option determines whether or not raster images will be used when printing.
Created in NX5.0.1.
License requirements : None
| void NXOpen::PrintBuilder::SetCopies | ( | int | copies | ) |
Sets the number of copies.
This option specifies the number of copies to be printed.
Created in NX5.0.1.
License requirements : None
- Parameters
-
copies copies
| void NXOpen::PrintBuilder::SetCustomPaper | ( | int | customPaper | ) |
Sets the custom paper.
This will be used if the paper size is set to Custom.
Created in NX6.0.2.
License requirements : None
- Parameters
-
customPaper custompaper
| void NXOpen::PrintBuilder::SetImageResolution | ( | NXOpen::PrintBuilder::ImageResolutionOption | imageResolution | ) |
Sets the resolution of images created for printing shaded views.
Created in NX5.0.1.
License requirements : None
- Parameters
-
imageResolution imageresolution
| void NXOpen::PrintBuilder::SetNormalWidth | ( | double | normalWidth | ) |
Sets the normal width scale factor.
This number is used as a scale factor for normal width lines. It cannot be less than 0.0.
Created in NX5.0.1.
License requirements : None
- Parameters
-
normalWidth normalwidth
| void NXOpen::PrintBuilder::SetOrientation | ( | NXOpen::PrintBuilder::OrientationOption | orientationOption | ) |
Sets the orientation.
This options determines the orientation of the printed page.
Created in NX6.0.0.
License requirements : None
- Parameters
-
orientationOption orientationoption
| void NXOpen::PrintBuilder::SetOutput | ( | NXOpen::PrintBuilder::OutputOption | outputOption | ) |
Sets the shaded image option.
The Current Display will be printed using the correct current shading if this option is set.
Created in NX5.0.1.
License requirements : None
- Parameters
-
outputOption outputoption
| void NXOpen::PrintBuilder::SetPaper | ( | NXOpen::PrintBuilder::PaperSize | paper | ) |
Sets the paper.
This options determines the paper size used for printing. Note that all options may not available on all printers.
Created in NX6.0.0.
License requirements : None
- Parameters
-
paper paper
| void NXOpen::PrintBuilder::SetPrinterText | ( | const NXString & | printer | ) |
Sets the printer text.
The printer field represents the full path name of the printer the user wishes to print to.
Created in NX5.0.1.
License requirements : None
- Parameters
-
printer printer
| void NXOpen::PrintBuilder::SetPrinterText | ( | const char * | printer | ) |
Sets the printer text.
The printer field represents the full path name of the printer the user wishes to print to.
Created in NX5.0.1.
License requirements : None
- Parameters
-
printer printer
| void NXOpen::PrintBuilder::SetRasterImages | ( | bool | rasterImages | ) |
Sets the raster images option.
This option determines whether or not raster images will be used when printing.
Created in NX5.0.1.
License requirements : None
- Parameters
-
rasterImages rasterimages
| void NXOpen::PrintBuilder::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.1.
License requirements : None
- Parameters
-
shadedGeometry shadedgeometry
| void NXOpen::PrintBuilder::SetThickWidth | ( | double | thickWidth | ) |
Sets the thick width scale factor.
This number is used as a scale factor for thick width lines. It cannot be less than 0.0.
Created in NX5.0.1.
License requirements : None
- Parameters
-
thickWidth thickwidth
| void NXOpen::PrintBuilder::SetThinWidth | ( | double | thinWidth | ) |
Sets the thin width scale factor.
This number is used as a scale factor for thin width lines. It cannot be less than 0.0.
Created in NX5.0.1.
License requirements : None
- Parameters
-
thinWidth thinwidth
| void NXOpen::PrintBuilder::SetWhiteBackground | ( | bool | whiteBackground | ) |
Sets the white background option.
When printing a shaded view, this option allows for the background to be white. Only set to true if printing Current Display and "Shaded Image" is also set to true.
Created in NX5.0.1.
License requirements : None
- Parameters
-
whiteBackground whitebackground
| void NXOpen::PrintBuilder::SetWidth1ScaleFactor | ( | double | width1ScaleFactor | ) |
Sets the width1 scale factor.
This number is used as a scale factor for width1 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width1ScaleFactor width1scalefactor
| void NXOpen::PrintBuilder::SetWidth2ScaleFactor | ( | double | width2ScaleFactor | ) |
Sets the width2 scale factor.
This number is used as a scale factor for width2 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width2ScaleFactor width2scalefactor
| void NXOpen::PrintBuilder::SetWidth3ScaleFactor | ( | double | width3ScaleFactor | ) |
Sets the width3 scale factor.
This number is used as a scale factor for width3 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width3ScaleFactor width3scalefactor
| void NXOpen::PrintBuilder::SetWidth4ScaleFactor | ( | double | width4ScaleFactor | ) |
Sets the width4 scale factor.
This number is used as a scale factor for width4 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width4ScaleFactor width4scalefactor
| void NXOpen::PrintBuilder::SetWidth5ScaleFactor | ( | double | width5ScaleFactor | ) |
Sets the width5 scale factor.
This number is used as a scale factor for width5 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width5ScaleFactor width5scalefactor
| void NXOpen::PrintBuilder::SetWidth6ScaleFactor | ( | double | width6ScaleFactor | ) |
Sets the width6 scale factor.
This number is used as a scale factor for width6 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width6ScaleFactor width6scalefactor
| void NXOpen::PrintBuilder::SetWidth7ScaleFactor | ( | double | width7ScaleFactor | ) |
Sets the width7 scale factor.
This number is used as a scale factor for width7 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width7ScaleFactor width7scalefactor
| void NXOpen::PrintBuilder::SetWidth8ScaleFactor | ( | double | width8ScaleFactor | ) |
Sets the width8 scale factor.
This number is used as a scale factor for width8 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width8ScaleFactor width8scalefactor
| void NXOpen::PrintBuilder::SetWidth9ScaleFactor | ( | double | width9ScaleFactor | ) |
Sets the width9 scale factor.
This number is used as a scale factor for width9 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
- Parameters
-
width9ScaleFactor width9scalefactor
| bool NXOpen::PrintBuilder::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.1.
License requirements : None
| NXOpen::PlotSourceBuilder* NXOpen::PrintBuilder::SourceBuilder | ( | ) |
Returns the Source builder.
The Source builder contains all data involving the sheets to to be printed.
Created in NX5.0.1.
License requirements : None
| double NXOpen::PrintBuilder::ThickWidth | ( | ) |
Returns the thick width scale factor.
This number is used as a scale factor for thick width lines. It cannot be less than 0.0.
Created in NX5.0.1.
License requirements : None
| double NXOpen::PrintBuilder::ThinWidth | ( | ) |
Returns the thin width scale factor.
This number is used as a scale factor for thin width lines. It cannot be less than 0.0.
Created in NX5.0.1.
License requirements : None
| bool NXOpen::PrintBuilder::WhiteBackground | ( | ) |
Returns the white background option.
When printing a shaded view, this option allows for the background to be white. Only set to true if printing Current Display and "Shaded Image" is also set to true.
Created in NX5.0.1.
License requirements : None
| double NXOpen::PrintBuilder::Width1ScaleFactor | ( | ) |
Returns the width1 scale factor.
This number is used as a scale factor for width1 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width2ScaleFactor | ( | ) |
Returns the width2 scale factor.
This number is used as a scale factor for width2 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width3ScaleFactor | ( | ) |
Returns the width3 scale factor.
This number is used as a scale factor for width3 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width4ScaleFactor | ( | ) |
Returns the width4 scale factor.
This number is used as a scale factor for width4 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width5ScaleFactor | ( | ) |
Returns the width5 scale factor.
This number is used as a scale factor for width5 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width6ScaleFactor | ( | ) |
Returns the width6 scale factor.
This number is used as a scale factor for width6 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width7ScaleFactor | ( | ) |
Returns the width7 scale factor.
This number is used as a scale factor for width7 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width8ScaleFactor | ( | ) |
Returns the width8 scale factor.
This number is used as a scale factor for width8 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
| double NXOpen::PrintBuilder::Width9ScaleFactor | ( | ) |
Returns the width9 scale factor.
This number is used as a scale factor for width9 lines. It cannot be less than 0.0.
Created in NX8.5.0.
License requirements : None
The documentation for this class was generated from the following file:
- PrintBuilder.hxx