NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Protected Member Functions | Properties | 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 NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Types

enum  Type {
  Submenu, PushButton, ToggleButton, Separator,
  Label
}
 Specifies the type of the menu entry. More...
 

Protected Member Functions

override void FreeResource ()
 Frees the object from memory. More...
 

Properties

unsafe
NXOpen.MenuBar.ContextMenuEntry.Type 
EntryType [get]
 Returns the type of this menu entry. More...
 
unsafe bool IsDefault [get]
 Returns true if this entry is the default action for the menu. More...
 
unsafe bool IsHidden [get]
 Returns true if this entry is hidden on the menu. More...
 
unsafe bool IsSensitive [get]
 Returns true if the command corresponding to this entry can be run. More...
 
unsafe string Label [get]
 Returns the label of this menu entry. More...
 
unsafe string Name [get]
 Returns the name of this menu entry. More...
 
- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new string ToString ()
 Returns a String that represents the current 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
Submenu 

Has an attached menu structure containing more entries.

PushButton 

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

ToggleButton 

Displays an On/Off state.

Separator 

A visual divider between sections of the menu.

Label 

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

Member Function Documentation

override void NXOpen.MenuBar.ContextMenuEntry.FreeResource ( )
inlineprotectedvirtual

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.

Implements NXOpen.TransientObject.

Property Documentation

unsafe NXOpen.MenuBar.ContextMenuEntry.Type NXOpen.MenuBar.ContextMenuEntry.EntryType
get

Returns the type of this menu entry.

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.MenuBar.ContextMenuEntry.IsDefault
get

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.

unsafe bool NXOpen.MenuBar.ContextMenuEntry.IsHidden
get

Returns true if this entry is hidden on the menu.

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.MenuBar.ContextMenuEntry.IsSensitive
get

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

Created in NX8.5.0

License requirements: None.

unsafe string NXOpen.MenuBar.ContextMenuEntry.Label
get

Returns the label of this menu entry.

Created in NX8.5.0

License requirements: None.

unsafe string NXOpen.MenuBar.ContextMenuEntry.Name
get

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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.