Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.pdf.actions.DialogDescriptionElement Class Reference

Inherits SystemIDisposable.

Public Member Functions

 DialogDescriptionElement ()
 Constructor.
 
 DialogDescriptionElement (string name, string item_id, string type, string next_tab, int width, int height, int char_width, int char_height, string font, bool bold, bool italic, string alignment, string align_children, DialogDescriptionElementArray element_array)
 Constructor, with parameters. More...
 
 DialogDescriptionElement (DialogDescriptionElement dlg_des_element)
 Constructor, with another dialog description element object. More...
 
void Set (string name, string item_id, string type, string next_tab, int width, int height, int char_width, int char_height, string font, bool bold, bool italic, string alignment, string align_children, DialogDescriptionElementArray element_array)
 Set values. More...
 

Properties

string align_children [get, set]
 The alignment for all descendants.
 
string alignment [get, set]
 The alignment for this element.
 
bool bold [get, set]
 Specify if the font is bold.
 
int char_height [get, set]
 Specifies the height of the element in characters. More...
 
int char_width [get, set]
 Specifies the width of the element in characters. More...
 
DialogDescriptionElementArray element_array [get, set]
 An array of object literals that describe the subelements of this dialog box element.
 
string font [get, set]
 The font to use for this element. More...
 
int height [get, set]
 Specifies the height of the element in pixels. More...
 
bool italic [get, set]
 Specify if the font is italic.
 
string item_id [get, set]
 An ItemID for this dialog box.
 
string name [get, set]
 The displayed name of the dialog box element.
 
string next_tab [get, set]
 An ItemID for the next dialog box item in the tab order.
 
string type [get, set]
 The type of this dialog box element.
 
int width [get, 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

foxit.pdf.actions.DialogDescriptionElement.DialogDescriptionElement ( string  name,
string  item_id,
string  type,
string  next_tab,
int  width,
int  height,
int  char_width,
int  char_height,
string  font,
bool  bold,
bool  italic,
string  alignment,
string  align_children,
DialogDescriptionElementArray  element_array 
)
inline

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.
foxit.pdf.actions.DialogDescriptionElement.DialogDescriptionElement ( DialogDescriptionElement  dlg_des_element)
inline

Constructor, with another dialog description element object.

Parameters
[in]dlg_des_elementAnother dialog description element object.

Member Function Documentation

void foxit.pdf.actions.DialogDescriptionElement.Set ( string  name,
string  item_id,
string  type,
string  next_tab,
int  width,
int  height,
int  char_width,
int  char_height,
string  font,
bool  bold,
bool  italic,
string  alignment,
string  align_children,
DialogDescriptionElementArray  element_array 
)
inline

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.

Property Documentation

int foxit.pdf.actions.DialogDescriptionElement.char_height
getset

Specifies the height of the element in characters.

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

int foxit.pdf.actions.DialogDescriptionElement.char_width
getset

Specifies the width of the element in characters.

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

string foxit.pdf.actions.DialogDescriptionElement.font
getset

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
int foxit.pdf.actions.DialogDescriptionElement.height
getset

Specifies the height of the element in pixels.

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

int foxit.pdf.actions.DialogDescriptionElement.width
getset

Specifies the width of the element in pixels.

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