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

Inherits SystemIDisposable.

Public Member Functions

 MenuItemEx ()
 Constructor.
 
 MenuItemEx (string item_name, string return_name, bool is_checked, bool is_enabled, MenuItemExArray sub_menu_item_array)
 Constructor, with parameters. More...
 
 MenuItemEx (MenuItemEx menu_item)
 Constructor, with another menu item object. More...
 
void Set (string item_name, string return_name, bool is_checked, bool is_enabled, MenuItemExArray sub_menu_item_array)
 Set values. More...
 

Properties

bool is_checked [get, set]
 A boolean value which indicates whether the menu item is to be marked as checked. More...
 
bool is_enabled [get, set]
 A boolean value which indicates whether the menu item is to appear enabled or grayed out. More...
 
string item_name [get, set]
 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.
 
string return_name [get, set]
 A string to be returned when the menu item is selected. The default is the value of item name.
 
MenuItemExArray sub_menu_item_array [get, set]
 The sub menu item array.
 

Detailed Description

This class represents menu item.

Constructor & Destructor Documentation

foxit.pdf.actions.MenuItemEx.MenuItemEx ( string  item_name,
string  return_name,
bool  is_checked,
bool  is_enabled,
MenuItemExArray  sub_menu_item_array 
)
inline

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.
foxit.pdf.actions.MenuItemEx.MenuItemEx ( MenuItemEx  menu_item)
inline

Constructor, with another menu item object.

Parameters
[in]menu_itemAnother menu item object.

Member Function Documentation

void foxit.pdf.actions.MenuItemEx.Set ( string  item_name,
string  return_name,
bool  is_checked,
bool  is_enabled,
MenuItemExArray  sub_menu_item_array 
)
inline

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.

Property Documentation

bool foxit.pdf.actions.MenuItemEx.is_checked
getset

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.

bool foxit.pdf.actions.MenuItemEx.is_enabled
getset

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.