Foxit PDF SDK
fsdk.MenuItemEx Class Reference

Public Member Functions

def GetIs_checked ()
 Get a boolean value which indicates whether the menu item is to be marked as checked. More...
 
def GetIs_enabled ()
 Get a boolean value which indicates whether the menu item is to appear enabled or grayed out. More...
 
def GetItem_name ()
 Get the menu item name, which is the string to appear on the menu item. More...
 
def GetReturn_name ()
 Get a string to be returned when the menu item is selected. More...
 
def GetSub_menu_item_array ()
 Get the sub menu item array. More...
 
def Set (item_name, return_name, is_checked, is_enabled, sub_menu_item_array)
 Set values. More...
 
def SetIs_checked (value)
 Set a boolean value which indicates whether the menu item is to be marked as checked. More...
 
def SetIs_enabled (value)
 Set a boolean value which indicates whether the menu item is to appear enabled or grayed out. More...
 
def SetItem_name (value)
 Set the menu item name, which is the string to appear on the menu item. More...
 
def SetReturn_name (value)
 Set a string to be returned when the menu item is selected. More...
 
def SetSub_menu_item_array (value)
 Set the sub menu item array. More...
 

Detailed Description

This class represents menu item.

Member Function Documentation

◆ GetIs_checked()

fsdk.MenuItemEx.GetIs_checked ( )

Get a boolean value which indicates whether the menu item is to be marked as checked.

true means that the menu item is to be marked as checked, while false means that the menu item is not to be marked as checked.

Returns
A boolean value which indicates whether the menu item is to be marked as checked.

◆ GetIs_enabled()

fsdk.MenuItemEx.GetIs_enabled ( )

Get a boolean value which indicates whether the menu item is to appear enabled or grayed out.

true means that the menu item is to appear enabled, while false means that the menu item is to appear grayed out.

Returns
A boolean value which indicates whether the menu item is to appear enabled or grayed out.

◆ GetItem_name()

fsdk.MenuItemEx.GetItem_name ( )

Get the menu item name, which is the string to appear on the menu item.

Returns
The menu item name, which is the string to appear on the menu item. The value of "-" is reserved to draw a separator line in the menu.

◆ GetReturn_name()

fsdk.MenuItemEx.GetReturn_name ( )

Get a string to be returned when the menu item is selected.

Returns
A string to be returned when the menu item is selected. The default is the value of item name.

◆ GetSub_menu_item_array()

fsdk.MenuItemEx.GetSub_menu_item_array ( )

Get the sub menu item array.

Returns
The sub menu item array.

◆ Set()

def fsdk.MenuItemEx.Set (   item_name,
  return_name,
  is_checked,
  is_enabled,
  sub_menu_item_array 
)

Set values.

Parameters
[in]item_nameThe menu item name, which is the string to appear on the menu item.
[in]return_nameA string to be returned when the menu item is selected.
[in]is_checkedA boolean value which indicates whether the menu item is to be marked as checked.
[in]is_enabledA boolean value which indicates whether the menu item is to appear enabled or grayed out.
[in]sub_menu_item_arrayThe sub menu item array.
Returns
None.

◆ SetIs_checked()

fsdk.MenuItemEx.SetIs_checked (   value)

Set a boolean value which indicates whether the menu item is to be marked as checked.

true means that the menu item is to be marked as checked, while false means that the menu item is not to be marked as checked.

Parameters
[in]valueA boolean value which indicates whether the menu item is to be marked as checked.
Returns
None.

◆ SetIs_enabled()

fsdk.MenuItemEx.SetIs_enabled (   value)

Set a boolean value which indicates whether the menu item is to appear enabled or grayed out.

true means that the menu item is to appear enabled, while false means that the menu item is to appear grayed out.

Parameters
[in]valueA boolean value which indicates whether the menu item is to appear enabled or grayed out.
Returns
None.

◆ SetItem_name()

fsdk.MenuItemEx.SetItem_name (   value)

Set the menu item name, which is the string to appear on the menu item.

Parameters
[in]valueThe menu item name, which is the string to appear on the menu item. The value of "-" is reserved to draw a separator line in the menu.
Returns
None.

◆ SetReturn_name()

fsdk.MenuItemEx.SetReturn_name (   value)

Set a string to be returned when the menu item is selected.

Parameters
[in]valueA string to be returned when the menu item is selected. The default is the value of item name.
Returns
None.

◆ SetSub_menu_item_array()

fsdk.MenuItemEx.SetSub_menu_item_array (   value)

Set the sub menu item array.

Parameters
[in]valueThe sub menu item array.
Returns
None.