NXOpen .NET Reference  12.0.0
Classes | Public Member Functions | Properties | List of all members
NXOpen.UIStyler.ToolPalette Class Reference

Represents a ToolPalette for UI Styler More...

Inheritance diagram for NXOpen.UIStyler.ToolPalette:
NXOpen.UIStyler.StylerItem

Classes

class  _ToolPaletteActivateAdapter
 

Public Member Functions

delegate
NXOpen.UIStyler.DialogState 
Activate (NXOpen.UIStyler.StylerEvent eventobject)
 Called when a dialog user selects a button in the tool palette. More...
 
unsafe void AddActivateHandler (NXOpen.UIStyler.ToolPalette.Activate activateevent, bool isDialogLaunchingEvent)
 Registers activate callback. More...
 
unsafe void SetLabel (string strLabel)
 Specifies descriptive text to display for the dialog item. More...
 
unsafe void SetSensitivity (int subitemIndex, bool type)
  More...
 
unsafe bool GetSensitivity ()
 Gets the sensitivity of the dialog item More...
 
unsafe void SetDefault (int dialogId)
 Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button. More...
 
- Public Member Functions inherited from NXOpen.UIStyler.StylerItem
unsafe
NXOpen.UIStyler.StylerItem.ItemType 
GetItemType ()
 Gets the dialog item type. More...
 
unsafe NXOpen.UIStyler.Attachment InitializeAttachment ()
 Returns initialized dialog item attachment information More...
 
unsafe void SetAttachment (NXOpen.UIStyler.Attachment attachment)
 Specifies the updated dialog item attachment information More...
 
unsafe bool IsEqualTo (NXOpen.UIStyler.StylerItem itemToCompare)
 Equates two styler items More...
 

Properties

unsafe int ItemValue [get, set]
 Returns or sets the currently selected choice for this dialog item. More...
 
unsafe bool Visibility [get, set]
 Returns or sets the visibility of the dialog item More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.UIStyler.StylerItem
enum  ItemType {
  InvalidType = -1, ActionButton, Dialog, RadioBox,
  Real, ScaleReal, Bitmap, RowColumn,
  ButtonLayout, ScrolledWindow, ColorTool, SelectionBox,
  Separator, SingleSelectionList, String, BeginGroup,
  Integer, ScaleInteger, MultiList, Label,
  MultiLineText, TabControl, OptionMenu, Toggle,
  OptionToggle, ToolPalette, WideString, PropertyPage,
  CollapsibleGroup
}
 Describes kind of action to be taken from callbac. More...
 
- Protected Member Functions inherited from NXOpen.UIStyler.StylerItem
override void FreeResource ()
 Free resources associated with the instance. More...
 

Detailed Description

Represents a ToolPalette for UI Styler

Created in NX5.0.0

Member Function Documentation

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.ToolPalette.Activate ( NXOpen.UIStyler.StylerEvent  eventobject)

Called when a dialog user selects a button in the tool palette.

Created in NX5.0.0

License requirements: None.

Parameters
eventobjectEvent object
unsafe void NXOpen.UIStyler.ToolPalette.AddActivateHandler ( NXOpen.UIStyler.ToolPalette.Activate  activateevent,
bool  isDialogLaunchingEvent 
)

Registers activate callback.

This method should be called before calling UIStyler.Dialog.Show or UIStyler.Dialog.RegisterWithUiMenu

Created in NX5.0.0

License requirements: None.

Parameters
activateevent
isDialogLaunchingEvent
unsafe bool NXOpen.UIStyler.ToolPalette.GetSensitivity ( )

Gets the sensitivity of the dialog item

Created in NX5.0.0

License requirements: None.

Returns
True if sensitivity is set otherwise False
unsafe void NXOpen.UIStyler.ToolPalette.SetDefault ( int  dialogId)

Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button.

When you set this attribute, a click on the second mouse button triggers this dialog item's Activate callback instead of the action of the OK button.

Created in NX5.0.0

License requirements: None.

Parameters
dialogId
unsafe void NXOpen.UIStyler.ToolPalette.SetLabel ( string  strLabel)

Specifies descriptive text to display for the dialog item.

It should describe the dialog item's intended use.

Created in NX5.0.0

License requirements: None.

Parameters
strLabelString label
unsafe void NXOpen.UIStyler.ToolPalette.SetSensitivity ( int  subitemIndex,
bool  type 
)

Created in NX5.0.0

License requirements: None.

Parameters
subitemIndexSub item index
typeTrue if sentivity is set otherwise False

Property Documentation

unsafe int NXOpen.UIStyler.ToolPalette.ItemValue
getset

Returns or sets the currently selected choice for this dialog item.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.UIStyler.ToolPalette.Visibility
getset

Returns or sets the visibility of the dialog item

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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