NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | List of all members
NXOpen.BlockStyler.TreeListMenu Class Reference

Represents a menu class utilized by BlockStyler.Tree . More...

Inheritance diagram for NXOpen.BlockStyler.TreeListMenu:

Public Member Functions

unsafe void AddMenuItem (int menuItemID, string menuItemText)
 Adds single menu item More...
 
unsafe void AddMenuItem (int menuItemID, string menuItemText, string icon)
 Adds single menu item More...
 
unsafe void AddSeperator ()
 Adds a separator More...
 
unsafe void AddSeparator ()
 Adds a separator More...
 
unsafe void SetSubMenu (int menuItemID, NXOpen.BlockStyler.TreeListMenu subMenu)
 Sets a submenu. More...
 
unsafe bool GetItemChecked (int menuItemID)
 Gets the checked status for given menu item More...
 
unsafe void SetItemChecked (int menuItemID, bool checkedStatusStatus)
 Sets the checked status for given menu item More...
 
unsafe bool GetItemDisable (int menuItemID)
 Gets the flag indicating whether the given menu item is disabled More...
 
unsafe void SetItemDisable (int menuItemID, bool disableStatus)
 Sets the flag indicating whether the given menu item is disabled More...
 
unsafe bool GetItemDefault (int menuItemID)
 Gets the flag indicating whether the given menu item is default More...
 
unsafe void SetItemDefault (int menuItemID, bool defaultStatus)
 Sets the flag indicating whether the given menu item is default More...
 
unsafe bool GetItemHidden (int menuItemID)
 Gets the flag indicating whether the given menu item is hidden More...
 
unsafe void SetItemHidden (int menuItemID, bool hiddenStatus)
 Sets the flag indicating whether the given menu item is hidden More...
 
unsafe bool GetItemDialogLaunching (int menuItemID)
 Gets the flag indicating whether the given menu item is dialog lanching More...
 
unsafe void SetItemDialogLaunching (int menuItemID, bool dialogLaunchingStaus)
 Sets the flag indicating whether the given menu item is dialog lanching More...
 
unsafe string GetItemIcon (int menuItemID)
 Gets the icon for given menu item More...
 
unsafe void SetItemIcon (int menuItemID, string icon)
 Sets the icon for given menu item More...
 
unsafe string GetItemText (int menuItemID)
 Gets the display text for given menu item More...
 
unsafe void SetItemText (int menuItemID, string text)
 Sets the display text for given menu item More...
 

Protected Member Functions

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

Detailed Description

Represents a menu class utilized by BlockStyler.Tree .

Refer to BlockStyler.Tree.CreateMenu to create the menu.

Created in NX7.5.0

Member Function Documentation

unsafe void NXOpen.BlockStyler.TreeListMenu.AddMenuItem ( int  menuItemID,
string  menuItemText 
)

Adds single menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDUnique identifier for the menu item being added
menuItemTextDisplay text for menu item being added
unsafe void NXOpen.BlockStyler.TreeListMenu.AddMenuItem ( int  menuItemID,
string  menuItemText,
string  icon 
)

Adds single menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDUnique identifier for the menu item being added
menuItemTextDisplay text for menu item being added
iconIcon for menu item being added
unsafe void NXOpen.BlockStyler.TreeListMenu.AddSeparator ( )

Adds a separator

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.BlockStyler.TreeListMenu.AddSeperator ( )

Adds a separator

Created in NX7.5.0

Deprecated in NX11.0.0. Use BlockStyler.TreeListMenu.AddSeparator instead.

License requirements: None.

override void NXOpen.BlockStyler.TreeListMenu.FreeResource ( )
protected

Frees the object from memory.

After this method is called, it is illegal to use the object.

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.BlockStyler.TreeListMenu.GetItemChecked ( int  menuItemID)

Gets the checked status for given menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
Returns
Status
unsafe bool NXOpen.BlockStyler.TreeListMenu.GetItemDefault ( int  menuItemID)

Gets the flag indicating whether the given menu item is default

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
Returns
Status
unsafe bool NXOpen.BlockStyler.TreeListMenu.GetItemDialogLaunching ( int  menuItemID)

Gets the flag indicating whether the given menu item is dialog lanching

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
Returns
Status
unsafe bool NXOpen.BlockStyler.TreeListMenu.GetItemDisable ( int  menuItemID)

Gets the flag indicating whether the given menu item is disabled

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
Returns
Status
unsafe bool NXOpen.BlockStyler.TreeListMenu.GetItemHidden ( int  menuItemID)

Gets the flag indicating whether the given menu item is hidden

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
Returns
Status
unsafe string NXOpen.BlockStyler.TreeListMenu.GetItemIcon ( int  menuItemID)

Gets the icon for given menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
Returns
Display text
unsafe string NXOpen.BlockStyler.TreeListMenu.GetItemText ( int  menuItemID)

Gets the display text for given menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
Returns
Display text
unsafe void NXOpen.BlockStyler.TreeListMenu.SetItemChecked ( int  menuItemID,
bool  checkedStatusStatus 
)

Sets the checked status for given menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
checkedStatusStatusStatus
unsafe void NXOpen.BlockStyler.TreeListMenu.SetItemDefault ( int  menuItemID,
bool  defaultStatus 
)

Sets the flag indicating whether the given menu item is default

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
defaultStatusStatus
unsafe void NXOpen.BlockStyler.TreeListMenu.SetItemDialogLaunching ( int  menuItemID,
bool  dialogLaunchingStaus 
)

Sets the flag indicating whether the given menu item is dialog lanching

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
dialogLaunchingStausStatus
unsafe void NXOpen.BlockStyler.TreeListMenu.SetItemDisable ( int  menuItemID,
bool  disableStatus 
)

Sets the flag indicating whether the given menu item is disabled

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
disableStatusStatus
unsafe void NXOpen.BlockStyler.TreeListMenu.SetItemHidden ( int  menuItemID,
bool  hiddenStatus 
)

Sets the flag indicating whether the given menu item is hidden

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
hiddenStatusStatus
unsafe void NXOpen.BlockStyler.TreeListMenu.SetItemIcon ( int  menuItemID,
string  icon 
)

Sets the icon for given menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
iconDisplay text
unsafe void NXOpen.BlockStyler.TreeListMenu.SetItemText ( int  menuItemID,
string  text 
)

Sets the display text for given menu item

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu-item ID
textDisplay text
unsafe void NXOpen.BlockStyler.TreeListMenu.SetSubMenu ( int  menuItemID,
NXOpen.BlockStyler.TreeListMenu  subMenu 
)

Sets a submenu.

Submenu can be created using BlockStyler.Tree.CreateMenu method

Created in NX7.5.0

License requirements: None.

Parameters
menuItemIDMenu Item ID of menu item on which submenu is supposed to be set.
subMenuMenu to be added as submenu

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