Foxit PDF SDK
FoxitPDFSDKPython3.DialogDescriptionConfig Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def DialogDescriptionConfig ()
 Constructor.

 
def DialogDescriptionConfig (dlg_des_config)
 Constructor, with another dialog description config object.
More...
 
def DialogDescriptionConfig (name, first_tab, width, height, char_width, char_height, align_children, element_array)
 Constructor, with parameters.
More...
 
def Set (name, first_tab, width, height, char_width, char_height, align_children, element_array)
 Set values.
More...
 

Static Public Attributes

 align_children = _swig_property(_fsdk.DialogDescriptionConfig_align_children_get, _fsdk.DialogDescriptionConfig_align_children_set)
 The alignment for all descendants.

 
 char_height = _swig_property(_fsdk.DialogDescriptionConfig_char_height_get, _fsdk.DialogDescriptionConfig_char_height_set)
 The height of the dialog box in characters.
More...
 
 char_width = _swig_property(_fsdk.DialogDescriptionConfig_char_width_get, _fsdk.DialogDescriptionConfig_char_width_set)
 The width of the dialog box in characters.
More...
 
 element_array = _swig_property(_fsdk.DialogDescriptionConfig_element_array_get, _fsdk.DialogDescriptionConfig_element_array_set)
 An array of dialog description element array object.

 
 first_tab = _swig_property(_fsdk.DialogDescriptionConfig_first_tab_get, _fsdk.DialogDescriptionConfig_first_tab_set)
 An ItemID for the dialog box item that should be first in the tab order.
More...
 
 height = _swig_property(_fsdk.DialogDescriptionConfig_height_get, _fsdk.DialogDescriptionConfig_height_set)
 The height of the dialog box in pixels.
More...
 
 name = _swig_property(_fsdk.DialogDescriptionConfig_name_get, _fsdk.DialogDescriptionConfig_name_set)
 The title bar of the dialog box.

 
 width = _swig_property(_fsdk.DialogDescriptionConfig_width_get, _fsdk.DialogDescriptionConfig_width_set)
 The width of the dialog box in pixels.
More...
 

Detailed Description

This class represents dialog config.

Constructor & Destructor Documentation

◆ DialogDescriptionConfig() [1/2]

def FoxitPDFSDKPython3.DialogDescriptionConfig.DialogDescriptionConfig (   name,
  first_tab,
  width,
  height,
  char_width,
  char_height,
  align_children,
  element_array 
)

Constructor, with parameters.

Parameters
[in]nameThe title bar of the dialog box.
[in]first_tabAn ItemID for the dialog box item that should be first in the tab order.
[in]widthThe width of the dialog box in pixels.
[in]heightThe height of the dialog box in pixels.
[in]char_widthThe width of the dialog box in characters.
[in]char_heightThe height of the dialog box in characters.
[in]align_childrenThe alignment for all descendants.
[in]element_arrayAn array of dialog description element array object.

◆ DialogDescriptionConfig() [2/2]

def FoxitPDFSDKPython3.DialogDescriptionConfig.DialogDescriptionConfig (   dlg_des_config)

Constructor, with another dialog description config object.

Parameters
[in]dlg_des_configAnother dialog description config object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.DialogDescriptionConfig.Set (   name,
  first_tab,
  width,
  height,
  char_width,
  char_height,
  align_children,
  element_array 
)

Set values.

Parameters
[in]nameThe title bar of the dialog box.
[in]first_tabAn ItemID for the dialog box item that should be first in the tab order.
[in]widthThe width of the dialog box in pixels.
[in]heightThe height of the dialog box in pixels.
[in]char_widthThe width of the dialog box in characters.
[in]char_heightThe height of the dialog box in characters.
[in]align_childrenThe alignment for all descendants.
[in]element_arrayAn array of dialog description element array object.
Returns
None.

Member Data Documentation

◆ char_height

FoxitPDFSDKPython3.DialogDescriptionConfig.char_height = _swig_property(_fsdk.DialogDescriptionConfig_char_height_get, _fsdk.DialogDescriptionConfig_char_height_set)
static

The height of the dialog box in characters.

If no height is specified, the combined height of the contents is used.

◆ char_width

FoxitPDFSDKPython3.DialogDescriptionConfig.char_width = _swig_property(_fsdk.DialogDescriptionConfig_char_width_get, _fsdk.DialogDescriptionConfig_char_width_set)
static

The width of the dialog box in characters.

If no width is specified, the combined width of the contents is used.

◆ first_tab

FoxitPDFSDKPython3.DialogDescriptionConfig.first_tab = _swig_property(_fsdk.DialogDescriptionConfig_first_tab_get, _fsdk.DialogDescriptionConfig_first_tab_set)
static

An ItemID for the dialog box item that should be first in the tab order.

If no width is specified, the combined width of the contents is used.

◆ height

FoxitPDFSDKPython3.DialogDescriptionConfig.height = _swig_property(_fsdk.DialogDescriptionConfig_height_get, _fsdk.DialogDescriptionConfig_height_set)
static

The height of the dialog box in pixels.

If no height is specified, the combined height of the contents is used.

◆ width

FoxitPDFSDKPython3.DialogDescriptionConfig.width = _swig_property(_fsdk.DialogDescriptionConfig_width_get, _fsdk.DialogDescriptionConfig_width_set)
static

The width of the dialog box in pixels.

If no width is specified, the combined width of the contents is used.