|
Foxit PDF SDK
|
Inherits Object.
Public Member Functions | |
| DWG2PDFSettingData () | |
| Constructor, with parameters. | |
| DWG2PDFSettingData & | operator= (const DWG2PDFSettingData &data) |
| Assign operator. More... | |
Public Attributes | |
| int32 | background_color_index |
| Background color index in the CAD color palette (range: [0-255]). More... | |
| int32 | color_image_output_dpi |
| Color image output DPI setting. More... | |
| DWG2PDFColorPolicy | color_policy |
| The color policy used for the converted PDF document. More... | |
| foxit::WString | 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... | |
| uint32 | export_flags |
| The export flags used for the converted PDF document. Please refer to values starting from 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. More... | |
| DWG2PDFExportHatchesType | export_hatches_type |
| The type of solid hatches export. More... | |
| foxit::WString | frame_block_configuration_path |
| Frame block configuration XML path for frame-block export mode. More... | |
| int32 | geometry_output_dpi |
| Geometry output DPI setting. More... | |
| DWG2PDFExportHatchesType | gradient_export_hatches_type |
| The type of gradient hatches export. More... | |
| bool | is_active_layout |
| true means to export the active layout only, while false means not. Default value: false. More... | |
| bool | 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: true. | |
| int32 | layout_index |
| Layout index used when DWG2PDFSettingData::layout_scope is DWG2PDFSettingData::e_DWG2PDFLayoutScopeLayoutByIndex. More... | |
| DWG2PDFLayoutScope | layout_scope |
| Layout export scope. More... | |
| double | lineweight_scale_factor |
| Lineweight scale factor. More... | |
| DWG2PDFLineweightStyleMode | 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... | |
| int32 | monochrome_image_output_dpi |
| Monochrome image output DPI setting. More... | |
| DWG2PDFExportHatchesType | other_export_hatches_type |
| The type of other (non-solid) hatches export. More... | |
| foxit::WString | output_author |
| The author for the output PDF document, an empty string will be used as default. | |
| foxit::WString | output_creator |
| The creator for the output PDF document, an empty string will be used as default. | |
| foxit::WString | output_keywords |
| The keywords for the output PDF document, an empty string will be used as default. | |
| foxit::WString | output_producer |
| The producer for the output PDF document, an empty string will be used as default. | |
| foxit::WString | output_subject |
| The subject for the output PDF document, an empty string will be used as default. | |
| foxit::WString | output_title |
| The title for the output PDF document, an empty string will be used as default. | |
| int32 | 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... | |
| void * | progress_callback |
| A pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF. This parameter can be NULL. | |
| DWG2PDFSearchableTextType | searchable_text_type |
| The type of search text type. More... | |
| bool | treat_inches_as_millimeters |
| Whether to treat inch-based dimensions as millimeters. More... | |
This class represents settings used for converting DWG to PDF. This would be used in class Convert.
Enumeration for color policy used for converting DWG to PDF.
Values of this enumeration should be used alone.
Enumeration for flags of DWG to PDF export.
Values of this enumeration could be used alone or in a combination.
Enumeration for hatches export type used for converting DWG to PDF.
Values of this enumeration should be used alone.
Enumeration for layout scope used for converting DWG to PDF.
Values of this enumeration should be used alone.
| Enumerator | |
|---|---|
| e_DWG2PDFLayoutScopeModelSpaceOnly | Export model space only. |
| e_DWG2PDFLayoutScopeCurrentLayout | Export current layout. |
| e_DWG2PDFLayoutScopeAllLayouts | Export all layouts. |
| e_DWG2PDFLayoutScopeModelSpaceAndLayouts | Export model space and all valid layouts. |
| e_DWG2PDFLayoutScopeFrameBlocks | Export configured frame blocks in model space as multiple PDF pages.
|
| e_DWG2PDFLayoutScopeDrawingLimits | Export drawing limits. |
| e_DWG2PDFLayoutScopeAutoByLayoutOverflow | Auto-select layouts or model space based on viewport overflow check. |
| e_DWG2PDFLayoutScopeAutoRects | Auto-detect and export multiple rectangles in model space. |
| e_DWG2PDFLayoutScopeLayoutByIndex | Export a specific layout by index, specified by DWG2PDFSettingData::layout_index. |
| e_DWG2PDFLayoutScopeAutoRectsAndAllLayouts | Merge results of DWG2PDFSettingData::e_DWG2PDFLayoutScopeAutoRects and DWG2PDFSettingData::e_DWG2PDFLayoutScopeAllLayouts into one PDF. |
Enumeration for lineweight/style mode used for converting DWG to PDF.
Values of this enumeration should be used alone.
Enumeration for searchable text type used for converting DWG to PDF.
Values of this enumeration should be used alone.
|
inline |
Assign operator.
| [in] | data | Another DWG-to-PDF setting data object, whose value would be assigned to current object. |
| int32 foxit::addon::conversion::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.
| int32 foxit::addon::conversion::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.
| DWG2PDFColorPolicy foxit::addon::conversion::DWG2PDFSettingData::color_policy |
The color policy used for the converted PDF document.
It use DWG2PDFSettingData::e_DWG2PDFColorPolicyNoPolicy as the default value of this option. Please refer to values starting from DWG2PDFSettingData::e_DWG2PDFColorPolicyNoPolicy and this should be one of these values.
| foxit::WString foxit::addon::conversion::DWG2PDFSettingData::drawing_size_block_reference_name |
The Name of the block reference used to compute drawing scale.
This option is effective only when DWG2PDFSettingData::layout_scope is 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.
| bool foxit::addon::conversion::DWG2PDFSettingData::enable_diagnostic_log_output |
Whether to output DWG2PDF diagnostic logs.
Default value is false. false means disabled, and true means enabled.
| uint32 foxit::addon::conversion::DWG2PDFSettingData::export_flags |
The export flags used for the converted PDF document. Please refer to values starting from 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.
It use DWG2PDFSettingData::e_FlagEmbededTTF as the default value of this option.
| DWG2PDFExportHatchesType foxit::addon::conversion::DWG2PDFSettingData::export_hatches_type |
The type of solid hatches export.
It use DWG2PDFSettingData::e_DWG2PDFExportHatchesTypePolygons as the default value of this option. Please refer to values starting from DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values.
| foxit::WString foxit::addon::conversion::DWG2PDFSettingData::frame_block_configuration_path |
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>
<!-- Configure title block names for Acme mode; configure frame block names for ODA mode. -->
<TitleBlock Name="Frame1"/>
<TitleBlock Name="Frame2"/>
</root>
This option is mainly used when DWG2PDFSettingData::layout_scope is DWG2PDFSettingData::e_DWG2PDFLayoutScopeFrameBlocks. The XML file name is not restricted. Empty string means no external frame-block configuration file is used.
| int32 foxit::addon::conversion::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.
| DWG2PDFExportHatchesType foxit::addon::conversion::DWG2PDFSettingData::gradient_export_hatches_type |
The type of gradient hatches export.
For this option, only DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeBitmap and DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeDrawing are supported. It use DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values
| bool foxit::addon::conversion::DWG2PDFSettingData::is_active_layout |
true means to export the active layout only, while false means not. Default value: false.
| int32 foxit::addon::conversion::DWG2PDFSettingData::layout_index |
Layout index used when DWG2PDFSettingData::layout_scope is 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.
| DWG2PDFLayoutScope foxit::addon::conversion::DWG2PDFSettingData::layout_scope |
Layout export scope.
It use DWG2PDFSettingData::e_DWG2PDFLayoutScopeCurrentLayout as the default value of this option. Please refer to values starting from DWG2PDFSettingData::e_DWG2PDFLayoutScopeModelSpaceOnly. When set to DWG2PDFSettingData::e_DWG2PDFLayoutScopeLayoutByIndex, use DWG2PDFSettingData::layout_index to specify the target layout index. If an unsupported value is provided, it is normalized to DWG2PDFSettingData::e_DWG2PDFLayoutScopeCurrentLayout mode.
| double foxit::addon::conversion::DWG2PDFSettingData::lineweight_scale_factor |
Lineweight scale factor.
Default value: 1.0. This option is effective only when DWG2PDFSettingData::lineweight_style_mode is DWG2PDFSettingData::e_DWG2PDFLineweightStyleModeStyleAndLineweight. Values less than or equal to 0 are treated as 1.0.
| DWG2PDFLineweightStyleMode foxit::addon::conversion::DWG2PDFSettingData::lineweight_style_mode |
Plot lineweight style mode.
It use DWG2PDFSettingData::e_DWG2PDFLineweightStyleModeNoStyleNoLineweight as the default value of this option. Please refer to values starting from DWG2PDFSettingData::e_DWG2PDFLineweightStyleModeNoStyleNoLineweight. If an unsupported value is provided, an foxit::e_ErrParam error will be thrown.
| double foxit::addon::conversion::DWG2PDFSettingData::maximum_drawing_area |
Maximum allowed drawing frame area (unit is millimeters).
Default value is 0. This option is effective only when DWG2PDFSettingData::layout_scope is DWG2PDFSettingData::e_DWG2PDFLayoutScopeAutoRects or 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.
| double foxit::addon::conversion::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 DWG2PDFSettingData::layout_scope is 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. A value of 0 means no limit. Negative values will be treated as 0.
| int32 foxit::addon::conversion::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.
| DWG2PDFExportHatchesType foxit::addon::conversion::DWG2PDFSettingData::other_export_hatches_type |
The type of other (non-solid) hatches export.
For this option, only DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeBitmap and DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeDrawing are supported. It use DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from DWG2PDFSettingData::e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values
| int32 foxit::addon::conversion::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.
| float foxit::addon::conversion::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(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.
| float foxit::addon::conversion::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(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.
| double foxit::addon::conversion::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.
| DWG2PDFSearchableTextType foxit::addon::conversion::DWG2PDFSettingData::searchable_text_type |
The type of search text type.
This option can be used if SHX or TTF text exported as geometry(DWG2PDFSettingData::e_FlagTTFTextAsGeometry and DWG2PDFSettingData::e_FlagSHXTextAsGeometry are enabled by export_flags). It use DWG2PDFSettingData::e_DWG2PDFSearchableTextTypeNoSearch as the default value of this option. Please refer to values starting from DWG2PDFSettingData::e_DWG2PDFSearchableTextTypeNoSearch and this should be one of these values.
| bool foxit::addon::conversion::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 DWG2PDFSettingData::layout_scope is DWG2PDFSettingData::e_DWG2PDFLayoutScopeAutoRects. false means disabled, and true means enabled.