Foxit PDF SDK
fsdk.ChoiceOption Class Reference

Public Member Functions

def GetDefault_selected ()
 Get used to indicate whether the option would be selected by default or not. More...
 
def GetOption_label ()
 Get the displayed string value for the option. More...
 
def GetOption_value ()
 Get the option string value. More...
 
def GetSelected ()
 Get used to indicate whether the option is selected or not. More...
 
def Set (option_value, option_label, selected, default_selected)
 Set value.
More...
 
def SetDefault_selected (value)
 Set used to indicate whether the option would be selected by default or not. More...
 
def SetOption_label (value)
 Set the displayed string value for the option. More...
 
def SetOption_value (value)
 Set the option string value. More...
 
def SetSelected (value)
 Set used to indicate whether the option is selected or not. More...
 

Detailed Description

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

Member Function Documentation

◆ GetDefault_selected()

fsdk.ChoiceOption.GetDefault_selected ( )

Get used to indicate whether the option would be selected by default or not.

Returns
Used to indicate whether the option would be selected by default or not.

◆ GetOption_label()

fsdk.ChoiceOption.GetOption_label ( )

Get the displayed string value for the option.

Returns
The displayed string value for the option.

◆ GetOption_value()

fsdk.ChoiceOption.GetOption_value ( )

Get the option string value.

Returns
The option string value.

◆ GetSelected()

fsdk.ChoiceOption.GetSelected ( )

Get used to indicate whether the option is selected or not.

Returns
Used to indicate whether the option is selected or not.

◆ Set()

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

◆ SetDefault_selected()

fsdk.ChoiceOption.SetDefault_selected (   value)

Set used to indicate whether the option would be selected by default or not.

Parameters
[in]valueUsed to indicate whether the option would be selected by default or not.
Returns
None.

◆ SetOption_label()

fsdk.ChoiceOption.SetOption_label (   value)

Set the displayed string value for the option.

Parameters
[in]valueThe displayed string value for the option.
Returns
None.

◆ SetOption_value()

fsdk.ChoiceOption.SetOption_value (   value)

Set the option string value.

Parameters
[in]valueThe option string value.
Returns
None.

◆ SetSelected()

fsdk.ChoiceOption.SetSelected (   value)

Set used to indicate whether the option is selected or not.

Parameters
[in]valueUsed to indicate whether the option is selected or not.
Returns
None.