Represents a OptionToggle for UI Styler More...

Inheritance diagram for NXOpen.UIStyler.OptionToggle:

Classes
class	_OptionToggleActivateAdapter

class	_OptionToggleValueChangedAdapter

Public Member Functions
delegate NXOpen.UIStyler.DialogState	Activate (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user selects an option from the menu More...

unsafe void	AddActivateHandler (NXOpen.UIStyler.OptionToggle.Activate activateevent, bool isDialogLaunchingEvent)
	Registers activate callback. More...

unsafe void	AddValueChangedHandler (NXOpen.UIStyler.OptionToggle.ValueChanged valuechangedevent, bool isDialogLaunchingEvent)
	Registers value change callback. More...

unsafe string[]	GetItems ()
	Returns the items More...

unsafe int	GetItemValue (out bool setCheck)
	Returns item value More...

unsafe bool	GetSensitivity ()
	Returns the sesitivity More...

unsafe void	SetBitmaps (string[] bitmaps)
	Set bitmaps More...

unsafe void	SetDefaultAction ()
	Sets default action More...

unsafe void	SetItems (string[] strListArray)
	Sets items in the array More...

unsafe void	SetItemValue (int subitemIndex, bool setCheck)
	Sets item value More...

unsafe void	SetLabel (string strLabel)
	Sets label More...

unsafe void	SetSensitivity (int subitemIndex, bool type)
	Set the sesitivity 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	Visibility `[get, set]`
	Returns or sets the visibility 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 OptionToggle for UI Styler

Created in NX5.0.0

Member Function Documentation

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

Called when a dialog user selects an option from the menu

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

unsafe void NXOpen.UIStyler.OptionToggle.AddActivateHandler	(	NXOpen.UIStyler.OptionToggle.Activate	activateevent,
		bool	isDialogLaunchingEvent
	)

inline

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	Callback for activate event
isDialogLaunchingEvent	TRUE if dialog is going to launch, FALSE if not

unsafe void NXOpen.UIStyler.OptionToggle.AddValueChangedHandler	(	NXOpen.UIStyler.OptionToggle.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

valuechangedevent	Callback for value changed event
isDialogLaunchingEvent	TRUE if dialog is going to launch, FALSE if not

unsafe string [] NXOpen.UIStyler.OptionToggle.GetItems ( )

inline

Returns the items

Created in NX5.0.0

License requirements: None.

Returns: An array of items

unsafe int NXOpen.UIStyler.OptionToggle.GetItemValue ( out bool setCheck )

inline

Returns item value

Created in NX5.0.0

License requirements: None.

Parameters

setCheck

Returns: Item value

unsafe bool NXOpen.UIStyler.OptionToggle.GetSensitivity ( )

inline

Returns the sesitivity

Created in NX5.0.0

License requirements: None.

Returns

unsafe void NXOpen.UIStyler.OptionToggle.SetBitmaps ( string[] bitmaps )

inline

Set bitmaps

Created in NX5.0.0

License requirements: None.

Parameters

bitmaps An array of one or more bitmap filenames. If all bitmaps for the option menu reside in the same file, specify an array of just one entry, which contains the bitmap filename for this attribute. All existing choices for the option menu remain intact when this attribute is set. Only the bitmaps are changed. Note that the number of bitmaps must match the number of existing choices.

unsafe void NXOpen.UIStyler.OptionToggle.SetDefaultAction ( )

inline

Sets default action

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.UIStyler.OptionToggle.SetItems ( string[] strListArray )

inline

Sets items in the array

Created in NX5.0.0

License requirements: None.

Parameters

strListArray An array of new choices to be used for the dialog item. Note that this removes all existing choices (both text and bitmaps).

unsafe void NXOpen.UIStyler.OptionToggle.SetItemValue	(	int	subitemIndex,
		bool	setCheck
	)

inline

Sets item value

Created in NX5.0.0

License requirements: None.

Parameters

subitemIndex	Zero-based index indicating the choice to be selected. It must be in the range of existing choices.
setCheck	TRUE if set, FALSE if unset.

unsafe void NXOpen.UIStyler.OptionToggle.SetLabel ( string strLabel )

inline

Sets label

Created in NX5.0.0

License requirements: None.

Parameters

strLabel Text to be set for the tool tip.

unsafe void NXOpen.UIStyler.OptionToggle.SetSensitivity	(	int	subitemIndex,
		bool	type
	)

inline

Set the sesitivity

Created in NX5.0.0

License requirements: None.

Parameters

subitemIndex	If the entire dialog item should change to the new Sensitivity state, set this field to UF_STYLER_NO_SUB_INDEX. If only one sub-item should change to the new sensitivity state, set this field to its zero-based index.
type	TRUE if sensitive, FALSE if insensitive

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.OptionToggle.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

eventobject Event object

Property Documentation

unsafe bool NXOpen.UIStyler.OptionToggle.Visibility

getset

Returns or sets the visibility

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:

UIStyler_OptionToggle.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation