Public Member Functions
	constructor ()
	Constructor, with parameters.

Public Attributes
	background_color_index
	Background color index in the CAD color palette (range: [0-255]). More...

	color_image_output_dpi
	Color image output DPI setting. More...

	color_policy
	The color policy used for the converted PDF document. More...

	drawing_size_block_reference_name
	The Name of the block reference used to compute drawing scale. More...

	enable_diagnostic_log_output
	Whether to output DWG2PDF diagnostic logs. More...

	export_flags
	The export flags used for the converted PDF document. Please refer to values starting from FSDK.DWG2PDFSettingData.e_FlagEmbededTTF and this can be one or a combination of these values It could also be 0, which means all bits in the flag are 0.

	export_hatches_type
	The type of solid hatches export. More...

	frame_block_configuration_path
	Frame block configuration XML path for frame-block export mode. More...

	geometry_output_dpi
	Geometry output DPI setting. More...

	gradient_export_hatches_type
	The type of gradient hatches export. More...

	is_active_layout
	true means to export the active layout only, while false means not. Default value: false. More...

	is_output_progress
	A boolean value which indicates whether to output progress logs. true means to output progress logs, and false means not. Default value is true.

	layout_index
	Layout index used when FSDK.DWG2PDFSettingData.layout_scope is FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeLayoutByIndex. More...

	layout_scope
	Layout export scope. More...

	lineweight_scale_factor
	Lineweight scale factor. More...

	lineweight_style_mode
	Plot lineweight style mode. More...

	maximum_drawing_area
	Maximum allowed drawing frame area (unit is millimeters). More...

	minimum_export_rect_side_length
	Minimum drawing frame side length used by auto-rectangle export (unit is millimeters). More...

	monochrome_image_output_dpi
	Monochrome image output DPI setting. More...

	other_export_hatches_type
	The type of other (non-solid) hatches export. More...

	output_author
	The author for the output PDF document, an empty string will be used as default.

	output_creator
	The creator for the output PDF document, an empty string will be used as default.

	output_keywords
	The keywords for the output PDF document, an empty string will be used as default.

	output_producer
	The producer for the output PDF document, an empty string will be used as default.

	output_subject
	The subject for the output PDF document, an empty string will be used as default.

	output_title
	The title for the output PDF document, an empty string will be used as default.

	page_margin
	Page margin (unit is millimeters). More...

	paper_height
	The paper height used for the converted PDF document. More...

	paper_width
	The paper width used for the converted PDF document. More...

	plot_scale_factor
	Plot scale factor. More...

	progress_callback
	A pointer to a FSDK.DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF. This parameter can be NULL.

	searchable_text_type
	The type of search text type. More...

	treat_inches_as_millimeters
	Whether to treat inch-based dimensions as millimeters. More...

Static Public Attributes
static	e_DWG2PDFColorPolicyGrayscale
	Color policy: Drawing is exported to a grayscale PDF file. Native colors are converted into grayscale.

static	e_DWG2PDFColorPolicyIndexToBlack
	Color policy: Index colors are converted to black, while all other colors keep their object colors.

static	e_DWG2PDFColorPolicyMono
	Color policy: Drawing is exported to a monochrome PDF file.

static	e_DWG2PDFColorPolicyNoPolicy
	Enumeration for color policy used for converting DWG to PDF. More...

static	e_DWG2PDFExportHatchesTypeDrawing
	Hatches export type: Exports hatch as a set of triangles (vectorizer).

static	e_DWG2PDFExportHatchesTypePdfPaths
	Hatches export type: Exports hatch as a PDF path (solid hatches only).

static	e_DWG2PDFExportHatchesTypePolygons
	Hatches export type: Exports hatch as a polygon (solid hatches only).

static	e_DWG2PDFLayoutScopeAllLayouts
	Export all layouts.

static	e_DWG2PDFLayoutScopeAutoByLayoutOverflow
	Auto-select layouts or model space based on viewport overflow check.

static	e_DWG2PDFLayoutScopeAutoRects
	Auto-detect and export multiple rectangles in model space.

static	e_DWG2PDFLayoutScopeAutoRectsAndAllLayouts
	Merge results of FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects and FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAllLayouts into one PDF.

static	e_DWG2PDFLayoutScopeCurrentLayout
	Export current layout.

static	e_DWG2PDFLayoutScopeDrawingLimits
	Export drawing limits.

static	e_DWG2PDFLayoutScopeFrameBlocks
	Export configured frame blocks in model space as multiple PDF pages. More...

static	e_DWG2PDFLayoutScopeLayoutByIndex
	Export a specific layout by index, specified by FSDK.DWG2PDFSettingData.layout_index.

static	e_DWG2PDFLayoutScopeModelSpaceAndLayouts
	Export model space and all valid layouts.

static	e_DWG2PDFLayoutScopeModelSpaceOnly
	Enumeration for layout scope used for converting DWG to PDF. More...

static	e_DWG2PDFLineweightStyleModeNoStyleNoLineweight
	Enumeration for lineweight/style mode used for converting DWG to PDF. More...

static	e_DWG2PDFLineweightStyleModeStyleAndLineweight
	Enable plot style and lineweight.

static	e_DWG2PDFLineweightStyleModeStyleNoLineweight
	Enable plot style and ignore lineweight.

static	e_DWG2PDFSearchableTextTypeNoSearch
	Enumeration for searchable text type used for converting DWG to PDF. More...

static	e_DWG2PDFSearchableTextTypeSHX
	Searchable text type: Only text displayed with SHX font is searchable.

static	e_DWG2PDFSearchableTextTypeTTF
	Searchable text type: Only text displayed with TTF font is searchable.

static	e_FlagASCIIHexEncoding
	Bit 10. Enable ASCIIHex encoding of internal PDF streams.

static	e_FlagEmbededOptimizedTTF
	Bit 7. Enable embedding of TTF font program to PDF file. The TTF font will be reduced by removing unused parts (smaller PDF file size; but limited editing).

static	e_FlagEmbededTTF
	Enumeration for flags of DWG to PDF export. More...

static	e_FlagEnableLayers
	Bit 5. If enabled; layer support will be added to PDF file (1.5 version required).

static	e_FlagExportHyperlinks
	Bit 11. Enable hyperlinks export.

static	e_FlagFlateCompression
	Bit 9. Enable compression of internal PDF streams.

static	e_FlagIncludeOffLayers
	Bit 6. If enabled; invisible layers will be added to PDF file (1.5 version required).

static	e_FlagLinearized
	Bit 13. Create linearized PDF file.

static	e_FlagMeasuring: number static e_DWG2PDFExportHatchesTypeBitmap
	Bit 15. Enable measuring scale in pdf.

static	e_FlagSHXTextAsGeometry
	Bit 3. Enable SHX font text to geometry conversion.

static	e_FlagSimpleGeomOptimization
	Bit 4. Enable simple geometry optimization (separated segments to one polyline; Bezier curve control points).

static	e_FlagTTFTextAsGeometry
	Bit 2. Enable TTF font text to geometry conversion.

static	e_FlagUseHLR
	Bit 8. Determines whether software uses vector hidden-line removal for corresponding viewports.

static	e_FlagZoomToExtentsMode
	Bit 12. If enabled; layout geometry will be zoomed to paper size; else layout settings will be applied. More...

Detailed Description

This class represents settings used for converting DWG to PDF. This would be used in class FSDK.Convert.

See also: FSDK.Convert

Member Data Documentation

◆ background_color_index

FSDK.DWG2PDFSettingData.background_color_index

Background color index in the CAD color palette (range: [0-255]).

Default value: 7. Common indices: 0-black, 1-red, 2-yellow, 3-green, 4-aqua, 5-blue, 6-magenta, 7-white, 8-dark gray. Other values follow the standard CAD color palette definitions. Values outside the range [0-255] are normalized to 7.

◆ color_image_output_dpi

FSDK.DWG2PDFSettingData.color_image_output_dpi

Color image output DPI setting.

Default value: 400. Valid values are 72, 150, 200, 300, 400, 600 and 1200. Values outside this set are normalized to 400.

◆ color_policy

FSDK.DWG2PDFSettingData.color_policy

The color policy used for the converted PDF document.

It use FSDK.DWG2PDFSettingData.e_DWG2PDFColorPolicyNoPolicy as the default value of this option. Please refer to values starting from FSDK.DWG2PDFSettingData.e_DWG2PDFColorPolicyNoPolicy and this should be one of these values.

◆ drawing_size_block_reference_name

FSDK.DWG2PDFSettingData.drawing_size_block_reference_name

The Name of the block reference used to compute drawing scale.

This option is effective only when FSDK.DWG2PDFSettingData.layout_scope is FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects. The block is treated as the drawing frame, and its original size is used to determine a scale factor applied during PDF export. If the specified block does not exist, this option will not take effect.

◆ e_DWG2PDFColorPolicyNoPolicy

FSDK.DWG2PDFSettingData.e_DWG2PDFColorPolicyNoPolicy

static

Enumeration for color policy used for converting DWG to PDF.

Values of this enumeration should be used alone.

Color policy: No color policy. A drawing is exported with its native color palette (as is)

◆ e_DWG2PDFLayoutScopeFrameBlocks

FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeFrameBlocks

static

Export configured frame blocks in model space as multiple PDF pages.

Note: Set FSDK.DWG2PDFSettingData.frame_block_configuration_path to an XML configuration file path. Each frame block is exported to one PDF page, in order from top-left to bottom-right. If frame blocks are exploded or no block names are configured, the whole model space is exported.

◆ e_DWG2PDFLayoutScopeModelSpaceOnly

FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeModelSpaceOnly

static

Enumeration for layout scope used for converting DWG to PDF.

Values of this enumeration should be used alone.

Export model space only.

◆ e_DWG2PDFLineweightStyleModeNoStyleNoLineweight

FSDK.DWG2PDFSettingData.e_DWG2PDFLineweightStyleModeNoStyleNoLineweight

static

Enumeration for lineweight/style mode used for converting DWG to PDF.

Values of this enumeration should be used alone.

Ignore plot style and lineweight.

◆ e_DWG2PDFSearchableTextTypeNoSearch

FSDK.DWG2PDFSettingData.e_DWG2PDFSearchableTextTypeNoSearch

static

Enumeration for searchable text type used for converting DWG to PDF.

Values of this enumeration should be used alone.

Searchable text type: No searchable text.

◆ e_FlagEmbededTTF

FSDK.DWG2PDFSettingData.e_FlagEmbededTTF

static

Enumeration for flags of DWG to PDF export.

Values of this enumeration could be used alone or in a combination.

Bit 1. Enable embedding of TTF(True Type Font) program to PDF file. The whole TTF font file will be embedded (huge PDF size).

◆ e_FlagZoomToExtentsMode

FSDK.DWG2PDFSettingData.e_FlagZoomToExtentsMode

static

Bit 12. If enabled; layout geometry will be zoomed to paper size; else layout settings will be applied.

Note: This mode works like some Layout settings: "Plot Area" - "Extents"; "Fit to Paper"; "Center the plot"; these settings applied to specified paper size and orientation; but some settings like "Plot lineweight"; "Plot style" are still applying from Layout settings.

◆ enable_diagnostic_log_output

FSDK.DWG2PDFSettingData.enable_diagnostic_log_output

Whether to output DWG2PDF diagnostic logs.

Default value is false. false means disabled, and true means enabled.

◆ export_hatches_type

FSDK.DWG2PDFSettingData.export_hatches_type

The type of solid hatches export.

It use FSDK.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from FSDK.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values.

◆ frame_block_configuration_path

FSDK.DWG2PDFSettingData.frame_block_configuration_path

Frame block configuration XML path for frame-block export mode.

This XML file is used to configure frame block names to export, for example:

         <?xml version="1.0" encoding="utf-8" ?>
         <root>
         <!-- Configure Dwg title block names in Acme mode; configure frame block names in ODA mode. -->
         <TitleBlock Name="Frame1"/>
         <TitleBlock Name="Frame2"/>
         </root>

This option is mainly used when FSDK.DWG2PDFSettingData.layout_scope is FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeFrameBlocks. The XML file name is not restricted. Empty string means no external frame-block configuration file is used.

◆ geometry_output_dpi

FSDK.DWG2PDFSettingData.geometry_output_dpi

Geometry output DPI setting.

Default value: 400. Valid values are 72, 150, 200, 300, 400, 600 and 1200. Values outside this set are normalized to 400.

◆ gradient_export_hatches_type

FSDK.DWG2PDFSettingData.gradient_export_hatches_type

The type of gradient hatches export.

It use FSDK.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from FSDK.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values

◆ is_active_layout

FSDK.DWG2PDFSettingData.is_active_layout

true means to export the active layout only, while false means not. Default value: false.

Deprecated:: This property has been deprecated. Please use FSDK.DWG2PDFSettingData.layout_scope instead. Setting FSDK.DWG2PDFSettingData.layout_scope to FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeCurrentLayout provides the same behavior as setting current property to true.

◆ layout_index

FSDK.DWG2PDFSettingData.layout_index

Layout index used when FSDK.DWG2PDFSettingData.layout_scope is FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeLayoutByIndex.

The Default value is 1 (the first layout). Values less than 1 are normalized to 1 when using layout by index mode. This option is ignored for other layout scope modes.

◆ layout_scope

FSDK.DWG2PDFSettingData.layout_scope

Layout export scope.

Default value: FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeCurrentLayout. Please refer to values starting from FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeModelSpaceOnly. When set to FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeLayoutByIndex, use FSDK.DWG2PDFSettingData.layout_index to specify the target layout index. If an unsupported value is provided, it is normalized to FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeCurrentLayout mode.

◆ lineweight_scale_factor

FSDK.DWG2PDFSettingData.lineweight_scale_factor

Lineweight scale factor.

Default value: 1.0. This option is effective only when FSDK.DWG2PDFSettingData.lineweight_style_mode is FSDK.DWG2PDFSettingData.e_DWG2PDFLineweightStyleModeStyleAndLineweight. Values less than or equal to 0 are treated as 1.0.

◆ lineweight_style_mode

FSDK.DWG2PDFSettingData.lineweight_style_mode

Plot lineweight style mode.

Default value: FSDK.DWG2PDFSettingData.e_DWG2PDFLineweightStyleModeNoStyleNoLineweight. Please refer to values starting from FSDK.DWG2PDFSettingData.e_DWG2PDFLineweightStyleModeNoStyleNoLineweight. If an unsupported value is provided, an error will be thrown.

◆ maximum_drawing_area

FSDK.DWG2PDFSettingData.maximum_drawing_area

Maximum allowed drawing frame area (unit is millimeters).

Default value is 0. This option is effective only when FSDK.DWG2PDFSettingData.layout_scope is FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects or FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRectsAndAllLayouts. If a drawing frame's area exceeds this value, it will be scaled down to fit within the limit. A value of 0 means no limit. Negative values will be treated as 0.

◆ minimum_export_rect_side_length

FSDK.DWG2PDFSettingData.minimum_export_rect_side_length

Minimum drawing frame side length used by auto-rectangle export (unit is millimeters).

Default value is 0. This option is effective only when FSDK.DWG2PDFSettingData.layout_scope is FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects. In this mode, any drawing frame whose width or height is smaller than this value will be skipped. If this value exceeds the maximum side length of all detected drawing frames, all frames will be skipped and the conversion function will throw exception FSDK.e_ErrParam. A value of 0 means no limit. Negative values will be treated as 0.

◆ monochrome_image_output_dpi

FSDK.DWG2PDFSettingData.monochrome_image_output_dpi

Monochrome image output DPI setting.

Default value: 400. Valid values are 72, 150, 200, 300, 400, 600 and 1200. Values outside this set are normalized to 400.

◆ other_export_hatches_type

FSDK.DWG2PDFSettingData.other_export_hatches_type

The type of other (non-solid) hatches export.

It use FSDK.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from FSDK.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values

◆ page_margin

FSDK.DWG2PDFSettingData.page_margin

Page margin (unit is millimeters).

Default value: 0. Negative values are treated as 0. Values exceeding half of the page size will be set to less than half of the page size.

◆ paper_height

FSDK.DWG2PDFSettingData.paper_height

The paper height used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(FSDK.DWG2PDFSettingData.e_FlagZoomToExtentsMode are enabled by export_flags). Effective default value is 297.0f. Unit: millimeters. If this value is less than or equal to 0, it is normalized to 297.0f.

◆ paper_width

FSDK.DWG2PDFSettingData.paper_width

The paper width used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(FSDK.DWG2PDFSettingData.e_FlagZoomToExtentsMode are enabled by export_flags). Effective default value is 420.0f. Unit: millimeters. If this value is less than or equal to 0, it is normalized to 420.0f.

◆ plot_scale_factor

FSDK.DWG2PDFSettingData.plot_scale_factor

Plot scale factor.

Default value is 0.99. No strict upper bound is enforced for this value. However, invalid inputs are normalized to maintain stable output. Values less than 0 are normalized to 0.1, and 0 is normalized to 0.99.

◆ searchable_text_type

FSDK.DWG2PDFSettingData.searchable_text_type

The type of search text type.

This option can be used if SHX or TTF text exported as geometry(FSDK.DWG2PDFSettingData.e_FlagTTFTextAsGeometry and FSDK.DWG2PDFSettingData.e_FlagSHXTextAsGeometry are enabled by export_flags). It use FSDK.DWG2PDFSettingData.e_DWG2PDFSearchableTextTypeNoSearch as the default value of this option. Please refer to values starting from FSDK.DWG2PDFSettingData.e_DWG2PDFSearchableTextTypeNoSearch and this should be one of these values.

◆ treat_inches_as_millimeters

FSDK.DWG2PDFSettingData.treat_inches_as_millimeters

Whether to treat inch-based dimensions as millimeters.

Default value is false. This option is effective only when the drawing uses inches as its unit and FSDK.DWG2PDFSettingData.layout_scope is FSDK.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects. false means disabled, and true means enabled.

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Data Documentation

◆ background_color_index

◆ color_image_output_dpi

◆ color_policy

◆ drawing_size_block_reference_name

◆ e_DWG2PDFColorPolicyNoPolicy

◆ e_DWG2PDFLayoutScopeFrameBlocks

◆ e_DWG2PDFLayoutScopeModelSpaceOnly

◆ e_DWG2PDFLineweightStyleModeNoStyleNoLineweight

◆ e_DWG2PDFSearchableTextTypeNoSearch

◆ e_FlagEmbededTTF

◆ e_FlagZoomToExtentsMode

◆ enable_diagnostic_log_output

◆ export_hatches_type

◆ frame_block_configuration_path

◆ geometry_output_dpi

◆ gradient_export_hatches_type

◆ is_active_layout

◆ layout_index

◆ layout_scope

◆ lineweight_scale_factor

◆ lineweight_style_mode

◆ maximum_drawing_area

◆ minimum_export_rect_side_length

◆ monochrome_image_output_dpi

◆ other_export_hatches_type

◆ page_margin

◆ paper_height

◆ paper_width

◆ plot_scale_factor

◆ searchable_text_type

◆ treat_inches_as_millimeters