Foxit PDF SDK
FoxitPDFSDKPython2.ButtonItem Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def ButtonItem ()
 Constructor. More...
 
def Set (name, pos, exec, enable, marked, tooltip, label, bitmap)
 Set values. More...
 

Static Public Attributes

 bitmap = _swig_property(_fsdk.ButtonItem_bitmap_get, _fsdk.ButtonItem_bitmap_set)
 A bitmap object of button.
 
 enable = _swig_property(_fsdk.ButtonItem_enable_get, _fsdk.ButtonItem_enable_set)
 An expression string that determines whether to enable the toolbutton.
 
 label = _swig_property(_fsdk.ButtonItem_label_get, _fsdk.ButtonItem_label_set)
 A text label to be displayed on the button to the right of the icon.
 
 marked = _swig_property(_fsdk.ButtonItem_marked_get, _fsdk.ButtonItem_marked_set)
 An expression string that determines whether the toolbutton is marked.
 
 name = _swig_property(_fsdk.ButtonItem_name_get, _fsdk.ButtonItem_name_set)
 A unique language-independent identifier for the button.
 
 pos = _swig_property(_fsdk.ButtonItem_pos_get, _fsdk.ButtonItem_pos_set)
 The button number to place the added button in the toolbar.
 
 tooltip = _swig_property(_fsdk.ButtonItem_tooltip_get, _fsdk.ButtonItem_tooltip_set)
 The text to display in the button help text when the mouse is over the toolbutton.
 

Detailed Description

This class represents button item.

Constructor & Destructor Documentation

◆ ButtonItem()

def FoxitPDFSDKPython2.ButtonItem.ButtonItem ( )

Constructor.

Constructor, with another button item object.

Constructor, with parameters.

Parameters
[in]nameA unique language-independent identifier for the button.
[in]posThe button number to place the added button in the toolbar.
[in]execThe expression string to evaluate when the button is selected.
[in]enableAn expression string that determines whether to enable the toolbutton.
[in]markedAn expression string that determines whether the toolbutton is marked.
[in]tooltipThe text to display in the button help text when the mouse is over the toolbutton.
[in]labelA text label to be displayed on the button to the right of the icon.
[in]bitmapA bitmap object of button.
[in]button_itemAnother button item object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.ButtonItem.Set (   name,
  pos,
  exec,
  enable,
  marked,
  tooltip,
  label,
  bitmap 
)

Set values.

Parameters
[in]nameA unique language-independent identifier for the button.
[in]posThe button number to place the added button in the toolbar.
[in]execThe expression string to evaluate when the button is selected.
[in]enableAn expression string that determines whether to enable the toolbutton.
[in]markedAn expression string that determines whether the toolbutton is marked.
[in]tooltipThe text to display in the button help text when the mouse is over the toolbutton.
[in]labelA text label to be displayed on the button to the right of the icon.
[in]bitmapA bitmap object of button.
Returns
None.