Foxit PDF SDK
FoxitPDFSDKPython2.ChoiceOption Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def ChoiceOption ()
 Constructor. More...
 
def Set (option_value, option_label, selected, default_selected)
 Set value. More...
 

Static Public Attributes

 default_selected = _swig_property(_fsdk.ChoiceOption_default_selected_get, _fsdk.ChoiceOption_default_selected_set)
 Used to indicate whether the option would be selected by default or not.
 
 option_label = _swig_property(_fsdk.ChoiceOption_option_label_get, _fsdk.ChoiceOption_option_label_set)
 The displayed string value for the option.
 
 option_value = _swig_property(_fsdk.ChoiceOption_option_value_get, _fsdk.ChoiceOption_option_value_set)
 The option string value.
 
 selected = _swig_property(_fsdk.ChoiceOption_selected_get, _fsdk.ChoiceOption_selected_set)
 Used to indicate whether the option is selected or not.
 

Detailed Description

This class represents the data of an option in list box or combo box.

Constructor & Destructor Documentation

◆ ChoiceOption()

def FoxitPDFSDKPython2.ChoiceOption.ChoiceOption ( )

Constructor.

Constructor, with another choice option object.

Constructor, with parameters.

Parameters
[in]option_valueThe option string value.
[in]option_labelThe displayed string value for the option.
[in]selectedtrue means the option is selected, and false means the option is not selected.
[in]default_selectedtrue means the option would be selected by default, and false means the option would not be selected by default.
[in]optionAnother choice option object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.ChoiceOption.Set (   option_value,
  option_label,
  selected,
  default_selected 
)

Set value.

Parameters
[in]option_valueThe option string value.
[in]option_labelThe displayed string value for the option.
[in]selectedtrue means the option is selected, and false means the option is not selected.
[in]default_selectedtrue means the option would be selected by default, and false means the option would not be selected by default.
Returns
None.