NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.MenuBar.ContextMenu Class Reference

Represents a Context Menu More...

Inheritance diagram for NXOpen.MenuBar.ContextMenu:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe
NXOpen.MenuBar.ContextMenuEntry 
AddMenuButton (NXOpen.MenuBar.MenuButton button, int index)
 Adds a menu bar button to the context menu. More...
 
unsafe
NXOpen.MenuBar.ContextMenuEntry 
AddMenuLabel (string label, int index)
 Adds a label to the context menu. More...
 
unsafe void AddSeparator (int index)
 Adds a separator to the context menu. More...
 
unsafe NXOpen.MenuBar.ContextMenu AddSubmenu (string label, int index)
 Adds a submenu to the context menu. More...
 
unsafe
NXOpen.MenuBar.ContextMenuEntry 
GetEntry (int index)
 Returns the MenuBar.ContextMenuEntry at the specified index in the menu. More...
 
unsafe
NXOpen.MenuBar.ContextMenuEntry 
GetEntryWithName (string name)
 Given the name of a menu entry, returns the first MenuBar.ContextMenuEntry in this menu which matches. More...
 
unsafe int GetIndexOfEntry (NXOpen.MenuBar.ContextMenuEntry entry)
 Returns the index of the MenuBar.ContextMenuEntry object within this menu. More...
 
unsafe NXOpen.MenuBar.ContextMenu GetSubmenu (int index)
 Returns the submenu for the entry at the specified index in the menu. More...
 
unsafe bool HasEntryWithName (string name)
 Indicates whether or not this menu contains a MenuBar.ContextMenuEntry which has the given name. More...
 
unsafe void HideEntry (NXOpen.MenuBar.ContextMenuEntry entry)
 Prevents the indicated menu entry from being shown on the menu. More...
 
unsafe void MoveEntry (NXOpen.MenuBar.ContextMenuEntry entry, int index)
 Reorders the menu to move a menu entry to a new position in the list. More...
 
unsafe void SetDefaultEntry (NXOpen.MenuBar.ContextMenuEntry entry)
 Makes a specified menu entry the default for the menu. More...
 
- 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...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

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

Properties

unsafe int NumberOfEntries [get]
 Returns the number of MenuBar.ContextMenuEntry objects in this menu. 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...
 

Detailed Description

Represents a Context Menu

Created in NX8.5.0

Member Function Documentation

unsafe NXOpen.MenuBar.ContextMenuEntry NXOpen.MenuBar.ContextMenu.AddMenuButton ( NXOpen.MenuBar.MenuButton  button,
int  index 
)
inline

Adds a menu bar button to the context menu.

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

Created in NX8.5.0

License requirements: None.

Parameters
buttonthe menu bar button to add to the menu
indexposition at which to create the new button. Use -1 to add the button to the end of the menu.
Returns
the new menu entry
unsafe NXOpen.MenuBar.ContextMenuEntry NXOpen.MenuBar.ContextMenu.AddMenuLabel ( string  label,
int  index 
)
inline

Adds a label to the context menu.

Created in NX10.0.0

License requirements: None.

Parameters
labellabel for the label entry
indexposition at which to create the label entry. Use -1 to add the label to the end of the menu.
Returns
the new menu entry
unsafe void NXOpen.MenuBar.ContextMenu.AddSeparator ( int  index)
inline

Adds a separator to the context menu.

Created in NX8.5.0

License requirements: None.

Parameters
indexposition at which to create the separator. Use -1 to add the separator to the end of the menu.
unsafe NXOpen.MenuBar.ContextMenu NXOpen.MenuBar.ContextMenu.AddSubmenu ( string  label,
int  index 
)
inline

Adds a submenu to the context menu.

Created in NX8.5.0

License requirements: None.

Parameters
labellabel for the cascade menu
indexposition at which to create the sub-menu. Use -1 to add the sub-menu to the end of the menu.
Returns
the new submenu
override void NXOpen.MenuBar.ContextMenu.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.

unsafe NXOpen.MenuBar.ContextMenuEntry NXOpen.MenuBar.ContextMenu.GetEntry ( int  index)
inline

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

Created in NX8.5.0

License requirements: None.

Parameters
indexindex of menu entry to return
Returns
the menu entry at this position
unsafe NXOpen.MenuBar.ContextMenuEntry NXOpen.MenuBar.ContextMenu.GetEntryWithName ( string  name)
inline

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

Created in NX8.5.0

License requirements: None.

Parameters
namename of menu entry to search for
Returns
the menu entry with this name
unsafe int NXOpen.MenuBar.ContextMenu.GetIndexOfEntry ( NXOpen.MenuBar.ContextMenuEntry  entry)
inline

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

Created in NX8.5.0

License requirements: None.

Parameters
entryan entry in the menu
Returns
the index for that menu entry
unsafe NXOpen.MenuBar.ContextMenu NXOpen.MenuBar.ContextMenu.GetSubmenu ( int  index)
inline

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

The menu entry at this index must be of type MenuBar.ContextMenuEntry.Type.Submenu .

Created in NX8.5.0

License requirements: None.

Parameters
indexindex of submenu to return
Returns
the submenu at this position
unsafe bool NXOpen.MenuBar.ContextMenu.HasEntryWithName ( string  name)
inline

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

Created in NX8.5.0

License requirements: None.

Parameters
namename of menu entry to search for
Returns
the menu entry with this name
unsafe void NXOpen.MenuBar.ContextMenu.HideEntry ( NXOpen.MenuBar.ContextMenuEntry  entry)
inline

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

Created in NX8.5.0

License requirements: None.

Parameters
entrythe menu entry to hide
unsafe void NXOpen.MenuBar.ContextMenu.MoveEntry ( NXOpen.MenuBar.ContextMenuEntry  entry,
int  index 
)
inline

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

Created in NX8.5.0

License requirements: None.

Parameters
entrythe menu entry to be moved
indexthe new position
unsafe void NXOpen.MenuBar.ContextMenu.SetDefaultEntry ( NXOpen.MenuBar.ContextMenuEntry  entry)
inline

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 MenuBar.ContextMenuEntry.Type.PushButton or MenuBar.ContextMenuEntry.Type.ToggleButton .

Created in NX8.5.0

License requirements: None.

Parameters
entrythe menu entry to become the default for the menu

Property Documentation

unsafe int NXOpen.MenuBar.ContextMenu.NumberOfEntries
get

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

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.