Inherits NSObject.

Instance Methods
(id)	- init
	Constructor, with parameters.

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

int	color_image_output_dpi
	Color image output DPI setting. More...

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

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

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

unsigned int	export_flags
	The export flags used for the converted PDF document. Please refer to values starting from FSDWG2PDFSettingDataFlagEmbededTTF 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. More...

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

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

int	geometry_output_dpi
	Geometry output DPI setting. More...

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

BOOL	is_active_layout
	YES means to export the active layout only, while NO means not. Default value: NO. More...

BOOL	is_output_progress
	A boolean value which indicates whether to output progress logs. YES means to output progress logs, and NO means not. Default value: YES.

int	layout_index
	Layout index used when FSDWG2PDFSettingData::layout_scope is FSDWG2PDFSettingDataDWG2PDFLayoutScopeLayoutByIndex. More...

FSDWG2PDFSettingDataDWG2PDFLayoutScope	layout_scope
	Layout export scope. More...

double	lineweight_scale_factor
	Lineweight scale factor. More...

FSDWG2PDFSettingDataDWG2PDFLineweightStyleMode	lineweight_style_mode
	Plot lineweight style mode. More...

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

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

int	monochrome_image_output_dpi
	Monochrome image output DPI setting. More...

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

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

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

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

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

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

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

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

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

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

double	plot_scale_factor
	Plot scale factor. More...

SWIGTYPE_p_void *	progress_callback
	A pointer to a object which is used to receive the progress of converting DWG to PDF. This parameter can be nil.

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

BOOL	treat_inches_as_millimeters
	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 FSConvert .

See also: FSConvert

Property Documentation

◆ background_color_index

- (int) background_color_index

readwritenonatomicassign

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

- (int) color_image_output_dpi

readwritenonatomicassign

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

- (FSDWG2PDFSettingDataDWG2PDFColorPolicy) color_policy

readwritenonatomicassign

The color policy used for the converted PDF document.

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

◆ drawing_size_block_reference_name

- (NSString *) drawing_size_block_reference_name

readwritenonatomicweak

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

This option is effective only when FSDWG2PDFSettingData::layout_scope is FSDWG2PDFSettingDataDWG2PDFLayoutScopeAutoRects. 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.

◆ enable_diagnostic_log_output

- (BOOL) enable_diagnostic_log_output

readwritenonatomicassign

Whether to output DWG2PDF diagnostic logs.

Default value is NO. NO means disabled, and YES means enabled.

◆ export_flags

- (unsigned int) export_flags

readwritenonatomicassign

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

It use FSDWG2PDFSettingDataFlagEmbededTTF as the default value of this option.

◆ export_hatches_type

- (FSDWG2PDFSettingDataDWG2PDFExportHatchesType) export_hatches_type

readwritenonatomicassign

The type of solid hatches export.

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

◆ frame_block_configuration_path

- (NSString *) frame_block_configuration_path

readwritenonatomicweak

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 FSDWG2PDFSettingData::layout_scope is FSDWG2PDFSettingDataDWG2PDFLayoutScopeFrameBlocks. The XML file name is not restricted. Empty string means no external frame-block configuration file is used.

◆ geometry_output_dpi

- (int) geometry_output_dpi

readwritenonatomicassign

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

- (FSDWG2PDFSettingDataDWG2PDFExportHatchesType) gradient_export_hatches_type

readwritenonatomicassign

The type of gradient hatches export.

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

◆ is_active_layout

- (BOOL) is_active_layout

readwritenonatomicassign

YES means to export the active layout only, while NO means not. Default value: NO.

Deprecated:: This property has been deprecated. Please use FSDWG2PDFSettingData::layout_scope instead. Setting FSDWG2PDFSettingData::layout_scope to FSDWG2PDFSettingDataDWG2PDFLayoutScopeCurrentLayout provides the same behavior as setting current property to YES.

◆ layout_index

- (int) layout_index

readwritenonatomicassign

Layout index used when FSDWG2PDFSettingData::layout_scope is FSDWG2PDFSettingDataDWG2PDFLayoutScopeLayoutByIndex.

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

- (FSDWG2PDFSettingDataDWG2PDFLayoutScope) layout_scope

readwritenonatomicassign

Layout export scope.

It use FSDWG2PDFSettingDataDWG2PDFLayoutScopeCurrentLayout as the default value of this option. Please refer to values starting from FSDWG2PDFSettingDataDWG2PDFLayoutScopeModelSpaceOnly. When set to FSDWG2PDFSettingDataDWG2PDFLayoutScopeLayoutByIndex, use FSDWG2PDFSettingData::layout_index to specify the target layout index. If an unsupported value is provided, it is normalized to FSDWG2PDFSettingDataDWG2PDFLayoutScopeCurrentLayout mode.

◆ lineweight_scale_factor

- (double) lineweight_scale_factor

readwritenonatomicassign

Lineweight scale factor.

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

◆ lineweight_style_mode

- (FSDWG2PDFSettingDataDWG2PDFLineweightStyleMode) lineweight_style_mode

readwritenonatomicassign

Plot lineweight style mode.

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

◆ maximum_drawing_area

- (double) maximum_drawing_area

readwritenonatomicassign

Maximum allowed drawing frame area (unit is millimeters).

Default value is 0. This option is effective only when FSDWG2PDFSettingData::layout_scope is FSDWG2PDFSettingDataDWG2PDFLayoutScopeAutoRects or FSDWG2PDFSettingDataDWG2PDFLayoutScopeAutoRectsAndAllLayouts. 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

- (double) minimum_export_rect_side_length

readwritenonatomicassign

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

Default value is 0. This option is effective only when FSDWG2PDFSettingData::layout_scope is FSDWG2PDFSettingDataDWG2PDFLayoutScopeAutoRects. 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.

◆ monochrome_image_output_dpi

- (int) monochrome_image_output_dpi

readwritenonatomicassign

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

- (FSDWG2PDFSettingDataDWG2PDFExportHatchesType) other_export_hatches_type

readwritenonatomicassign

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

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

◆ page_margin

- (int) page_margin

readwritenonatomicassign

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

- (float) paper_height

readwritenonatomicassign

The paper height used for the converted PDF document.

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

- (float) paper_width

readwritenonatomicassign

The paper width used for the converted PDF document.

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

- (double) plot_scale_factor

readwritenonatomicassign

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

- (FSDWG2PDFSettingDataDWG2PDFSearchableTextType) searchable_text_type

readwritenonatomicassign

The type of search text type.

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

◆ treat_inches_as_millimeters

- (BOOL) treat_inches_as_millimeters

readwritenonatomicassign

Whether to treat inch-based dimensions as millimeters.

Default value is NO. This option is effective only when the drawing uses inches as its unit and FSDWG2PDFSettingData::layout_scope is FSDWG2PDFSettingDataDWG2PDFLayoutScopeAutoRects. NO means disabled, and YES means enabled.

Instance Methods

Properties

Detailed Description

Property Documentation

◆ background_color_index

◆ color_image_output_dpi

◆ color_policy

◆ drawing_size_block_reference_name

◆ enable_diagnostic_log_output

◆ export_flags

◆ 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