xtd::forms::context_menu Class Reference

#include <context_menu.h>

Definition

Represents a shortcut menu.

Namespace

xtd::forms

Library

xtd.forms

Public Member Functions
	context_menu ()
	Initialize context_menu class. More...
Public Member Functions inherited from xtd::forms::menu
std::optional< context_menu >	get_context_menu () const
	Gets the context_menu that contains this menu. More...
std::optional< main_menu >	get_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_item &	mdi_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_collection &	menu_items () const
	Gets a value indicating the collection of menu_item objects associated with the menu. More...
menu_item_collection &	menu_items ()
	Gets a value indicating the collection of menu_item objects associated with the menu. More...
menu &	menu_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::ustring &	name () const
	Gets the name of the menu. More...
menu &	name (const xtd::ustring &value)
	Sets the name of the menu. More...
std::any	tag () const
	Gets user-defined data associated with the control. More...
menu &	tag (std::any value)
	Sets user-defined data associated with the control. More...
xtd::ustring	to_string () const noexcept override
	Returns a string that represents the menu 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 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...
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

context_menu()

xtd::forms::context_menu::context_menu

(

)

Initialize context_menu class.

Member Function Documentation

create_menu_handle()

intptr_t xtd::forms::context_menu::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::context_menu::destroy_menu_handle ( intptr_t  handle )

overrideprotectedvirtual

Destroy the handle to the Menu.

Parameters

handle

A handle to the menu.

Implements xtd::forms::menu.

---

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

• xtd.forms/include/xtd/forms/context_menu.h