| java.lang.Object | ||
| ↳ | com.pdftron.pdf.OptionsBase | |
| ↳ | com.pdftron.pdf.CADConvertOptions | |
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | CADConvertOptions.LayoutSortOrder | Layout sorting options | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
CADConvertOptions()
Constructor.
| |||||||||||
|
CADConvertOptions(String json_string)
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| CADConvertOptions |
addSheets(String value)
Adds a Sheets to the Sheets array
The list of sheets to be converted -- only applies to .rvt conversions
| ||||||||||
| boolean |
getAllowThinLines()
Gets the value AllowThinLines from the options object
Sets drawing line weights to zero
| ||||||||||
| boolean |
getAutoRotate()
Gets the value AutoRotate from the options object
Maps the orientation to the sheet dimensions
| ||||||||||
| ColorPt |
getBackgroundColor()
Gets the value BackgroundColor from the options object
Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color)
| ||||||||||
| String |
getColorMode()
Gets the value ColorMode from the options object
Sets the color palette used by the drawing export.
| ||||||||||
| boolean |
getIncludeModel()
Gets the value IncludeModel from the options object
Instructs the conversion process to include the model layout (default: true).
| ||||||||||
| CADConvertOptions.LayoutSortOrder |
getLayoutSortOrder()
Gets the value LayoutSortOrder from the options object
Specifies how the layout is sorted during cad to pdf conversion.
| ||||||||||
| int |
getMaxXrefDepth()
Gets the value MaxXrefDepth from the options object
Maximum resolution depth for nested xrefs.
| ||||||||||
| double |
getPageHeight()
Gets the value PageHeight from the options object
The height of the output pdf, in millimeters
| ||||||||||
| double |
getPageWidth()
Gets the value PageWidth from the options object
The width of the output pdf, in millimeters
| ||||||||||
| double |
getRasterDPI()
Gets the value RasterDPI from the options object
Rasterization dpi used when rendering 3D content.
| ||||||||||
| boolean |
getUnderlineTextDataFields()
Gets the value UnderlineTextDataFields from the options object
If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline.
| ||||||||||
| boolean |
getUseScaleFromDocument()
Gets the value UseScaleFromDocument from the options object
If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm.
| ||||||||||
| boolean |
getZoomToExtents()
Gets the value ZoomToExtents from the options object
If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied.
| ||||||||||
| CADConvertOptions |
setAllowThinLines(boolean value)
Sets the value for AllowThinLines in the options object
Sets drawing line weights to zero
| ||||||||||
| CADConvertOptions |
setAutoRotate(boolean value)
Sets the value for AutoRotate in the options object
Maps the orientation to the sheet dimensions
| ||||||||||
| CADConvertOptions |
setBackgroundColor(ColorPt value)
Sets the value for BackgroundColor in the options object
Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color)
| ||||||||||
| CADConvertOptions |
setColorMode(String value)
Sets the value for ColorMode in the options object
Sets the color palette used by the drawing export.
| ||||||||||
| CADConvertOptions |
setIncludeModel(boolean value)
Sets the value for IncludeModel in the options object
Instructs the conversion process to include the model layout (default: true).
| ||||||||||
| CADConvertOptions |
setLayoutSortOrder(CADConvertOptions.LayoutSortOrder value)
Sets the value for LayoutSortOrder in the options object
Specifies how the layout is sorted during cad to pdf conversion.
| ||||||||||
| CADConvertOptions |
setMaxXrefDepth(int value)
Sets the value for MaxXrefDepth in the options object
Maximum resolution depth for nested xrefs.
| ||||||||||
| CADConvertOptions |
setPageHeight(double value)
Sets the value for PageHeight in the options object
The height of the output pdf, in millimeters
| ||||||||||
| CADConvertOptions |
setPageWidth(double value)
Sets the value for PageWidth in the options object
The width of the output pdf, in millimeters
| ||||||||||
| CADConvertOptions |
setRasterDPI(double value)
Sets the value for RasterDPI in the options object
Rasterization dpi used when rendering 3D content.
| ||||||||||
| CADConvertOptions |
setUnderlineTextDataFields(boolean value)
Sets the value for UnderlineTextDataFields in the options object
If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline.
| ||||||||||
| CADConvertOptions |
setUseScaleFromDocument(boolean value)
Sets the value for UseScaleFromDocument in the options object
If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm.
| ||||||||||
| CADConvertOptions |
setZoomToExtents(boolean value)
Sets the value for ZoomToExtents in the options object
If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
Public Methods
public CADConvertOptions addSheets (String value)
Adds a Sheets to the Sheets array The list of sheets to be converted -- only applies to .rvt conversions
Parameters
| value | a String -- The list of sheets to be converted -- only applies to .rvt conversions |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public boolean getAllowThinLines ()
Gets the value AllowThinLines from the options object Sets drawing line weights to zero
Returns
- a boolean, Sets drawing line weights to zero.
Throws
| PDFNetException |
|---|
public boolean getAutoRotate ()
Gets the value AutoRotate from the options object Maps the orientation to the sheet dimensions
Returns
- a boolean, Maps the orientation to the sheet dimensions.
Throws
| PDFNetException |
|---|
public ColorPt getBackgroundColor ()
Gets the value BackgroundColor from the options object Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color)
Returns
- a ColorPt, Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color).
Throws
| PDFNetException |
|---|
public String getColorMode ()
Gets the value ColorMode from the options object Sets the color palette used by the drawing export. Possible values are Mono (i.e., monochrome) and Gray (i.e., grayscale), otherwise drawing's original palette is used
Returns
- a String, Sets the color palette used by the drawing export. Possible values are Mono (i.e., monochrome) and Gray (i.e., grayscale), otherwise drawing's original palette is used.
Throws
| PDFNetException |
|---|
public boolean getIncludeModel ()
Gets the value IncludeModel from the options object Instructs the conversion process to include the model layout (default: true). Note that if the model layout is empty, it will never be included in the output
Returns
- a boolean, Instructs the conversion process to include the model layout (default: true). Note that if the model layout is empty, it will never be included in the output.
Throws
| PDFNetException |
|---|
public CADConvertOptions.LayoutSortOrder getLayoutSortOrder ()
Gets the value LayoutSortOrder from the options object Specifies how the layout is sorted during cad to pdf conversion. This affects how each layout is inserted into the output pdf (each layout becomes a pdf page).
Returns
- a LayoutSortOrder, Specifies how the layout is sorted during cad to pdf conversion. This affects how each layout is inserted into the output pdf (each layout becomes a pdf page)..
Throws
| PDFNetException |
|---|
public int getMaxXrefDepth ()
Gets the value MaxXrefDepth from the options object Maximum resolution depth for nested xrefs. Root drawing starts at level 0, subsequent nested levels increment by 1. Nested xrefs at levels greater than specified will not be loaded.
Returns
- a int, Maximum resolution depth for nested xrefs. Root drawing starts at level 0, subsequent nested levels increment by 1. Nested xrefs at levels greater than specified will not be loaded..
Throws
| PDFNetException |
|---|
public double getPageHeight ()
Gets the value PageHeight from the options object The height of the output pdf, in millimeters
Returns
- a double, The height of the output pdf, in millimeters.
Throws
| PDFNetException |
|---|
public double getPageWidth ()
Gets the value PageWidth from the options object The width of the output pdf, in millimeters
Returns
- a double, The width of the output pdf, in millimeters.
Throws
| PDFNetException |
|---|
public double getRasterDPI ()
Gets the value RasterDPI from the options object Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions
Returns
- a double, Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions.
Throws
| PDFNetException |
|---|
public boolean getUnderlineTextDataFields ()
Gets the value UnderlineTextDataFields from the options object If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default.
Returns
- a boolean, If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default.
Throws
| PDFNetException |
|---|
public boolean getUseScaleFromDocument ()
Gets the value UseScaleFromDocument from the options object If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm. Paper size dimensions are clamped at 5080 mm, and are rescaled if coordinate ranges exceed 5080 mm. Disabled by default.
Returns
- a boolean, If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm. Paper size dimensions are clamped at 5080 mm, and are rescaled if coordinate ranges exceed 5080 mm. Disabled by default..
Throws
| PDFNetException |
|---|
public boolean getZoomToExtents ()
Gets the value ZoomToExtents from the options object If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default.
Returns
- a boolean, If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default..
Throws
| PDFNetException |
|---|
public CADConvertOptions setAllowThinLines (boolean value)
Sets the value for AllowThinLines in the options object Sets drawing line weights to zero
Parameters
| value | a boolean -- Sets drawing line weights to zero |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setAutoRotate (boolean value)
Sets the value for AutoRotate in the options object Maps the orientation to the sheet dimensions
Parameters
| value | a boolean -- Maps the orientation to the sheet dimensions |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setBackgroundColor (ColorPt value)
Sets the value for BackgroundColor in the options object Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color)
Parameters
| value | a ColorPt -- Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color) |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setColorMode (String value)
Sets the value for ColorMode in the options object Sets the color palette used by the drawing export. Possible values are Mono (i.e., monochrome) and Gray (i.e., grayscale), otherwise drawing's original palette is used
Parameters
| value | a String -- Sets the color palette used by the drawing export. Possible values are Mono (i.e., monochrome) and Gray (i.e., grayscale), otherwise drawing's original palette is used |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setIncludeModel (boolean value)
Sets the value for IncludeModel in the options object Instructs the conversion process to include the model layout (default: true). Note that if the model layout is empty, it will never be included in the output
Parameters
| value | a boolean -- Instructs the conversion process to include the model layout (default: true). Note that if the model layout is empty, it will never be included in the output |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setLayoutSortOrder (CADConvertOptions.LayoutSortOrder value)
Sets the value for LayoutSortOrder in the options object Specifies how the layout is sorted during cad to pdf conversion. This affects how each layout is inserted into the output pdf (each layout becomes a pdf page).
Parameters
| value | a LayoutSortOrder -- Specifies how the layout is sorted during cad to pdf conversion. This affects how each layout is inserted into the output pdf (each layout becomes a pdf page). |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setMaxXrefDepth (int value)
Sets the value for MaxXrefDepth in the options object Maximum resolution depth for nested xrefs. Root drawing starts at level 0, subsequent nested levels increment by 1. Nested xrefs at levels greater than specified will not be loaded.
Parameters
| value | a int -- Maximum resolution depth for nested xrefs. Root drawing starts at level 0, subsequent nested levels increment by 1. Nested xrefs at levels greater than specified will not be loaded. |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setPageHeight (double value)
Sets the value for PageHeight in the options object The height of the output pdf, in millimeters
Parameters
| value | a double -- The height of the output pdf, in millimeters |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setPageWidth (double value)
Sets the value for PageWidth in the options object The width of the output pdf, in millimeters
Parameters
| value | a double -- The width of the output pdf, in millimeters |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setRasterDPI (double value)
Sets the value for RasterDPI in the options object Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions
Parameters
| value | a double -- Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setUnderlineTextDataFields (boolean value)
Sets the value for UnderlineTextDataFields in the options object If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default.
Parameters
| value | a boolean -- If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default. |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setUseScaleFromDocument (boolean value)
Sets the value for UseScaleFromDocument in the options object If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm. Paper size dimensions are clamped at 5080 mm, and are rescaled if coordinate ranges exceed 5080 mm. Disabled by default.
Parameters
| value | a boolean -- If enabled, sets export paper size equal to layout geometry's coordinate range in mm when ranges are less than 5080 mm. Paper size dimensions are clamped at 5080 mm, and are rescaled if coordinate ranges exceed 5080 mm. Disabled by default. |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public CADConvertOptions setZoomToExtents (boolean value)
Sets the value for ZoomToExtents in the options object If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default.
Parameters
| value | a boolean -- If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default. |
|---|
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|