Foxit PDF SDK
FoxitPDFSDKPython2.DialogDescriptionElement Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def DialogDescriptionElement ()
 Constructor. More...
 
def Set (name, item_id, type, next_tab, width, height, char_width, char_height, font, bold, italic, alignment, align_children, element_array)
 Set values. More...
 

Static Public Attributes

 align_children = _swig_property(_fsdk.DialogDescriptionElement_align_children_get, _fsdk.DialogDescriptionElement_align_children_set)
 The alignment for all descendants.
 
 alignment = _swig_property(_fsdk.DialogDescriptionElement_alignment_get, _fsdk.DialogDescriptionElement_alignment_set)
 The alignment for this element.
 
 bold = _swig_property(_fsdk.DialogDescriptionElement_bold_get, _fsdk.DialogDescriptionElement_bold_set)
 Specify if the font is bold.
 
 char_height = _swig_property(_fsdk.DialogDescriptionElement_char_height_get, _fsdk.DialogDescriptionElement_char_height_set)
 Specifies the height of the element in characters. More...
 
 char_width = _swig_property(_fsdk.DialogDescriptionElement_char_width_get, _fsdk.DialogDescriptionElement_char_width_set)
 Specifies the width of the element in characters. More...
 
 element_array = _swig_property(_fsdk.DialogDescriptionElement_element_array_get, _fsdk.DialogDescriptionElement_element_array_set)
 An array of object literals that describe the subelements of this dialog box element.
 
 font = _swig_property(_fsdk.DialogDescriptionElement_font_get, _fsdk.DialogDescriptionElement_font_set)
 The font to use for this element. More...
 
 height = _swig_property(_fsdk.DialogDescriptionElement_height_get, _fsdk.DialogDescriptionElement_height_set)
 Specifies the height of the element in pixels. More...
 
 italic = _swig_property(_fsdk.DialogDescriptionElement_italic_get, _fsdk.DialogDescriptionElement_italic_set)
 Specify if the font is italic.
 
 item_id = _swig_property(_fsdk.DialogDescriptionElement_item_id_get, _fsdk.DialogDescriptionElement_item_id_set)
 An ItemID for this dialog box.
 
 name = _swig_property(_fsdk.DialogDescriptionElement_name_get, _fsdk.DialogDescriptionElement_name_set)
 The displayed name of the dialog box element.
 
 next_tab = _swig_property(_fsdk.DialogDescriptionElement_next_tab_get, _fsdk.DialogDescriptionElement_next_tab_set)
 An ItemID for the next dialog box item in the tab order.
 
 type = _swig_property(_fsdk.DialogDescriptionElement_type_get, _fsdk.DialogDescriptionElement_type_set)
 The type of this dialog box element.
 
 width = _swig_property(_fsdk.DialogDescriptionElement_width_get, _fsdk.DialogDescriptionElement_width_set)
 Specifies the width of the element in pixels. More...
 

Detailed Description

This class represents a dialog box elements property specifies an object literal with the following set of properties.

Constructor & Destructor Documentation

◆ DialogDescriptionElement()

def FoxitPDFSDKPython2.DialogDescriptionElement.DialogDescriptionElement ( )

Constructor.

Constructor, with another dialog description element object.

Constructor, with parameters.

Parameters
[in]nameThe displayed name of the dialog box element.
[in]item_idAn ItemID for this dialog box.
[in]typeThe type of this dialog box element.
[in]next_tabAn ItemID for the dialog box item that should be first in the tab order.
[in]widthSpecifies the width of the element in pixels.
[in]heightSpecifies the height of the element in pixels.
[in]char_widthSpecifies the width of the element in characters.
[in]char_heightSpecifies the height of the element in characters.
[in]fontThe font to use for this element.
[in]boldSpecify if the font is bold.
[in]italicSpecify if the font is italic.
[in]alignmentThe alignment for this element.
[in]align_childrenThe alignment for all descendants.
[in]element_arrayAn array of object literals that describe the subelements of this dialog box element.
[in]dlg_des_elementAnother dialog description element object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.DialogDescriptionElement.Set (   name,
  item_id,
  type,
  next_tab,
  width,
  height,
  char_width,
  char_height,
  font,
  bold,
  italic,
  alignment,
  align_children,
  element_array 
)

Set values.

Parameters
[in]nameThe displayed name of the dialog box element.
[in]item_idAn ItemID for this dialog box.
[in]typeThe type of this dialog box element.
[in]next_tabAn ItemID for the dialog box item that should be first in the tab order.
[in]widthSpecifies the width of the element in pixels.
[in]heightSpecifies the height of the element in pixels.
[in]char_widthSpecifies the width of the element in characters.
[in]char_heightSpecifies the height of the element in characters.
[in]fontThe font to use for this element.
[in]boldSpecify if the font is bold.
[in]italicSpecify if the font is italic.
[in]alignmentThe alignment for this element.
[in]align_childrenThe alignment for all descendants.
[in]element_arrayAn array of object literals that describe the subelements of this dialog box element.
Returns
None.

Member Data Documentation

◆ char_height

FoxitPDFSDKPython2.DialogDescriptionElement.char_height = _swig_property(_fsdk.DialogDescriptionElement_char_height_get, _fsdk.DialogDescriptionElement_char_height_set)
static

Specifies the height of the element in characters.

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

◆ char_width

FoxitPDFSDKPython2.DialogDescriptionElement.char_width = _swig_property(_fsdk.DialogDescriptionElement_char_width_get, _fsdk.DialogDescriptionElement_char_width_set)
static

Specifies the width of the element in characters.

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

◆ font

FoxitPDFSDKPython2.DialogDescriptionElement.font = _swig_property(_fsdk.DialogDescriptionElement_font_get, _fsdk.DialogDescriptionElement_font_set)
static

The font to use for this element.

It will be one of the following strings:

  • "default" - Default font

  • "dialog" - Dialog box font

  • "palette" - Palette (small) Font

◆ height

FoxitPDFSDKPython2.DialogDescriptionElement.height = _swig_property(_fsdk.DialogDescriptionElement_height_get, _fsdk.DialogDescriptionElement_height_set)
static

Specifies the height of the element in pixels.

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

◆ width

FoxitPDFSDKPython2.DialogDescriptionElement.width = _swig_property(_fsdk.DialogDescriptionElement_width_get, _fsdk.DialogDescriptionElement_width_set)
static

Specifies the width of the element in pixels.

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