public class

CADConvertOptions

extends OptionsBase
java.lang.Object
   ↳ com.pdftron.pdf.OptionsBase
     ↳ com.pdftron.pdf.CADConvertOptions

Summary

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).
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 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 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 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 CADConvertOptions ()

Constructor.

public CADConvertOptions (String json_string)

Constructor.

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

Returns
  • this object, for call chaining

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.

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.

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

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.

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.

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

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.

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.

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.

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

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

public CADConvertOptions setAllowThinLines (boolean value)

Sets the value for AllowThinLines in the options object Sets drawing line weights to zero

Returns
  • this object, for call chaining

public CADConvertOptions setAutoRotate (boolean value)

Sets the value for AutoRotate in the options object Maps the orientation to the sheet dimensions

Returns
  • this object, for call chaining

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)

Returns
  • this object, for call chaining

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

Returns
  • this object, for call chaining

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

Returns
  • this object, for call chaining

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.

Returns
  • this object, for call chaining

public CADConvertOptions setPageHeight (double value)

Sets the value for PageHeight in the options object The height of the output pdf, in millimeters

Returns
  • this object, for call chaining

public CADConvertOptions setPageWidth (double value)

Sets the value for PageWidth in the options object The width of the output pdf, in millimeters

Returns
  • this object, for call chaining

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

Returns
  • this object, for call chaining

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.

Returns
  • this object, for call chaining

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.

Returns
  • this object, for call chaining