Public Member Functions
def	GetBackground_color_index ()
	Get background color index in the CAD color palette (range: [0-255]). More...

def	GetColor_image_output_dpi ()
	Get color image output DPI setting. More...

def	GetColor_policy ()
	Get the color policy used for the converted PDF document. More...

def	GetDrawing_size_block_reference_name ()
	Get the Name of the block reference used to compute drawing scale. More...

def	GetEnable_diagnostic_log_output ()
	Get whether to output DWG2PDF diagnostic logs. More...

def	GetExport_flags ()
	Get the export flags used for the converted PDF document. More...

def	GetExport_hatches_type ()
	Get the type of solid hatches export. More...

def	GetFrame_block_configuration_path ()
	Get frame block configuration XML path for frame-block export mode. More...

def	GetGeometry_output_dpi ()
	Get geometry output DPI setting. More...

def	GetGradient_export_hatches_type ()
	Get the type of gradient hatches export. More...

def	GetIs_active_layout ()
	Get true means to export the active layout only, while false means not. More...

def	GetIs_output_progress ()
	Get a boolean value which indicates whether to output progress logs. More...

def	GetLayout_index ()
	Get layout index used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeLayoutByIndex . More...

def	GetLayout_scope ()
	Get layout export scope. More...

def	GetLineweight_scale_factor ()
	Get lineweight scale factor. More...

def	GetLineweight_style_mode ()
	Get plot lineweight style mode. More...

def	GetMaximum_drawing_area ()
	Get maximum allowed drawing frame area (unit is millimeters). More...

def	GetMinimum_export_rect_side_length ()
	Get minimum drawing frame side length used by auto-rectangle export (unit is millimeters). More...

def	GetMonochrome_image_output_dpi ()
	Get monochrome image output DPI setting. More...

def	GetOther_export_hatches_type ()
	Get the type of other (non-solid) hatches export. More...

def	GetOutput_author ()
	Get the author for the output PDF document, an empty string will be used as default. More...

def	GetOutput_creator ()
	Get the creator for the output PDF document, an empty string will be used as default. More...

def	GetOutput_keywords ()
	Get the keywords for the output PDF document, an empty string will be used as default. More...

def	GetOutput_producer ()
	Get the producer for the output PDF document, an empty string will be used as default. More...

def	GetOutput_subject ()
	Get the subject for the output PDF document, an empty string will be used as default. More...

def	GetOutput_title ()
	Get the title for the output PDF document, an empty string will be used as default. More...

def	GetPage_margin ()
	Get page margin (unit is millimeters). More...

def	GetPaper_height ()
	Get the paper height used for the converted PDF document. More...

def	GetPaper_width ()
	Get the paper width used for the converted PDF document. More...

def	GetPlot_scale_factor ()
	Get plot scale factor. More...

def	GetProgress_callback ()
	Get a pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF. More...

def	GetSearchable_text_type ()
	Get the type of search text type. More...

def	GetTreat_inches_as_millimeters ()
	Get whether to treat inch-based dimensions as millimeters. More...

def	SetBackground_color_index (value)
	Set background color index in the CAD color palette (range: [0-255]). More...

def	SetColor_image_output_dpi (value)
	Set color image output DPI setting. More...

def	SetColor_policy (value)
	Set the color policy used for the converted PDF document. More...

def	SetDrawing_size_block_reference_name (value)
	Set the Name of the block reference used to compute drawing scale. More...

def	SetEnable_diagnostic_log_output (value)
	Set whether to output DWG2PDF diagnostic logs. More...

def	SetExport_flags (value)
	Set the export flags used for the converted PDF document. More...

def	SetExport_hatches_type (value)
	Set the type of solid hatches export. More...

def	SetFrame_block_configuration_path (value)
	Set frame block configuration XML path for frame-block export mode. More...

def	SetGeometry_output_dpi (value)
	Set geometry output DPI setting. More...

def	SetGradient_export_hatches_type (value)
	Set the type of gradient hatches export. More...

def	SetIs_active_layout (value)
	Set true means to export the active layout only, while false means not. More...

def	SetIs_output_progress (value)
	Set a boolean value which indicates whether to output progress logs. More...

def	SetLayout_index (value)
	Set layout index used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeLayoutByIndex . More...

def	SetLayout_scope (value)
	Set layout export scope. More...

def	SetLineweight_scale_factor (value)
	Set lineweight scale factor. More...

def	SetLineweight_style_mode (value)
	Set plot lineweight style mode. More...

def	SetMaximum_drawing_area (value)
	Set maximum allowed drawing frame area (unit is millimeters). More...

def	SetMinimum_export_rect_side_length (value)
	Set minimum drawing frame side length used by auto-rectangle export (unit is millimeters). More...

def	SetMonochrome_image_output_dpi (value)
	Set monochrome image output DPI setting. More...

def	SetOther_export_hatches_type (value)
	Set the type of other (non-solid) hatches export. More...

def	SetOutput_author (value)
	Set the author for the output PDF document, an empty string will be used as default. More...

def	SetOutput_creator (value)
	Set the creator for the output PDF document, an empty string will be used as default. More...

def	SetOutput_keywords (value)
	Set the keywords for the output PDF document, an empty string will be used as default. More...

def	SetOutput_producer (value)
	Set the producer for the output PDF document, an empty string will be used as default. More...

def	SetOutput_subject (value)
	Set the subject for the output PDF document, an empty string will be used as default. More...

def	SetOutput_title (value)
	Set the title for the output PDF document, an empty string will be used as default. More...

def	SetPage_margin (value)
	Set page margin (unit is millimeters). More...

def	SetPaper_height (value)
	Set the paper height used for the converted PDF document. More...

def	SetPaper_width (value)
	Set the paper width used for the converted PDF document. More...

def	SetPlot_scale_factor (value)
	Set plot scale factor. More...

def	SetProgress_callback (value)
	Set a pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF. More...

def	SetSearchable_text_type (value)
	Set the type of search text type. More...

def	SetTreat_inches_as_millimeters (value)
	Set whether to treat inch-based dimensions as millimeters. More...

Detailed Description

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

See also: Convert

Member Function Documentation

◆ GetBackground_color_index()

fsdk.DWG2PDFSettingData.GetBackground_color_index ( )

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

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

◆ GetColor_image_output_dpi()

fsdk.DWG2PDFSettingData.GetColor_image_output_dpi ( )

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

Returns: Color image output DPI setting.

◆ GetColor_policy()

fsdk.DWG2PDFSettingData.GetColor_policy ( )

Get the color policy used for the converted PDF document.

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

Returns: The color policy used for the converted PDF document.

◆ GetDrawing_size_block_reference_name()

fsdk.DWG2PDFSettingData.GetDrawing_size_block_reference_name ( )

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

This option is effective only when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_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.

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

◆ GetEnable_diagnostic_log_output()

fsdk.DWG2PDFSettingData.GetEnable_diagnostic_log_output ( )

Get whether to output DWG2PDF diagnostic logs.

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

Returns: Whether to output DWG2PDF diagnostic logs.

◆ GetExport_flags()

fsdk.DWG2PDFSettingData.GetExport_flags ( )

Get the export flags used for the converted PDF document.

It use fsdk.DWG2PDFSettingDataE_FlagEmbededTTF as the default value of this option.

Returns: The export flags used for the converted PDF document. Please refer to values starting from fsdk.DWG2PDFSettingDataE_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.

◆ GetExport_hatches_type()

fsdk.DWG2PDFSettingData.GetExport_hatches_type ( )

Get the type of solid hatches export.

It use fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypePolygons as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and this should be one of these values.

Returns: The type of solid hatches export.

◆ GetFrame_block_configuration_path()

fsdk.DWG2PDFSettingData.GetFrame_block_configuration_path ( )

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

This file should contain configured title block names in format:

         <?xml version="1.0" encoding="utf-8" ?>
         <root>

         <TitleBlock name="Frame1">
         <TitleBlock name="Frame2">
         </root>

This option is mainly used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeFrameBlocks . The XML file name is not restricted. Empty string means no external frame-block configuration file is used.

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

◆ GetGeometry_output_dpi()

fsdk.DWG2PDFSettingData.GetGeometry_output_dpi ( )

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

Returns: Geometry output DPI setting.

◆ GetGradient_export_hatches_type()

fsdk.DWG2PDFSettingData.GetGradient_export_hatches_type ( )

Get the type of gradient hatches export.

For this option, only fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeDrawing are supported. It use fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and this should be one of these values

Returns: The type of gradient hatches export.

◆ GetIs_active_layout()

fsdk.DWG2PDFSettingData.GetIs_active_layout ( )

Get true means to export the active layout only, while false means not.

Deprecated:: This property has been deprecated. Please use fsdk.DWG2PDFSettingData.GetLayout_scope instead. Setting fsdk.DWG2PDFSettingData.GetLayout_scope to fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeCurrentLayout provides the same behavior as setting current property to true.

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

◆ GetIs_output_progress()

fsdk.DWG2PDFSettingData.GetIs_output_progress ( )

Get a boolean value which indicates whether to output progress logs.

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

◆ GetLayout_index()

fsdk.DWG2PDFSettingData.GetLayout_index ( )

Get layout index used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_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.

Returns: Layout index used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeLayoutByIndex .

◆ GetLayout_scope()

fsdk.DWG2PDFSettingData.GetLayout_scope ( )

Get layout export scope.

It use fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeCurrentLayout as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeModelSpaceOnly . When set to fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeLayoutByIndex , use fsdk.DWG2PDFSettingData.GetLayout_index to specify the target layout index. If an unsupported value is provided, it is normalized to fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeCurrentLayout mode.

Returns: Layout export scope.

◆ GetLineweight_scale_factor()

fsdk.DWG2PDFSettingData.GetLineweight_scale_factor ( )

Get lineweight scale factor.

Default value: 1.0. This option is effective only when fsdk.DWG2PDFSettingData.GetLineweight_style_mode is fsdk.DWG2PDFSettingDataE_DWG2PDFLineweightStyleModeStyleAndLineweight . Values less than or equal to 0 are treated as 1.0.

Returns: Lineweight scale factor.

◆ GetLineweight_style_mode()

fsdk.DWG2PDFSettingData.GetLineweight_style_mode ( )

Get plot lineweight style mode.

It use fsdk.DWG2PDFSettingDataE_DWG2PDFLineweightStyleModeNoStyleNoLineweight as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFLineweightStyleModeNoStyleNoLineweight . If an unsupported value is provided, an fsdk.E_ErrParam error will be thrown.

Returns: Plot lineweight style mode.

◆ GetMaximum_drawing_area()

fsdk.DWG2PDFSettingData.GetMaximum_drawing_area ( )

Get maximum allowed drawing frame area (unit is millimeters).

Default value is 0. This option is effective only when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeAutoRects or fsdk.DWG2PDFSettingDataE_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.

Returns: Maximum allowed drawing frame area (unit is millimeters).

◆ GetMinimum_export_rect_side_length()

fsdk.DWG2PDFSettingData.GetMinimum_export_rect_side_length ( )

Get 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.GetLayout_scope is fsdk.DWG2PDFSettingDataE_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. A value of 0 means no limit. Negative values will be treated as 0.

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

◆ GetMonochrome_image_output_dpi()

fsdk.DWG2PDFSettingData.GetMonochrome_image_output_dpi ( )

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

Returns: Monochrome image output DPI setting.

◆ GetOther_export_hatches_type()

fsdk.DWG2PDFSettingData.GetOther_export_hatches_type ( )

Get the type of other (non-solid) hatches export.

For this option, only fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeDrawing are supported. It use fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and this should be one of these values

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

◆ GetOutput_author()

fsdk.DWG2PDFSettingData.GetOutput_author ( )

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

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

◆ GetOutput_creator()

fsdk.DWG2PDFSettingData.GetOutput_creator ( )

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

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

◆ GetOutput_keywords()

fsdk.DWG2PDFSettingData.GetOutput_keywords ( )

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

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

◆ GetOutput_producer()

fsdk.DWG2PDFSettingData.GetOutput_producer ( )

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

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

◆ GetOutput_subject()

fsdk.DWG2PDFSettingData.GetOutput_subject ( )

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

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

◆ GetOutput_title()

fsdk.DWG2PDFSettingData.GetOutput_title ( )

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

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

◆ GetPage_margin()

fsdk.DWG2PDFSettingData.GetPage_margin ( )

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

Returns: Page margin (unit is millimeters).

◆ GetPaper_height()

fsdk.DWG2PDFSettingData.GetPaper_height ( )

Get the paper height used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(fsdk.DWG2PDFSettingDataE_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.

Returns: The paper height used for the converted PDF document.

◆ GetPaper_width()

fsdk.DWG2PDFSettingData.GetPaper_width ( )

Get the paper width used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(fsdk.DWG2PDFSettingDataE_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.

Returns: The paper width used for the converted PDF document.

◆ GetPlot_scale_factor()

fsdk.DWG2PDFSettingData.GetPlot_scale_factor ( )

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

Returns: Plot scale factor.

◆ GetProgress_callback()

fsdk.DWG2PDFSettingData.GetProgress_callback ( )

Get a pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF.

Returns: A pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF. This parameter can be null.

◆ GetSearchable_text_type()

fsdk.DWG2PDFSettingData.GetSearchable_text_type ( )

Get the type of search text type.

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

Returns: The type of search text type.

◆ GetTreat_inches_as_millimeters()

fsdk.DWG2PDFSettingData.GetTreat_inches_as_millimeters ( )

Get 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.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeAutoRects . false means disabled, and true means enabled.

Returns: Whether to treat inch-based dimensions as millimeters.

◆ SetBackground_color_index()

fsdk.DWG2PDFSettingData.SetBackground_color_index ( value )

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

Parameters

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

Returns: None.

◆ SetColor_image_output_dpi()

fsdk.DWG2PDFSettingData.SetColor_image_output_dpi ( value )

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

Parameters

[in] value Color image output DPI setting.

Returns: None.

◆ SetColor_policy()

fsdk.DWG2PDFSettingData.SetColor_policy ( value )

Set the color policy used for the converted PDF document.

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

Parameters

[in] value The color policy used for the converted PDF document.

Returns: None.

◆ SetDrawing_size_block_reference_name()

fsdk.DWG2PDFSettingData.SetDrawing_size_block_reference_name ( value )

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

This option is effective only when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_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.

Parameters

[in] value The Name of the block reference used to compute drawing scale.

Returns: None.

◆ SetEnable_diagnostic_log_output()

fsdk.DWG2PDFSettingData.SetEnable_diagnostic_log_output ( value )

Set whether to output DWG2PDF diagnostic logs.

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

Parameters

[in] value Whether to output DWG2PDF diagnostic logs.

Returns: None.

◆ SetExport_flags()

fsdk.DWG2PDFSettingData.SetExport_flags ( value )

Set the export flags used for the converted PDF document.

It use fsdk.DWG2PDFSettingDataE_FlagEmbededTTF as the default value of this option.

Parameters

[in] value The export flags used for the converted PDF document. Please refer to values starting from fsdk.DWG2PDFSettingDataE_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.

Returns: None.

◆ SetExport_hatches_type()

fsdk.DWG2PDFSettingData.SetExport_hatches_type ( value )

Set the type of solid hatches export.

It use fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypePolygons as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and this should be one of these values.

Parameters

[in] value The type of solid hatches export.

Returns: None.

◆ SetFrame_block_configuration_path()

fsdk.DWG2PDFSettingData.SetFrame_block_configuration_path ( value )

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

This file should contain configured title block names in format:

         <?xml version="1.0" encoding="utf-8" ?>
         <root>

         <TitleBlock name="Frame1">
         <TitleBlock name="Frame2">
         </root>

This option is mainly used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeFrameBlocks . The XML file name is not restricted. Empty string means no external frame-block configuration file is used.

Parameters

[in] value Frame block configuration XML path for frame-block export mode.

Returns: None.

◆ SetGeometry_output_dpi()

fsdk.DWG2PDFSettingData.SetGeometry_output_dpi ( value )

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

Parameters

[in] value Geometry output DPI setting.

Returns: None.

◆ SetGradient_export_hatches_type()

fsdk.DWG2PDFSettingData.SetGradient_export_hatches_type ( value )

Set the type of gradient hatches export.

For this option, only fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeDrawing are supported. It use fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and this should be one of these values

Parameters

[in] value The type of gradient hatches export.

Returns: None.

◆ SetIs_active_layout()

fsdk.DWG2PDFSettingData.SetIs_active_layout ( value )

Set true means to export the active layout only, while false means not.

Deprecated:: This property has been deprecated. Please use fsdk.DWG2PDFSettingData.GetLayout_scope instead. Setting fsdk.DWG2PDFSettingData.GetLayout_scope to fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeCurrentLayout provides the same behavior as setting current property to true.

Parameters

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

Returns: None.

◆ SetIs_output_progress()

fsdk.DWG2PDFSettingData.SetIs_output_progress ( value )

Set a boolean value which indicates whether to output progress logs.

Parameters

[in] value A boolean value which indicates whether to output progress logs. true means to output progress logs, and false means not. Default value: true.

Returns: None.

◆ SetLayout_index()

fsdk.DWG2PDFSettingData.SetLayout_index ( value )

Set layout index used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_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.

Parameters

[in] value Layout index used when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeLayoutByIndex .

Returns: None.

◆ SetLayout_scope()

fsdk.DWG2PDFSettingData.SetLayout_scope ( value )

Set layout export scope.

It use fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeCurrentLayout as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeModelSpaceOnly . When set to fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeLayoutByIndex , use fsdk.DWG2PDFSettingData.GetLayout_index to specify the target layout index. If an unsupported value is provided, it is normalized to fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeCurrentLayout mode.

Parameters

[in] value Layout export scope.

Returns: None.

◆ SetLineweight_scale_factor()

fsdk.DWG2PDFSettingData.SetLineweight_scale_factor ( value )

Set lineweight scale factor.

Default value: 1.0. This option is effective only when fsdk.DWG2PDFSettingData.GetLineweight_style_mode is fsdk.DWG2PDFSettingDataE_DWG2PDFLineweightStyleModeStyleAndLineweight . Values less than or equal to 0 are treated as 1.0.

Parameters

[in] value Lineweight scale factor.

Returns: None.

◆ SetLineweight_style_mode()

fsdk.DWG2PDFSettingData.SetLineweight_style_mode ( value )

Set plot lineweight style mode.

It use fsdk.DWG2PDFSettingDataE_DWG2PDFLineweightStyleModeNoStyleNoLineweight as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFLineweightStyleModeNoStyleNoLineweight . If an unsupported value is provided, an fsdk.E_ErrParam error will be thrown.

Parameters

[in] value Plot lineweight style mode.

Returns: None.

◆ SetMaximum_drawing_area()

fsdk.DWG2PDFSettingData.SetMaximum_drawing_area ( value )

Set maximum allowed drawing frame area (unit is millimeters).

Default value is 0. This option is effective only when fsdk.DWG2PDFSettingData.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeAutoRects or fsdk.DWG2PDFSettingDataE_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.

Parameters

[in] value Maximum allowed drawing frame area (unit is millimeters).

Returns: None.

◆ SetMinimum_export_rect_side_length()

fsdk.DWG2PDFSettingData.SetMinimum_export_rect_side_length ( value )

Set 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.GetLayout_scope is fsdk.DWG2PDFSettingDataE_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. A value of 0 means no limit. Negative values will be treated as 0.

Parameters

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

Returns: None.

◆ SetMonochrome_image_output_dpi()

fsdk.DWG2PDFSettingData.SetMonochrome_image_output_dpi ( value )

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

Parameters

[in] value Monochrome image output DPI setting.

Returns: None.

◆ SetOther_export_hatches_type()

fsdk.DWG2PDFSettingData.SetOther_export_hatches_type ( value )

Set the type of other (non-solid) hatches export.

For this option, only fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeDrawing are supported. It use fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from fsdk.DWG2PDFSettingDataE_DWG2PDFExportHatchesTypeBitmap and this should be one of these values

Parameters

[in] value The type of other (non-solid) hatches export.

Returns: None.

◆ SetOutput_author()

fsdk.DWG2PDFSettingData.SetOutput_author ( value )

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

Parameters

[in] value The author for the output PDF document, an empty string will be used as default.

Returns: None.

◆ SetOutput_creator()

fsdk.DWG2PDFSettingData.SetOutput_creator ( value )

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

Parameters

[in] value The creator for the output PDF document, an empty string will be used as default.

Returns: None.

◆ SetOutput_keywords()

fsdk.DWG2PDFSettingData.SetOutput_keywords ( value )

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

Parameters

[in] value The keywords for the output PDF document, an empty string will be used as default.

Returns: None.

◆ SetOutput_producer()

fsdk.DWG2PDFSettingData.SetOutput_producer ( value )

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

Parameters

[in] value The producer for the output PDF document, an empty string will be used as default.

Returns: None.

◆ SetOutput_subject()

fsdk.DWG2PDFSettingData.SetOutput_subject ( value )

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

Parameters

[in] value The subject for the output PDF document, an empty string will be used as default.

Returns: None.

◆ SetOutput_title()

fsdk.DWG2PDFSettingData.SetOutput_title ( value )

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

Parameters

[in] value The title for the output PDF document, an empty string will be used as default.

Returns: None.

◆ SetPage_margin()

fsdk.DWG2PDFSettingData.SetPage_margin ( value )

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

Parameters

[in] value Page margin (unit is millimeters).

Returns: None.

◆ SetPaper_height()

fsdk.DWG2PDFSettingData.SetPaper_height ( value )

Set the paper height used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(fsdk.DWG2PDFSettingDataE_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.

Parameters

[in] value The paper height used for the converted PDF document.

Returns: None.

◆ SetPaper_width()

fsdk.DWG2PDFSettingData.SetPaper_width ( value )

Set the paper width used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(fsdk.DWG2PDFSettingDataE_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.

Parameters

[in] value The paper width used for the converted PDF document.

Returns: None.

◆ SetPlot_scale_factor()

fsdk.DWG2PDFSettingData.SetPlot_scale_factor ( value )

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

Parameters

[in] value Plot scale factor.

Returns: None.

◆ SetProgress_callback()

fsdk.DWG2PDFSettingData.SetProgress_callback ( value )

Set a pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF.

Parameters

[in] value A pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF. This parameter can be null.

Returns: None.

◆ SetSearchable_text_type()

fsdk.DWG2PDFSettingData.SetSearchable_text_type ( value )

Set the type of search text type.

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

Parameters

[in] value The type of search text type.

Returns: None.

◆ SetTreat_inches_as_millimeters()

fsdk.DWG2PDFSettingData.SetTreat_inches_as_millimeters ( value )

Set 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.GetLayout_scope is fsdk.DWG2PDFSettingDataE_DWG2PDFLayoutScopeAutoRects . false means disabled, and true means enabled.

Parameters

[in] value Whether to treat inch-based dimensions as millimeters.

Returns: None.

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBackground_color_index()

◆ GetColor_image_output_dpi()

◆ GetColor_policy()

◆ GetDrawing_size_block_reference_name()

◆ GetEnable_diagnostic_log_output()

◆ GetExport_flags()

◆ GetExport_hatches_type()

◆ GetFrame_block_configuration_path()

◆ GetGeometry_output_dpi()

◆ GetGradient_export_hatches_type()

◆ GetIs_active_layout()

◆ GetIs_output_progress()

◆ GetLayout_index()

◆ GetLayout_scope()

◆ GetLineweight_scale_factor()

◆ GetLineweight_style_mode()

◆ GetMaximum_drawing_area()

◆ GetMinimum_export_rect_side_length()

◆ GetMonochrome_image_output_dpi()

◆ GetOther_export_hatches_type()

◆ GetOutput_author()

◆ GetOutput_creator()

◆ GetOutput_keywords()

◆ GetOutput_producer()

◆ GetOutput_subject()

◆ GetOutput_title()

◆ GetPage_margin()

◆ GetPaper_height()

◆ GetPaper_width()

◆ GetPlot_scale_factor()

◆ GetProgress_callback()

◆ GetSearchable_text_type()

◆ GetTreat_inches_as_millimeters()

◆ SetBackground_color_index()

◆ SetColor_image_output_dpi()

◆ SetColor_policy()

◆ SetDrawing_size_block_reference_name()

◆ SetEnable_diagnostic_log_output()

◆ SetExport_flags()

◆ SetExport_hatches_type()

◆ SetFrame_block_configuration_path()

◆ SetGeometry_output_dpi()

◆ SetGradient_export_hatches_type()

◆ SetIs_active_layout()

◆ SetIs_output_progress()

◆ SetLayout_index()

◆ SetLayout_scope()

◆ SetLineweight_scale_factor()

◆ SetLineweight_style_mode()

◆ SetMaximum_drawing_area()

◆ SetMinimum_export_rect_side_length()

◆ SetMonochrome_image_output_dpi()

◆ SetOther_export_hatches_type()

◆ SetOutput_author()

◆ SetOutput_creator()

◆ SetOutput_keywords()

◆ SetOutput_producer()

◆ SetOutput_subject()

◆ SetOutput_title()

◆ SetPage_margin()

◆ SetPaper_height()

◆ SetPaper_width()

◆ SetPlot_scale_factor()

◆ SetProgress_callback()

◆ SetSearchable_text_type()

◆ SetTreat_inches_as_millimeters()