Foxit PDF SDK
fsdk.DialogDescriptionConfig Class Reference

Public Member Functions

def GetAlign_children ()
 Get the alignment for all descendants. More...
 
def GetChar_height ()
 Get the height of the dialog box in characters. More...
 
def GetChar_width ()
 Get the width of the dialog box in characters. More...
 
def GetElement_array ()
 Get an array of dialog description element array object. More...
 
def GetFirst_tab ()
 Get an ItemID for the dialog box item that should be first in the tab order. More...
 
def GetHeight ()
 Get the height of the dialog box in pixels. More...
 
def GetName ()
 Get the title bar of the dialog box. More...
 
def GetWidth ()
 Get the width of the dialog box in pixels. More...
 
def Set (name, first_tab, width, height, char_width, char_height, align_children, element_array)
 Set values.
More...
 
def SetAlign_children (value)
 Set the alignment for all descendants. More...
 
def SetChar_height (value)
 Set the height of the dialog box in characters. More...
 
def SetChar_width (value)
 Set the width of the dialog box in characters. More...
 
def SetElement_array (value)
 Set an array of dialog description element array object. More...
 
def SetFirst_tab (value)
 Set an ItemID for the dialog box item that should be first in the tab order. More...
 
def SetHeight (value)
 Set the height of the dialog box in pixels. More...
 
def SetName (value)
 Set the title bar of the dialog box. More...
 
def SetWidth (value)
 Set the width of the dialog box in pixels. More...
 

Detailed Description

This class represents dialog config.

Member Function Documentation

◆ GetAlign_children()

fsdk.DialogDescriptionConfig.GetAlign_children ( )

Get the alignment for all descendants.

Returns
The alignment for all descendants.

◆ GetChar_height()

fsdk.DialogDescriptionConfig.GetChar_height ( )

Get the height of the dialog box in characters.

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

Returns
The height of the dialog box in characters.

◆ GetChar_width()

fsdk.DialogDescriptionConfig.GetChar_width ( )

Get the width of the dialog box in characters.

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

Returns
The width of the dialog box in characters.

◆ GetElement_array()

fsdk.DialogDescriptionConfig.GetElement_array ( )

Get an array of dialog description element array object.

Returns
An array of dialog description element array object.

◆ GetFirst_tab()

fsdk.DialogDescriptionConfig.GetFirst_tab ( )

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

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

◆ GetHeight()

fsdk.DialogDescriptionConfig.GetHeight ( )

Get the height of the dialog box in pixels.

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

Returns
The height of the dialog box in pixels.

◆ GetName()

fsdk.DialogDescriptionConfig.GetName ( )

Get the title bar of the dialog box.

Returns
The title bar of the dialog box.

◆ GetWidth()

fsdk.DialogDescriptionConfig.GetWidth ( )

Get the width of the dialog box in pixels.

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

Returns
The width of the dialog box in pixels.

◆ Set()

def fsdk.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.

◆ SetAlign_children()

fsdk.DialogDescriptionConfig.SetAlign_children (   value)

Set the alignment for all descendants.

Parameters
[in]valueThe alignment for all descendants.
Returns
None.

◆ SetChar_height()

fsdk.DialogDescriptionConfig.SetChar_height (   value)

Set the height of the dialog box in characters.

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

Parameters
[in]valueThe height of the dialog box in characters.
Returns
None.

◆ SetChar_width()

fsdk.DialogDescriptionConfig.SetChar_width (   value)

Set the width of the dialog box in characters.

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

Parameters
[in]valueThe width of the dialog box in characters.
Returns
None.

◆ SetElement_array()

fsdk.DialogDescriptionConfig.SetElement_array (   value)

Set an array of dialog description element array object.

Parameters
[in]valueAn array of dialog description element array object.
Returns
None.

◆ SetFirst_tab()

fsdk.DialogDescriptionConfig.SetFirst_tab (   value)

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

Parameters
[in]valueAn ItemID for the dialog box item that should be first in the tab order.
Returns
None.

◆ SetHeight()

fsdk.DialogDescriptionConfig.SetHeight (   value)

Set the height of the dialog box in pixels.

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

Parameters
[in]valueThe height of the dialog box in pixels.
Returns
None.

◆ SetName()

fsdk.DialogDescriptionConfig.SetName (   value)

Set the title bar of the dialog box.

Parameters
[in]valueThe title bar of the dialog box.
Returns
None.

◆ SetWidth()

fsdk.DialogDescriptionConfig.SetWidth (   value)

Set the width of the dialog box in pixels.

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

Parameters
[in]valueThe width of the dialog box in pixels.
Returns
None.