NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Member Functions | Properties | List of all members
NXOpen.UIStyler.Toggle Class Reference

Represents a Toggle for UI Styler. More...

Inheritance diagram for NXOpen.UIStyler.Toggle:
NXOpen.UIStyler.StylerItem NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Classes

class  _ToggleValueChangedAdapter
 

Public Member Functions

unsafe void AddValueChangedHandler (NXOpen.UIStyler.Toggle.ValueChanged valuechangedevent, bool isDialogLaunchingEvent)
 Registers value change callback. More...
 
unsafe bool GetSensitivity ()
 Gets the sensitivity More...
 
unsafe void SetDefaultAction ()
 Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button. More...
 
unsafe void SetFocus ()
 Indicates that this dialog item is receiving keyboard focus. More...
 
unsafe void SetLabel (string strLabel)
 Sets the label to display on the right side of the toggle button. More...
 
unsafe void SetSensitivity (int subitemIndex, bool type)
 Sets the sensitivity of the toggle button More...
 
delegate
NXOpen.UIStyler.DialogState 
ValueChanged (NXOpen.UIStyler.StylerEvent eventobject)
 Called when a dialog user clicks on the button or presses the spacebar when the button has keyboard focus. 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 bool IsEqualTo (NXOpen.UIStyler.StylerItem itemToCompare)
 Equates two styler items More...
 
unsafe void SetAttachment (NXOpen.UIStyler.Attachment attachment)
 Specifies the updated dialog item attachment information 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...
 

Properties

unsafe bool ItemValue [get, set]
 Returns or sets an item value More...
 
unsafe bool Visibility [get, set]
 Returns or sets the visibility of the toggle 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 Toggle for UI Styler.

Created in NX5.0.0

Member Function Documentation

unsafe void NXOpen.UIStyler.Toggle.AddValueChangedHandler ( NXOpen.UIStyler.Toggle.ValueChanged  valuechangedevent,
bool  isDialogLaunchingEvent 
)
inline

Registers value change callback.

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

Created in NX5.0.0

License requirements: None.

Parameters
valuechangedeventValue changed event
isDialogLaunchingEventTrue if launch any dialog else False
unsafe bool NXOpen.UIStyler.Toggle.GetSensitivity ( )
inline

Gets the sensitivity

Created in NX5.0.0

License requirements: None.

Returns
unsafe void NXOpen.UIStyler.Toggle.SetDefaultAction ( )
inline

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 ON/OFF state and calls the Value Changed callback instead of the action of the OK button.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.UIStyler.Toggle.SetFocus ( )
inline

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.UIStyler.Toggle.SetLabel ( string  strLabel)
inline

Sets the label to display on the right side of the toggle button.

If the toggle button displays a bitmap, then this text label is used as a popup hint instead

Created in NX5.0.0

License requirements: None.

Parameters
strLabel
unsafe void NXOpen.UIStyler.Toggle.SetSensitivity ( int  subitemIndex,
bool  type 
)
inline

Sets the sensitivity of the toggle button

Created in NX5.0.0

License requirements: None.

Parameters
subitemIndex
type
delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.Toggle.ValueChanged ( NXOpen.UIStyler.StylerEvent  eventobject)

Called when a dialog user clicks on the button or presses the spacebar when the button has keyboard focus.

Do not terminate the dialog with a value-changed callback. The dialog should always return UF_UI_CB_CONTINUE_DIALOG

Created in NX5.0.0

License requirements: None.

Parameters
eventobjectEvent object

Property Documentation

unsafe bool NXOpen.UIStyler.Toggle.ItemValue
getset

Returns or sets an item value

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.UIStyler.Toggle.Visibility
getset

Returns or sets the visibility of the toggle

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