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

Inherits SystemIDisposable.

Public Member Functions

 ChoiceOption ()
 Constructor.
 
 ChoiceOption (string option_value, string option_label, bool selected, bool default_selected)
 Constructor, with parameters. More...
 
 ChoiceOption (ChoiceOption option)
 Constructor, with another choice option object. More...
 
void Set (string option_value, string option_label, bool selected, bool default_selected)
 Set value. More...
 

Properties

bool default_selected [get, set]
 Used to indicate whether the option would be selected by default or not.
 
string option_label [get, set]
 The displayed string value for the option.
 
string option_value [get, set]
 The option string value.
 
bool selected [get, 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

foxit.pdf.interform.ChoiceOption.ChoiceOption ( string  option_value,
string  option_label,
bool  selected,
bool  default_selected 
)
inline

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.
foxit.pdf.interform.ChoiceOption.ChoiceOption ( ChoiceOption  option)
inline

Constructor, with another choice option object.

Parameters
[in]optionAnother choice option object.

Member Function Documentation

void foxit.pdf.interform.ChoiceOption.Set ( string  option_value,
string  option_label,
bool  selected,
bool  default_selected 
)
inline

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.