Foxit PDF SDK
fsdk.Control Class Reference

Public Member Functions

def GetAlignment ()
 Get the alignment value.
More...
 
def GetDefaultAppearance ()
 Get the default appearance data.
More...
 
def GetExportValue ()
 Get export mapping name when related form field is check box or radio button.
More...
 
def GetField ()
 Get the related form field.
More...
 
def GetIndex ()
 Get the index of current form control among all the controls of related form field.
More...
 
def GetWidget ()
 Get the related widget annotation.
More...
 
def GetWidgetDict ()
 Get the dictionary of related widget annotation.
More...
 
def IsChecked ()
 Check if the current form control is checked when related form field is check box or radio button.
More...
 
def IsDefaultChecked ()
 Check if the current form control is checked by default when related form field is check box or radio button.
More...
 
def IsEmpty ()
 Check whether current object is empty or not.
More...
 
def SetAlignment (alignment)
 Set alignment property of current form control.
More...
 
def SetChecked (checked_status)
 Set the check state of current form control when related form field is check box or radio button.
More...
 
def SetDefaultAppearance (default_ap)
 Set default appearance data.
More...
 
def SetDefaultChecked (checked_status)
 Set the default check state of current form control when related form field is check box or radio button.
More...
 
def SetExportValue (value)
 Set export mapping name when related form field is check box or radio button.
More...
 

Detailed Description

Foxit PDF SDK defines "form control" to associate form field with its related widget annotations. A form field may have one or more form controls, and each form control is associated with a widget annotation. A form control object can be retrieved by following functions:

Form control also offers functions to get related form field object and widget annotation object.
Function fsdk.Form.AddControl can be used to add a new form control to a form field, and function fsdk.Form.RemoveControl can be used to remove a form control.

See also
Form
Field

Member Function Documentation

◆ GetAlignment()

def fsdk.Control.GetAlignment ( )

Get the alignment value.

Alignment is a property for variable text and it is only useful for text field, list box and combo box as related form field, which may contain variable text as their content.
If related form field is a text field or list box and it has its own alignment value, the document-wide default alignment value will be ignored; otherwise, the document-wide default alignment value will be used in this case.

Returns
Alignment value. Please refer to values starting from fsdk.E_AlignmentLeft and this would be one of these values.

◆ GetDefaultAppearance()

def fsdk.Control.GetDefaultAppearance ( )

Get the default appearance data.

Returns
The default appearance data.

◆ GetExportValue()

def fsdk.Control.GetExportValue ( )

Get export mapping name when related form field is check box or radio button.

Applicable for check box and radio button as related form field. If related form field is other field type, this function will return an empty string.

Returns
The export mapping name.

◆ GetField()

def fsdk.Control.GetField ( )

Get the related form field.

Returns
The related form field object.

◆ GetIndex()

def fsdk.Control.GetIndex ( )

Get the index of current form control among all the controls of related form field.

Returns
The index of the form control.

◆ GetWidget()

def fsdk.Control.GetWidget ( )

Get the related widget annotation.

Returns
The related widget annotation.

◆ GetWidgetDict()

def fsdk.Control.GetWidgetDict ( )

Get the dictionary of related widget annotation.

Returns
Dictionary of related widget annotation. If there is any error, the function will return null.

◆ IsChecked()

def fsdk.Control.IsChecked ( )

Check if the current form control is checked when related form field is check box or radio button.

Applicable for check box and radio button as related form field. If related form field is other field type, this function will return false.

Returns
true means checked, and false means not checked.

◆ IsDefaultChecked()

def fsdk.Control.IsDefaultChecked ( )

Check if the current form control is checked by default when related form field is check box or radio button.

Applicable for check box and radio button as related form field. If related form field is other field type, this function will return false.

Returns
true means checked by default, and false means not checked by default.

◆ IsEmpty()

def fsdk.Control.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ SetAlignment()

def fsdk.Control.SetAlignment (   alignment)

Set alignment property of current form control.

Alignment is a property for variable text and it is only useful for text field, list box and combo box as related form field, which may contain variable text as their content.
If related form field is a text field or list box and it has its own alignment value, the document-wide default alignment value will be ignored; otherwise, the document-wide default alignment value will be used in this case.

Parameters
[in]alignmentNew default alignment type of variable text. Please refer to values starting from fsdk.E_AlignmentLeft and this should be one of these values.
If other values is used to set, fsdk.E_AlignmentLeft will be used by default.
Returns
None.

◆ SetChecked()

def fsdk.Control.SetChecked (   checked_status)

Set the check state of current form control when related form field is check box or radio button.

Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.

Parameters
[in]checked_statustrue means checked, and false means not checked.
Returns
None.

◆ SetDefaultAppearance()

def fsdk.Control.SetDefaultAppearance (   default_ap)

Set default appearance data.

Parameters
[in]default_apThe new default appearance. flags of input data can be used to decide which information is/are to be updated with the new data; for those no updated data, they will keep to use old data.
If text_size of input default appearance data is 0, that means the text size should be calculated automatically.
Returns
None.

◆ SetDefaultChecked()

def fsdk.Control.SetDefaultChecked (   checked_status)

Set the default check state of current form control when related form field is check box or radio button.

Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.

Parameters
[in]checked_statustrue means checked by default, and false means not checked by default.
Returns
None.

◆ SetExportValue()

def fsdk.Control.SetExportValue (   value)

Set export mapping name when related form field is check box or radio button.

Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.

Parameters
[in]valueThe new export mapping name. It should not be an empty string.
Returns
None.