Foxit PDF SDK
FSDK.MenuItemEx Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (item_name, return_name, is_checked, is_enabled, sub_menu_item_array)
 Constructor, with parameters. More...
 
 Set (item_name, return_name, is_checked, is_enabled, sub_menu_item_array) item_name
 Set values. More...
 

Public Attributes

 is_checked
 A boolean value which indicates whether the menu item is to be marked as checked. More...
 
 is_enabled
 A boolean value which indicates whether the menu item is to appear enabled or grayed out. More...
 
 return_name
 A string to be returned when the menu item is selected. The default is the value of item name.
 
 sub_menu_item_array
 The sub menu item array.
 

Detailed Description

This class represents menu item.

Member Function Documentation

◆ constructor()

FSDK.MenuItemEx.constructor ( item_name  ,
return_name  ,
is_checked  ,
is_enabled  ,
sub_menu_item_array   
)

Constructor, with parameters.

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.

◆ Set()

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.

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.

Member Data Documentation

◆ is_checked

FSDK.MenuItemEx.is_checked

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.

◆ is_enabled

FSDK.MenuItemEx.is_enabled

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.