Show / Hide Table of Contents

# Class CADConvertOptions

##### Inheritance

object
OptionsBase
CADConvertOptions

##### Implements

IDisposable

##### Inherited Members

OptionsBase.mObjSet
OptionsBase.mDict
OptionsBase.ColorPtToNumber(ColorPt)
OptionsBase.ColorPtFromNumber(double)
OptionsBase.GetArray(string)
OptionsBase.PutNumber(string, double)
OptionsBase.PutBool(string, bool)
OptionsBase.PutText(string, string)
OptionsBase.PutRect(string, Rect)
OptionsBase.PushBackNumber(string, double)
OptionsBase.PushBackBool(string, bool)
OptionsBase.PushBackText(string, string)
OptionsBase.PushBackRect(string, Rect)
OptionsBase.RectFromArray(Obj)
OptionsBase.insertRectCollection(string, RectCollection, int)
OptionsBase.GetInternalObj()
OptionsBase.Dispose()
OptionsBase.Dispose(bool)
OptionsBase.Destroy()
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.PDF

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class CADConvertOptions : OptionsBase, IDisposable

### Constructors

#### CADConvertOptions()

Constructor.

##### Declaration

    public CADConvertOptions()

### Methods

#### AddSheets(string)

Adds a to the Sheets array The list of sheets to be converted -- only applies to .rvt conversions

##### Declaration

    public CADConvertOptions AddSheets(string value)

##### Parameters

Type | Name | Description
--- | --- | ---
string | value | The list of sheets to be converted -- only applies to .rvt conversions

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### GetAllowThinLines()

Gets the value AllowThinLines from the options object Sets drawing line weights to zero

##### Declaration

    public bool GetAllowThinLines()

##### Returns

Type | Description
--- | ---
bool | a bool, Sets drawing line weights to zero.

#### GetAutoRotate()

Gets the value AutoRotate from the options object Maps the orientation to the sheet dimensions

##### Declaration

    public bool GetAutoRotate()

##### Returns

Type | Description
--- | ---
bool | a bool, Maps the orientation to the sheet dimensions.

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

##### Declaration

    public ColorPt GetBackgroundColor()

##### Returns

Type | Description
--- | ---
ColorPt | a ColorPt, Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color).

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

##### Declaration

    public string GetColorMode()

##### Returns

Type | Description
--- | ---
string | 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.

#### GetIncludeInvisibleLayers()

Gets the value IncludeInvisibleLayers from the options object. If enabled, invisible layers will be exported to PDF. Enabled by default.

##### Declaration

    public bool GetIncludeInvisibleLayers()

##### Returns

Type | Description
--- | ---
bool | The current value for IncludeInvisibleLayers.

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

##### Declaration

    public bool GetIncludeModel()

##### Returns

Type | Description
--- | ---
bool | a bool, 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.

#### GetIncludeNonPlottableLayers()

Gets the value IncludeNonPlottableLayers from the options object. If enabled, layers with the Plotttable (printable) property set to false will be exported to PDF. Disabled by default.

##### Declaration

    public bool GetIncludeNonPlottableLayers()

##### Returns

Type | Description
--- | ---
bool | The current value for IncludeNonPlottableLayers.

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

##### Declaration

    public CADConvertOptions.LayoutSortOrder GetLayoutSortOrder()

##### Returns

Type | Description
--- | ---
CADConvertOptions.LayoutSortOrder | 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)..

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

##### Declaration

    public int GetMaxXrefDepth()

##### Returns

Type | Description
--- | ---
int | 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..

#### GetPageHeight()

Gets the value PageHeight from the options object The height of the output pdf, in millimeters

##### Declaration

    public double GetPageHeight()

##### Returns

Type | Description
--- | ---
double | a double, The height of the output pdf, in millimeters.

#### GetPageWidth()

Gets the value PageWidth from the options object The width of the output pdf, in millimeters

##### Declaration

    public double GetPageWidth()

##### Returns

Type | Description
--- | ---
double | a double, The width of the output pdf, in millimeters.

#### GetRasterDPI()

Gets the value RasterDPI from the options object Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions

##### Declaration

    public double GetRasterDPI()

##### Returns

Type | Description
--- | ---
double | a double, Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions.

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

##### Declaration

    public bool GetUnderlineTextDataFields()

##### Returns

Type | Description
--- | ---
bool | a bool, If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default.

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

##### Declaration

    public bool GetUseScaleFromDocument()

##### Returns

Type | Description
--- | ---
bool | a bool, 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..

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

##### Declaration

    public bool GetZoomToExtents()

##### Returns

Type | Description
--- | ---
bool | a bool, If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default..

#### SetAllowThinLines(bool)

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

##### Declaration

    public CADConvertOptions SetAllowThinLines(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | Sets drawing line weights to zero

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetAutoRotate(bool)

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

##### Declaration

    public CADConvertOptions SetAutoRotate(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | Maps the orientation to the sheet dimensions

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetBackgroundColor(ColorPt)

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)

##### Declaration

    public CADConvertOptions SetBackgroundColor(ColorPt value)

##### Parameters

Type | Name | Description
--- | --- | ---
ColorPt | value | Sets background color for cad conversion (display palette may be adjusted to contrast the chosen background color)

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetColorMode(string)

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

##### Declaration

    public CADConvertOptions SetColorMode(string value)

##### Parameters

Type | Name | Description
--- | --- | ---
string | value | 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

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetIncludeInvisibleLayers(bool)

Sets the value for IncludeInvisibleLayers in the options object. If enabled, invisible layers will be exported to PDF. Enabled by default.

##### Declaration

    public CADConvertOptions SetIncludeInvisibleLayers(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | The new value for IncludeInvisibleLayers.

##### Returns

Type | Description
--- | ---
CADConvertOptions | This object, for call chaining.

#### SetIncludeModel(bool)

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

##### Declaration

    public CADConvertOptions SetIncludeModel(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | 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

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetIncludeNonPlottableLayers(bool)

Sets the value for IncludeNonPlottableLayers in the options object. If enabled, layers with the Plotttable (printable) property set to false will be exported to PDF. Disabled by default.

##### Declaration

    public CADConvertOptions SetIncludeNonPlottableLayers(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | The new value for IncludeNonPlottableLayers.

##### Returns

Type | Description
--- | ---
CADConvertOptions | This object, for call chaining.

#### SetLayoutSortOrder(LayoutSortOrder)

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

##### Declaration

    public CADConvertOptions SetLayoutSortOrder(CADConvertOptions.LayoutSortOrder value)

##### Parameters

Type | Name | Description
--- | --- | ---
CADConvertOptions.LayoutSortOrder | value | 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

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetMaxXrefDepth(int)

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.

##### Declaration

    public CADConvertOptions SetMaxXrefDepth(int value)

##### Parameters

Type | Name | Description
--- | --- | ---
int | value | 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

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetPageHeight(double)

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

##### Declaration

    public CADConvertOptions SetPageHeight(double value)

##### Parameters

Type | Name | Description
--- | --- | ---
double | value | The height of the output pdf, in millimeters

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetPageWidth(double)

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

##### Declaration

    public CADConvertOptions SetPageWidth(double value)

##### Parameters

Type | Name | Description
--- | --- | ---
double | value | The width of the output pdf, in millimeters

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetRasterDPI(double)

Sets the value for RasterDPI in the options object Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions

##### Declaration

    public CADConvertOptions SetRasterDPI(double value)

##### Parameters

Type | Name | Description
--- | --- | ---
double | value | Rasterization dpi used when rendering 3D content. Currently only applies to .rvt conversions

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetUnderlineTextDataFields(bool)

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.

##### Declaration

    public CADConvertOptions SetUnderlineTextDataFields(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | If enabled, text data fields in the DGN CAD drawing are exported to PDF with an underline. Disabled by default.

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetUseScaleFromDocument(bool)

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.

##### Declaration

    public CADConvertOptions SetUseScaleFromDocument(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | 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

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

#### SetZoomToExtents(bool)

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.

##### Declaration

    public CADConvertOptions SetZoomToExtents(bool value)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | value | If enabled, the layout geometry is zoomed to the paper size, otherwise layout settings are applied. Enabled by default.

##### Returns

Type | Description
--- | ---
CADConvertOptions | this object, for call chaining

### Implements

IDisposable