xtd - Reference Guide  0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Member Functions | Protected Attributes | Protected Member Functions | List of all members
xtd::forms::menu_item Class Reference

#include <menu_item.h>

Definition

Represents an individual item that is displayed within a main_menu or context_menu.

Namespace
xtd::forms
Library
xtd.forms

Public Member Functions

 menu_item ()
 Initializes a menu_item with a blank caption. More...
 
 menu_item (const xtd::ustring &text)
 Initializes a new instance of the menu_item class with a specified caption for the menu item. More...
 
 menu_item (const xtd::ustring &text, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::drawing::image &image)
 Initializes a new instance of the class with a specified caption, and image menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::drawing::image &image, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, and image menu item, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, xtd::forms::menu_item_kind kind)
 Initializes a new instance of the class with a specified caption, and kind the menu item. More...
 
 menu_item (const xtd::ustring &text, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, kind the menu item, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind)
 Initializes a new instance of the class with a specified caption, image menu item, and kind the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, image menu item, kind the menu item, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, xtd::forms::menu_item_kind kind, bool checked)
 Initializes a new instance of the class with a specified caption, kind the menu item and checked. More...
 
 menu_item (const xtd::ustring &text, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, kind the menu item, checked, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked)
 Initializes a new instance of the class with a specified caption, image menu item, kind the menu item, and checked. More...
 
 menu_item (const xtd::ustring &text, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, image menu item, kind the menu item, checked, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click)
 Initializes a new instance of the class with a specified caption and event handler for the Click event of the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, event handler, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, const xtd::drawing::image &image)
 Initializes a new instance of the class with a specified caption, event handler, and image menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, const xtd::drawing::image &image, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, event handler, and image menu item, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, xtd::forms::menu_item_kind kind)
 Initializes a new instance of the class with a specified caption, event handler, and kind the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, event handler, kind the menu item, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind)
 Initializes a new instance of the class with a specified caption, event handler, image menu item, and kind the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, event handler, image menu item, kind the menu item, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, xtd::forms::menu_item_kind kind, bool checked)
 Initializes a new instance of the class with a specified caption, event handler, kind the menu item and checked. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, event handler, kind the menu item, checked, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked)
 Initializes a new instance of the class with a specified caption, event handler, image menu item, kind the menu item, and checked. More...
 
 menu_item (const xtd::ustring &text, const xtd::event_handler &on_click, const xtd::drawing::image &image, xtd::forms::menu_item_kind kind, bool checked, xtd::forms::shortcut shortcut)
 Initializes a new instance of the class with a specified caption, event handler, image menu item, kind the menu item, checked, and associated shortcut key for the menu item. More...
 
 menu_item (const xtd::ustring &text, const std::vector< menu_item > &items)
 Initializes a new instance of the class with a specified caption and an array of submenu items defined for the menu item. More...
 
bool checked () const
 Gets a value indicating whether a check mark appears next to the text of the menu item. More...
 
menu_itemchecked (bool value)
 Sets a value indicating whether a check mark appears next to the text of the menu item. More...
 
bool enabled () const
 Gets a value indicating whether the menu item is enabled. More...
 
menu_itemenabled (bool value)
 Gets a value indicating whether the menu item is enabled. More...
 
xtd::forms::menu_item_kind kind () const
 Gets a value that represents the kind of menu item. More...
 
menu_itemkind (xtd::forms::menu_item_kind value)
 Gets a value that represents the kind of menu item. More...
 
int32_t menu_id () const
 Gets a value indicating the Windows identifier for this menu item. More...
 
xtd::forms::shortcut shortcut () const
 Gets a value indicating the shortcut key associated with the menu item. More...
 
menu_itemshortcut (xtd::forms::shortcut value)
 Sets a value indicating the shortcut key associated with the menu item. More...
 
const xtd::ustringtext () const
 Gets a value indicating the caption of the menu item. More...
 
menu_itemtext (const xtd::ustring &value)
 Sets a value indicating the caption of the menu item. More...
 
xtd::ustring to_string () const noexcept override
 Returns a string that represents the menu control. More...
 
- Public Member Functions inherited from xtd::forms::menu
std::optional< context_menuget_context_menu () const
 Gets the context_menu that contains this menu. More...
 
std::optional< main_menuget_main_menu () const
 Gets the main_menu that contains this menu. More...
 
intptr_t handle () const
 Gets a value representing the window handle for the menu. More...
 
bool is_parent () const
 Gets a value indicating whether this menu contains any menu items. More...
 
const menu_itemmdi_list_item () const
 Gets a value indicating the menu_item that is used to display a list of multiple document interface (MDI) child forms. More...
 
const menu_item_collectionmenu_items () const
 Gets a value indicating the collection of menu_item objects associated with the menu. More...
 
menu_item_collectionmenu_items ()
 Gets a value indicating the collection of menu_item objects associated with the menu. More...
 
menumenu_items (const menu_item_collection &value)
 Sets a value indicating the collection of menu_item objects associated with the menu. More...
 
virtual void merge_menu (const menu &menu_src)
 Merges the MenuItem objects of one menu with the current menu. More...
 
const xtd::ustringname () const
 Gets the name of the menu. More...
 
menuname (const xtd::ustring &value)
 Sets the name of the menu. More...
 
std::any tag () const
 Gets user-defined data associated with the control. More...
 
menutag (std::any value)
 Sets user-defined data associated with the control. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 

Protected Attributes

friend context_menu
 
friend main_menu
 

Protected Member Functions

intptr_t create_menu_handle () override
 Creates a new handle to the Menu. More...
 
void destroy_menu_handle (intptr_t handle) override
 Destroy the handle to the Menu. More...
 
virtual void on_menu_item_updated (const event_args &e)
 
- Protected Member Functions inherited from xtd::forms::menu
 menu ()
 Initializes a new instance of the Menu class. More...
 
 menu (const menu_item_collection &items)
 Initializes a new instance of the Menu class. More...
 
void clone_menu (const menu &menu_src)
 Copies the menu that is passed as a parameter to the current menu. More...
 
- Protected Member Functions inherited from xtd::forms::component
 component ()=default
 Initialises a new instance of the component class. More...
 
virtual bool can_raise_events () const
 Gets a value indicating whether the component can raise an event. More...
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 

Additional Inherited Members

- Public Types inherited from xtd::forms::menu
using menu_item_collection = layout::arranged_element_collection< menu_item >
 Represents a collection of menu_item objects. More...
 
- Static Public Attributes inherited from xtd::forms::menu
static constexpr const int find_handle = 0
 Specifies that the find_menu_item(int32_t, intptr_t) method should search for a handle. More...
 
static constexpr const int find_shortcut = 1
 Specifies that the find_menu_item(int32_t, intptr_t) method should search for a shortcut. More...
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Constructor & Destructor Documentation

◆ menu_item() [1/26]

xtd::forms::menu_item::menu_item ( )

Initializes a menu_item with a blank caption.

Remarks
Once you have created a blank menu_item using this constructor, you can use the properties and methods of the menu_item class to specify the appearance and behavior of your menu_item.

◆ menu_item() [2/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text)

Initializes a new instance of the menu_item class with a specified caption for the menu item.

Parameters
textThe caption for the menu item.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [3/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [4/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::drawing::image image 
)

Initializes a new instance of the class with a specified caption, and image menu item.

Parameters
textThe caption for the menu item.
imageA xtd::drawing::image menu item.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [5/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::drawing::image image,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, and image menu item, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
imageA xtd::drawing::image menu item.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [6/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
xtd::forms::menu_item_kind  kind 
)

Initializes a new instance of the class with a specified caption, and kind the menu item.

Parameters
textThe caption for the menu item.
kindOne of the xtd::forms::menu_item_kind value.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [7/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
xtd::forms::menu_item_kind  kind,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, kind the menu item, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
kindOne of the xtd::forms::menu_item_kind value.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [8/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind 
)

Initializes a new instance of the class with a specified caption, image menu item, and kind the menu item.

Parameters
textThe caption for the menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [9/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, image menu item, kind the menu item, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [10/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
xtd::forms::menu_item_kind  kind,
bool  checked 
)

Initializes a new instance of the class with a specified caption, kind the menu item and checked.

Parameters
textThe caption for the menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [11/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
xtd::forms::menu_item_kind  kind,
bool  checked,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, kind the menu item, checked, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [12/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind,
bool  checked 
)

Initializes a new instance of the class with a specified caption, image menu item, kind the menu item, and checked.

Parameters
textThe caption for the menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [13/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind,
bool  checked,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, image menu item, kind the menu item, checked, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [14/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click 
)

Initializes a new instance of the class with a specified caption and event handler for the Click event of the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [15/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, event handler, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [16/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
const xtd::drawing::image image 
)

Initializes a new instance of the class with a specified caption, event handler, and image menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
imageA xtd::drawing::image menu item.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [17/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
const xtd::drawing::image image,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, event handler, and image menu item, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
imageA xtd::drawing::image menu item.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [18/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
xtd::forms::menu_item_kind  kind 
)

Initializes a new instance of the class with a specified caption, event handler, and kind the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
kindOne of the xtd::forms::menu_item_kind value.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [19/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
xtd::forms::menu_item_kind  kind,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, event handler, kind the menu item, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
kindOne of the xtd::forms::menu_item_kind value.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [20/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind 
)

Initializes a new instance of the class with a specified caption, event handler, image menu item, and kind the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [21/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, event handler, image menu item, kind the menu item, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [22/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
xtd::forms::menu_item_kind  kind,
bool  checked 
)

Initializes a new instance of the class with a specified caption, event handler, kind the menu item and checked.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [23/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
xtd::forms::menu_item_kind  kind,
bool  checked,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, event handler, kind the menu item, checked, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [24/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind,
bool  checked 
)

Initializes a new instance of the class with a specified caption, event handler, image menu item, kind the menu item, and checked.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [25/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const xtd::event_handler on_click,
const xtd::drawing::image image,
xtd::forms::menu_item_kind  kind,
bool  checked,
xtd::forms::shortcut  shortcut 
)

Initializes a new instance of the class with a specified caption, event handler, image menu item, kind the menu item, checked, and associated shortcut key for the menu item.

Parameters
textThe caption for the menu item.
on_clickThe event_handler that handles the Click event for this menu item.
imageA xtd::drawing::image menu item.
kindOne of the xtd::forms::menu_item_kind value.
checkedtrue if there is a check mark next to the menu item; otherwise, false. The default is false.
shortcutOne of the xtd::forms::shortcut values.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ menu_item() [26/26]

xtd::forms::menu_item::menu_item ( const xtd::ustring text,
const std::vector< menu_item > &  items 
)

Initializes a new instance of the class with a specified caption and an array of submenu items defined for the menu item.

Parameters
textThe caption for the menu item.
itemsAn array of menu_item objects that contains the submenu items for this menu item.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.
The items parameter enables you to assign an array of menu items to define a submenu of this menu item. Each item in the array can also have an array of menu items assigned to it. This enables you to create complete menu structures and assign them to the constructor for the menu item.

Member Function Documentation

◆ checked() [1/2]

bool xtd::forms::menu_item::checked ( ) const
inline

Gets a value indicating whether a check mark appears next to the text of the menu item.

Returns
true if there is a check mark next to the menu item; otherwise, false. The default is false.

◆ checked() [2/2]

menu_item& xtd::forms::menu_item::checked ( bool  value)
inline

Sets a value indicating whether a check mark appears next to the text of the menu item.

Parameters
valuetrue if there is a check mark next to the menu item; otherwise, false. The default is false.
Returns
Current menu_item.

◆ create_menu_handle()

intptr_t xtd::forms::menu_item::create_menu_handle ( )
overrideprotectedvirtual

Creates a new handle to the Menu.

Returns
A handle to the menu if the method succeeds; otherwise, 0.

Implements xtd::forms::menu.

◆ destroy_menu_handle()

void xtd::forms::menu_item::destroy_menu_handle ( intptr_t  handle)
overrideprotectedvirtual

Destroy the handle to the Menu.

Parameters
handleA handle to the menu.

Implements xtd::forms::menu.

◆ enabled() [1/2]

bool xtd::forms::menu_item::enabled ( ) const
inline

Gets a value indicating whether the menu item is enabled.

Returns
true if the menu item is enabled; otherwise, false. The default is true.

◆ enabled() [2/2]

menu_item& xtd::forms::menu_item::enabled ( bool  value)
inline

Gets a value indicating whether the menu item is enabled.

Parameters
valuetrue if the menu item is enabled; otherwise, false. The default is true.
Returns
Current menu_item.

◆ kind() [1/2]

xtd::forms::menu_item_kind xtd::forms::menu_item::kind ( ) const
inline

Gets a value that represents the kind of menu item.

Returns
One of the xtd::forms::menu_item_kind value.

◆ kind() [2/2]

menu_item& xtd::forms::menu_item::kind ( xtd::forms::menu_item_kind  value)
inline

Gets a value that represents the kind of menu item.

Parameters
valueOne of the xtd::forms::menu_item_kind value.
Returns
Current menu_item.

◆ menu_id()

int32_t xtd::forms::menu_item::menu_id ( ) const

Gets a value indicating the Windows identifier for this menu item.

Returns
The Windows identifier for this menu item.

◆ shortcut() [1/2]

xtd::forms::shortcut xtd::forms::menu_item::shortcut ( ) const
inline

Gets a value indicating the shortcut key associated with the menu item.

Returns
One of the xtd::forms::shortcut values. The default is xtd::forms::shortcut::none.

◆ shortcut() [2/2]

menu_item& xtd::forms::menu_item::shortcut ( xtd::forms::shortcut  value)
inline

Sets a value indicating the shortcut key associated with the menu item.

Parameters
valueOne of the xtd::forms::shortcut values. The default is xtd::forms::shortcut::none.
Returns
Current menu_item.

◆ text() [1/2]

const xtd::ustring& xtd::forms::menu_item::text ( ) const
inline

Gets a value indicating the caption of the menu item.

Returns
The text caption of the menu item.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ text() [2/2]

menu_item& xtd::forms::menu_item::text ( const xtd::ustring value)
inline

Sets a value indicating the caption of the menu item.

Parameters
valueThe text caption of the menu item.
Returns
Current menu_item.
Remarks
When you specify a caption for your menu item with the text parameter, you can also specify an access key by placing an '&' before the character to be used as the access key. For example, to specify the "F" in "File" as an access key, you would specify the caption for the menu item as "&File". You can use this feature to provide keyboard navigation for your menus.
Setting the text parameter to "-" causes your menu item to be displayed as a separator (a horizontal line) rather than a standard menu item.

◆ to_string()

xtd::ustring xtd::forms::menu_item::to_string ( ) const
overridevirtualnoexcept

Returns a string that represents the menu control.

Returns
A string that represents the current menu.
Remarks
The to_string method returns a string that includes the type and the number of items in the menu_items property of the control.

Reimplemented from xtd::forms::menu.


The documentation for this class was generated from the following file: