Foxit PDF SDK
foxit.addon.conversion.DWG2PDFSettingData Class Reference

Inherits SystemIDisposable.

Public Types

enum  DWG2PDFExportFlags {
  DWG2PDFExportFlags.e_FlagEmbededTTF = 0x0001, DWG2PDFExportFlags.e_FlagTTFTextAsGeometry = 0x0002, DWG2PDFExportFlags.e_FlagSHXTextAsGeometry = 0x0004, DWG2PDFExportFlags.e_FlagSimpleGeomOptimization = 0x0008,
  DWG2PDFExportFlags.e_FlagEnableLayers = 0x0010, DWG2PDFExportFlags.e_FlagIncludeOffLayers = 0x0020, DWG2PDFExportFlags.e_FlagEmbededOptimizedTTF = 0x0040, DWG2PDFExportFlags.e_FlagUseHLR = 0x0080,
  DWG2PDFExportFlags.e_FlagFlateCompression = 0x0100, DWG2PDFExportFlags.e_FlagASCIIHexEncoding = 0x0200, DWG2PDFExportFlags.e_FlagExportHyperlinks = 0x0400, DWG2PDFExportFlags.e_FlagZoomToExtentsMode = 0x0800,
  DWG2PDFExportFlags.e_FlagLinearized = 0x1000, DWG2PDFExportFlags.e_FlagMeasuring = 0x4000
}
 Enumeration for flags of DWG to PDF export. More...
 
enum  DWG2PDFExportHatchesType { DWG2PDFExportHatchesType.e_DWG2PDFExportHatchesTypeBitmap = 0, DWG2PDFExportHatchesType.e_DWG2PDFExportHatchesTypeDrawing = 1, DWG2PDFExportHatchesType.e_DWG2PDFExportHatchesTypePdfPaths = 2, DWG2PDFExportHatchesType.e_DWG2PDFExportHatchesTypePolygons = 3 }
 Enumeration for hatches export type used for converting DWG to PDF. More...
 
enum  DWG2PDFSearchableTextType { DWG2PDFSearchableTextType.e_DWG2PDFSearchableTextTypeNoSearch = 0, DWG2PDFSearchableTextType.e_DWG2PDFSearchableTextTypeSHX = 1, DWG2PDFSearchableTextType.e_DWG2PDFSearchableTextTypeTTF = 2 }
 Enumeration for searchable text type used for converting DWG to PDF. More...
 

Public Member Functions

 DWG2PDFSettingData ()
 Constructor, with parameters.
 

Properties

int export_flags [get, set]
 The export flags used for the converted PDF document. Please refer to values starting from foxit.addon.conversion.DWG2PDFSettingData.DWG2PDFExportFlags.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.
 
DWG2PDFSettingData.DWG2PDFExportHatchesType export_hatches_type [get, set]
 The type of solid hatches export. More...
 
DWG2PDFSettingData.DWG2PDFExportHatchesType gradient_export_hatches_type [get, set]
 The type of gradient hatches export. More...
 
bool is_active_layout [get, set]
 true means to export the active layout only, while false means not.
 
DWG2PDFSettingData.DWG2PDFExportHatchesType other_export_hatches_type [get, set]
 The type of other (non-solid) hatches export. More...
 
string output_author [get, set]
 The author for the output PDF document, an empty string will be used as default.
 
string output_creator [get, set]
 The creator for the output PDF document, an empty string will be used as default.
 
string output_keywords [get, set]
 The keywords for the output PDF document, an empty string will be used as default.
 
string output_producer [get, set]
 The producer for the output PDF document, an empty string will be used as default.
 
string output_subject [get, set]
 The subject for the output PDF document, an empty string will be used as default.
 
string output_title [get, set]
 The title for the output PDF document, an empty string will be used as default.
 
float paper_height [get, set]
 The paper height used for the converted PDF document. More...
 
float paper_width [get, set]
 The paper width used for the converted PDF document. More...
 
DWG2PDFSettingData.DWG2PDFSearchableTextType searchable_text_type [get, set]
 The type of search text type. More...
 

Detailed Description

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

See also
Convert

Member Enumeration Documentation

◆ DWG2PDFExportFlags

Enumeration for flags of DWG to PDF export.

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

Enumerator
e_FlagEmbededTTF 

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_FlagTTFTextAsGeometry 

Bit 2. Enable TTF font text to geometry conversion.

e_FlagSHXTextAsGeometry 

Bit 3. Enable SHX font text to geometry conversion.

e_FlagSimpleGeomOptimization 

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

e_FlagEnableLayers 

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

e_FlagIncludeOffLayers 

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

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

e_FlagUseHLR 

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

e_FlagFlateCompression 

Bit 9. Enable compression of internal PDF streams.

e_FlagASCIIHexEncoding 

Bit 10. Enable ASCIIHex encoding of internal PDF streams.

e_FlagExportHyperlinks 

Bit 11. Enable hyperlinks export.

e_FlagZoomToExtentsMode 

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

Bit 13. Create linearized PDF file.

e_FlagMeasuring 

Bit 15. Enable measuring scale in pdf.

◆ DWG2PDFExportHatchesType

Enumeration for hatches export type used for converting DWG to PDF.

Values of this enumeration should be used alone.

Enumerator
e_DWG2PDFExportHatchesTypeBitmap 

Hatches export type: Exports hatch as a bitmap.

e_DWG2PDFExportHatchesTypeDrawing 

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

e_DWG2PDFExportHatchesTypePdfPaths 

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

e_DWG2PDFExportHatchesTypePolygons 

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

◆ DWG2PDFSearchableTextType

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

Values of this enumeration should be used alone.

Enumerator
e_DWG2PDFSearchableTextTypeNoSearch 

Searchable text type: No searchable text.

e_DWG2PDFSearchableTextTypeSHX 

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

e_DWG2PDFSearchableTextTypeTTF 

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

Property Documentation

◆ export_hatches_type

DWG2PDFSettingData.DWG2PDFExportHatchesType foxit.addon.conversion.DWG2PDFSettingData.export_hatches_type
getset

The type of solid hatches export.

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

◆ gradient_export_hatches_type

◆ other_export_hatches_type

◆ paper_height

float foxit.addon.conversion.DWG2PDFSettingData.paper_height
getset

The paper height used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(foxit.addon.conversion.DWG2PDFSettingData.DWG2PDFExportFlags.e_FlagZoomToExtentsMode are enabled by export_flags). It use the default value 297.0f. this values are in millimeters.

◆ paper_width

float foxit.addon.conversion.DWG2PDFSettingData.paper_width
getset

The paper width used for the converted PDF document.

This option can be used if layout geometry will be zoomed to paper size(foxit.addon.conversion.DWG2PDFSettingData.DWG2PDFExportFlags.e_FlagZoomToExtentsMode are enabled by export_flags). It use the default value 210.0f. this values are in millimeters.

◆ searchable_text_type

DWG2PDFSettingData.DWG2PDFSearchableTextType foxit.addon.conversion.DWG2PDFSettingData.searchable_text_type
getset