Foxit PDF SDK
fsdk.DWG2PDFSettingData Class Reference

Public Member Functions

def GetColor_policy ()
 Get the color policy used for the converted PDF document. 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 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 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 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 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 SetColor_policy (value)
 Set the color policy used for the converted PDF document. 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 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 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 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 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...
 

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

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

◆ GetExport_flags()

fsdk.DWG2PDFSettingData.GetExport_flags ( )

Get the export flags used for the converted PDF document.

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_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 solid hatches export.

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

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.

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

◆ 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). It use the default value 297.0f. this values are in millimeters.

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). It use the default value 210.0f. this values are in millimeters.

Returns
The paper width used for the converted PDF document.

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

◆ 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]valueThe color policy used for the converted PDF document.
Returns
None.

◆ SetExport_flags()

fsdk.DWG2PDFSettingData.SetExport_flags (   value)

Set the export flags used for the converted PDF document.

Parameters
[in]valueThe 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_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]valueThe type of solid hatches export.
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]valueThe 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.

Parameters
[in]valuetrue 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]valueA boolean value which indicates whether to output progress logs. true means to output progress logs, and false means not. Default value: true.
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]valueThe 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]valueThe 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]valueThe 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]valueThe 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]valueThe 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]valueThe 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]valueThe title for the output PDF document, an empty string will be used as default.
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). It use the default value 297.0f. this values are in millimeters.

Parameters
[in]valueThe 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). It use the default value 210.0f. this values are in millimeters.

Parameters
[in]valueThe paper width used for the converted PDF document.
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]valueA 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]valueThe type of search text type.
Returns
None.