NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::MenuBar::ContextMenuEntry Class Reference

Represents an entry on a context menu. More...

Inheritance diagram for NXOpen::MenuBar::ContextMenuEntry:
NXOpen::TransientObject

Public Types

enum  Type {
  TypeSubmenu, TypePushButton, TypeToggleButton, TypeSeparator,
  TypeLabel
}
 Specifies the type of the menu entry. More...
 

Public Member Functions

NXOpen::MenuBar::ContextMenuEntry::Type EntryType ()
 Returns the type of this menu entry. More...
 
bool IsDefault ()
 Returns true if this entry is the default action for the menu. More...
 
bool IsHidden ()
 Returns true if this entry is hidden on the menu. More...
 
bool IsSensitive ()
 Returns true if the command corresponding to this entry can be run. More...
 
NXString Label ()
 Returns the label of this menu entry. More...
 
NXString Name ()
 Returns the name of this menu entry. More...
 
virtual ~ContextMenuEntry ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents an entry on a context menu.


Created in NX8.5.0.

Member Enumeration Documentation

Specifies the type of the menu entry.

Enumerator
TypeSubmenu 

Has an attached menu structure containing more entries.

TypePushButton 

Has a command that is run when this entry is activated.

TypeToggleButton 

Displays an On/Off state.

TypeSeparator 

A visual divider between sections of the menu.

TypeLabel 

A label often used to divide and provide context to sub-groups of commands.

Constructor & Destructor Documentation

virtual NXOpen::MenuBar::ContextMenuEntry::~ContextMenuEntry ( )
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::Type NXOpen::MenuBar::ContextMenuEntry::EntryType ( )

Returns the type of this menu entry.


Created in NX8.5.0.

License requirements : None

bool NXOpen::MenuBar::ContextMenuEntry::IsDefault ( )

Returns true if this entry is the default action for the menu.

A menu entry is marked as the default for the menu when it corresponds to the double-click action.


Created in NX8.5.0.

License requirements : None

bool NXOpen::MenuBar::ContextMenuEntry::IsHidden ( )

Returns true if this entry is hidden on the menu.


Created in NX8.5.0.

License requirements : None

bool NXOpen::MenuBar::ContextMenuEntry::IsSensitive ( )

Returns true if the command corresponding to this entry can be run.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::MenuBar::ContextMenuEntry::Label ( )

Returns the label of this menu entry.


Created in NX8.5.0.

License requirements : None

NXString NXOpen::MenuBar::ContextMenuEntry::Name ( )

Returns the name of this menu entry.

Some entries on the context menu may correspond to buttons on the menu bar. For these entries, the name that is returned is the name of that MenuBar::MenuButton object.

For all other entries which do not correspond to a menu bar button, the name that is returned has no specific meaning. However, for any individual action within any specific context menu, the name that is assigned to that action will not change.


Created in NX8.5.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.