Foxit PDF RDK

Public Member Functions | Public Attributes | List of all members
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)
| 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...
| item_name
| 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.
| 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()

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

Constructor, with parameters.

Parameters

  [in] | item_name | The menu item name, which is the string to appear on the menu item.
  [in] | return_name | A string to be returned when the menu item is selected.
  [in] | is_checked | A boolean value which indicates whether the menu item is to be marked as checked.
  [in] | is_enabled | A boolean value which indicates whether the menu item is to appear enabled or grayed out.
  [in] | sub_menu_item_array | The sub menu item array.

## ◆ Set()

MenuItemEx.Set | ( | item_name | ,
|  | return_name | ,
|  | is_checked | ,
|  | is_enabled | ,
|  | sub_menu_item_array |
| ) |  |

Set values.

Parameters

  [in] | item_name | The menu item name, which is the string to appear on the menu item.
  [in] | return_name | A string to be returned when the menu item is selected.
  [in] | is_checked | A boolean value which indicates whether the menu item is to be marked as checked.
  [in] | is_enabled | A boolean value which indicates whether the menu item is to appear enabled or grayed out.
  [in] | sub_menu_item_array | The sub menu item array.

Returns
  None.

## Member Data Documentation

## ◆ is_checked

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

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.