Represents a Context Menu
Created in NX8.5.0. More...

Inheritance diagram for NXOpen::MenuBar::ContextMenu:

Public Member Functions
NXOpen::MenuBar::ContextMenuEntry *	AddMenuButton (NXOpen::MenuBar::MenuButton *button, int index)
	Adds a menu bar button to the context menu.

void	AddSeparator (int index)
	Adds a separator to the context menu.

NXOpen::MenuBar::ContextMenu *	AddSubmenu (const NXString &label, int index)
	Adds a submenu to the context menu.

NXOpen::MenuBar::ContextMenu *	AddSubmenu (const char *label, int index)
	Adds a submenu to the context menu.

NXOpen::MenuBar::ContextMenuEntry *	GetEntry (int index)
	Returns the MenuBar::ContextMenuEntry at the specified index in the menu.

NXOpen::MenuBar::ContextMenuEntry *	GetEntryWithName (const NXString &name)
	Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches.

NXOpen::MenuBar::ContextMenuEntry *	GetEntryWithName (const char *name)
	Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches.

int	GetIndexOfEntry (NXOpen::MenuBar::ContextMenuEntry *entry)
	Returns the index of the MenuBar::ContextMenuEntry object within this menu.

NXOpen::MenuBar::ContextMenu *	GetSubmenu (int index)
	Returns the submenu for the entry at the specified index in the menu.

bool	HasEntryWithName (const NXString &name)
	Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name.

bool	HasEntryWithName (const char *name)
	Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name.

void	HideEntry (NXOpen::MenuBar::ContextMenuEntry *entry)
	Prevents the indicated menu entry from being shown on the menu.

void	MoveEntry (NXOpen::MenuBar::ContextMenuEntry *entry, int index)
	Reorders the menu to move a menu entry to a new position in the list.

int	NumberOfEntries ()
	Returns the number of MenuBar::ContextMenuEntry objects in this menu.

void	SetDefaultEntry (NXOpen::MenuBar::ContextMenuEntry *entry)
	Makes a specified menu entry the default for the menu.

virtual	~ContextMenu ()
	Frees the object from memory.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

Represents a Context Menu
Created in NX8.5.0.

Constructor & Destructor Documentation

virtual NXOpen::MenuBar::ContextMenu::~ContextMenu ( )

virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX8.5.0.

License requirements : None

Member Function Documentation

NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::AddMenuButton	(	NXOpen::MenuBar::MenuButton *	button,
		int	index
	)

Adds a menu bar button to the context menu.

Use MenuBar::MenuBarManager::GetButtonFromName to find the button to add to the menu.

Returns: the new menu entry
Created in NX8.5.0.

License requirements : None

Parameters

button	the menu bar button to add to the menu
index	position at which to create the new button. Use -1 to add the button to the end of the menu.

void NXOpen::MenuBar::ContextMenu::AddSeparator ( int index )

Adds a separator to the context menu.

Created in NX8.5.0.

License requirements : None

Parameters

index position at which to create the separator. Use -1 to add the separator to the end of the menu.

NXOpen::MenuBar::ContextMenu* NXOpen::MenuBar::ContextMenu::AddSubmenu	(	const NXString &	label,
		int	index
	)

Adds a submenu to the context menu.

Returns: the new submenu
Created in NX8.5.0.

License requirements : None

Parameters

label	label for the cascade menu
index	position at which to create the sub-menu. Use -1 to add the sub-menu to the end of the menu.

NXOpen::MenuBar::ContextMenu* NXOpen::MenuBar::ContextMenu::AddSubmenu	(	const char *	label,
		int	index
	)

Adds a submenu to the context menu.

Returns: the new submenu
Created in NX8.5.0.

License requirements : None

Parameters

label	label for the cascade menu
index	position at which to create the sub-menu. Use -1 to add the sub-menu to the end of the menu.

NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::GetEntry ( int index )

Returns the MenuBar::ContextMenuEntry at the specified index in the menu.

Returns: the menu entry at this position
Created in NX8.5.0.

License requirements : None

Parameters

index index of menu entry to return

NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::GetEntryWithName ( const NXString & name )

Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches.

    @return  the menu entry with this name

Created in NX8.5.0.

License requirements : None

Parameters

name	name of menu entry to search for NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::MenuBar::ContextMenuEntry* NXOpen::MenuBar::ContextMenu::GetEntryWithName ( const char * name )

Given the name of a menu entry, returns the first MenuBar::ContextMenuEntry in this menu which matches.

    @return  the menu entry with this name

Created in NX8.5.0.

License requirements : None

Parameters

name	name of menu entry to search for NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::MenuBar::ContextMenu::GetIndexOfEntry ( NXOpen::MenuBar::ContextMenuEntry * entry )

Returns the index of the MenuBar::ContextMenuEntry object within this menu.

    @return  the index for that menu entry

Created in NX8.5.0.

License requirements : None

Parameters

entry an entry in the menu

NXOpen::MenuBar::ContextMenu* NXOpen::MenuBar::ContextMenu::GetSubmenu ( int index )

Returns the submenu for the entry at the specified index in the menu.

       The menu entry at this index must be of type 
       @link MenuBar::ContextMenuEntry::TypeSubmenu MenuBar::ContextMenuEntry::TypeSubmenu@endlink .
     @return  the submenu at this position

Created in NX8.5.0.

License requirements : None

Parameters

index index of submenu to return

bool NXOpen::MenuBar::ContextMenu::HasEntryWithName ( const NXString & name )

Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name.

    @return  the menu entry with this name

Created in NX8.5.0.

License requirements : None

Parameters

name	name of menu entry to search for NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::MenuBar::ContextMenu::HasEntryWithName ( const char * name )

Indicates whether or not this menu contains a MenuBar::ContextMenuEntry which has the given name.

    @return  the menu entry with this name

Created in NX8.5.0.

License requirements : None

Parameters

name	name of menu entry to search for NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::MenuBar::ContextMenu::HideEntry ( NXOpen::MenuBar::ContextMenuEntry * entry )

Prevents the indicated menu entry from being shown on the menu.

Created in NX8.5.0.

License requirements : None

Parameters

entry the menu entry to hide

void NXOpen::MenuBar::ContextMenu::MoveEntry	(	NXOpen::MenuBar::ContextMenuEntry *	entry,
		int	index
	)

Reorders the menu to move a menu entry to a new position in the list.

Created in NX8.5.0.

License requirements : None

Parameters

entry	the menu entry to be moved
index	the new position

int NXOpen::MenuBar::ContextMenu::NumberOfEntries ( )

Returns the number of MenuBar::ContextMenuEntry objects in this menu.

Created in NX8.5.0.

License requirements : None

void NXOpen::MenuBar::ContextMenu::SetDefaultEntry ( NXOpen::MenuBar::ContextMenuEntry * entry )

Makes a specified menu entry the default for the menu.

       This entry will be displayed in bold text on the menu. It will be the action
       that is performed in response to a double-click event in the UI.

       The menu entry must have a type of @link MenuBar::ContextMenuEntry::TypePushButton MenuBar::ContextMenuEntry::TypePushButton@endlink 
       or @link MenuBar::ContextMenuEntry::TypeToggleButton MenuBar::ContextMenuEntry::TypeToggleButton@endlink .

Created in NX8.5.0.

License requirements : None

Parameters

entry the menu entry to become the default for the menu

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

MenuBar_ContextMenu.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation