Foxit PDF SDK
fsdk.DialogDescriptionElement Class Reference

Public Member Functions

def GetAlign_children ()
 Get the alignment for all descendants. More...
 
def GetAlignment ()
 Get the alignment for this element. More...
 
def GetBold ()
 Get specify if the font is bold. More...
 
def GetChar_height ()
 Get specifies the height of the element in characters. More...
 
def GetChar_width ()
 Get specifies the width of the element in characters. More...
 
def GetElement_array ()
 Get an array of object literals that describe the subelements of this dialog box element. More...
 
def GetFont ()
 Get the font to use for this element. More...
 
def GetHeight ()
 Get specifies the height of the element in pixels. More...
 
def GetItalic ()
 Get specify if the font is italic. More...
 
def GetItem_id ()
 Get an ItemID for this dialog box. More...
 
def GetName ()
 Get the displayed name of the dialog box element. More...
 
def GetNext_tab ()
 Get an ItemID for the next dialog box item in the tab order. More...
 
def GetWidth ()
 Get specifies the width of the element in pixels. 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...
 
def SetAlign_children (value)
 Set the alignment for all descendants. More...
 
def SetAlignment (value)
 Set the alignment for this element. More...
 
def SetBold (value)
 Set specify if the font is bold. More...
 
def SetChar_height (value)
 Set specifies the height of the element in characters. More...
 
def SetChar_width (value)
 Set specifies the width of the element in characters. More...
 
def SetElement_array (value)
 Set an array of object literals that describe the subelements of this dialog box element. More...
 
def SetFont (value)
 Set the font to use for this element. More...
 
def SetHeight (value)
 Set specifies the height of the element in pixels. More...
 
def SetItalic (value)
 Set specify if the font is italic. More...
 
def SetItem_id (value)
 Set an ItemID for this dialog box. More...
 
def SetName (value)
 Set the displayed name of the dialog box element. More...
 
def SetNext_tab (value)
 Set an ItemID for the next dialog box item in the tab order. More...
 
def SetWidth (value)
 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.

Member Function Documentation

◆ GetAlign_children()

fsdk.DialogDescriptionElement.GetAlign_children ( )

Get the alignment for all descendants.

Returns
The alignment for all descendants.

◆ GetAlignment()

fsdk.DialogDescriptionElement.GetAlignment ( )

Get the alignment for this element.

Returns
The alignment for this element.

◆ GetBold()

fsdk.DialogDescriptionElement.GetBold ( )

Get specify if the font is bold.

Returns
Specify if the font is bold.

◆ GetChar_height()

fsdk.DialogDescriptionElement.GetChar_height ( )

Get specifies the height of the element in characters.

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

Returns
Specifies the height of the element in characters.

◆ GetChar_width()

fsdk.DialogDescriptionElement.GetChar_width ( )

Get specifies the width of the element in characters.

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

Returns
Specifies the width of the element in characters.

◆ GetElement_array()

fsdk.DialogDescriptionElement.GetElement_array ( )

Get an array of object literals that describe the subelements of this dialog box element.

Returns
An array of object literals that describe the subelements of this dialog box element.

◆ GetFont()

fsdk.DialogDescriptionElement.GetFont ( )

Get 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

Returns
The font to use for this element.

◆ GetHeight()

fsdk.DialogDescriptionElement.GetHeight ( )

Get specifies the height of the element in pixels.

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

Returns
Specifies the height of the element in pixels.

◆ GetItalic()

fsdk.DialogDescriptionElement.GetItalic ( )

Get specify if the font is italic.

Returns
Specify if the font is italic.

◆ GetItem_id()

fsdk.DialogDescriptionElement.GetItem_id ( )

Get an ItemID for this dialog box.

Returns
An ItemID for this dialog box.

◆ GetName()

fsdk.DialogDescriptionElement.GetName ( )

Get the displayed name of the dialog box element.

Returns
The displayed name of the dialog box element.

◆ GetNext_tab()

fsdk.DialogDescriptionElement.GetNext_tab ( )

Get an ItemID for the next dialog box item in the tab order.

Returns
An ItemID for the next dialog box item in the tab order.

◆ GetWidth()

fsdk.DialogDescriptionElement.GetWidth ( )

Get specifies the width of the element in pixels.

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

Returns
Specifies the width of the element in pixels.

◆ Set()

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

◆ SetAlign_children()

fsdk.DialogDescriptionElement.SetAlign_children (   value)

Set the alignment for all descendants.

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

◆ SetAlignment()

fsdk.DialogDescriptionElement.SetAlignment (   value)

Set the alignment for this element.

Parameters
[in]valueThe alignment for this element.
Returns
None.

◆ SetBold()

fsdk.DialogDescriptionElement.SetBold (   value)

Set specify if the font is bold.

Parameters
[in]valueSpecify if the font is bold.
Returns
None.

◆ SetChar_height()

fsdk.DialogDescriptionElement.SetChar_height (   value)

Set specifies the height of the element in characters.

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

Parameters
[in]valueSpecifies the height of the element in characters.
Returns
None.

◆ SetChar_width()

fsdk.DialogDescriptionElement.SetChar_width (   value)

Set specifies the width of the element in characters.

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

Parameters
[in]valueSpecifies the width of the element in characters.
Returns
None.

◆ SetElement_array()

fsdk.DialogDescriptionElement.SetElement_array (   value)

Set an array of object literals that describe the subelements of this dialog box element.

Parameters
[in]valueAn array of object literals that describe the subelements of this dialog box element.
Returns
None.

◆ SetFont()

fsdk.DialogDescriptionElement.SetFont (   value)

Set 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

Parameters
[in]valueThe font to use for this element.
Returns
None.

◆ SetHeight()

fsdk.DialogDescriptionElement.SetHeight (   value)

Set specifies the height of the element in pixels.

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

Parameters
[in]valueSpecifies the height of the element in pixels.
Returns
None.

◆ SetItalic()

fsdk.DialogDescriptionElement.SetItalic (   value)

Set specify if the font is italic.

Parameters
[in]valueSpecify if the font is italic.
Returns
None.

◆ SetItem_id()

fsdk.DialogDescriptionElement.SetItem_id (   value)

Set an ItemID for this dialog box.

Parameters
[in]valueAn ItemID for this dialog box.
Returns
None.

◆ SetName()

fsdk.DialogDescriptionElement.SetName (   value)

Set the displayed name of the dialog box element.

Parameters
[in]valueThe displayed name of the dialog box element.
Returns
None.

◆ SetNext_tab()

fsdk.DialogDescriptionElement.SetNext_tab (   value)

Set an ItemID for the next dialog box item in the tab order.

Parameters
[in]valueAn ItemID for the next dialog box item in the tab order.
Returns
None.

◆ SetWidth()

fsdk.DialogDescriptionElement.SetWidth (   value)

Set specifies the width of the element in pixels.

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

Parameters
[in]valueSpecifies the width of the element in pixels.
Returns
None.