Represents a SelectionBox for UI Styler More...

Inheritance diagram for NXOpen.UIStyler.SelectionBox:

Classes
class	_SelectionBoxActivateAdapter

class	_SelectionBoxDoubleClickAdapter

Public Member Functions
delegate NXOpen.UIStyler.DialogState	Activate (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user selects a list entry with a single mouse click, presses the spacebar on a selected list entry, or presses Return when the cursor is in the text field. More...

delegate NXOpen.UIStyler.DialogState	DoubleClick (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user double-clicks on an option in the selection box or presses Return when an item is already selected. More...

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

unsafe void	AddDoubleClickHandler (NXOpen.UIStyler.SelectionBox.DoubleClick doubleclickevent, bool isDialogLaunchingEvent)
	Registers double click callback. More...

unsafe void	SetListItems (string[] values)
	Specifies an array of character strings for item names that are used as selectable choices for this dialog item. More...

unsafe string[]	GetListItems ()
	Gets an array of character strings for item names that are used as selectable choices for this dialog item. More...

unsafe void	SetLabel (string strLabel)
	Specifies the descriptive text string to display below the scrolled list and above the text field. More...

unsafe void	SetFocus ()
	Indicates that this dialog item is receiving keyboard focus. More...

unsafe void	DeselectSubItem (int subItemIndex)
	Requests a list entry to be deselected. More...

unsafe void	InsertSubItem (int subitemIndex, string[] multiEntries)
	Requests that one or more entries be inserted into the list. More...

unsafe void	Append (string[] multiEntries)
	Appends one or more entries to be inserted into the list More...

unsafe void	DeleteSubItem (int subItemIndex)
	Deletes sub item More...

unsafe void	ShowSubItem (int subItemIndex)
	Requests that a list entry be scrolled up to the first line in the list. More...

unsafe void	SetValue (int value)
	Sets the value More...

unsafe int	GetSelectedIndexValue ()
	Gets selected index value More...

unsafe string	GetSelectedString ()
	Gets selected string 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 bool	Sensitivity `[get, set]`
	Returns or sets the sensitivity of the selection box More...

unsafe bool	Visibility `[get, set]`
	Returns or sets the visibility of the selection box 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 SelectionBox for UI Styler

Created in NX5.0.0

Member Function Documentation

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

Called when a dialog user selects a list entry with a single mouse click, presses the spacebar on a selected list entry, or presses Return when the cursor is in the text field.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

unsafe void NXOpen.UIStyler.SelectionBox.AddActivateHandler	(	NXOpen.UIStyler.SelectionBox.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	Activate event
isDialogLaunchingEvent	TRUE if launch new dialog, FALSE if not

unsafe void NXOpen.UIStyler.SelectionBox.AddDoubleClickHandler	(	NXOpen.UIStyler.SelectionBox.DoubleClick	doubleclickevent,
		bool	isDialogLaunchingEvent
	)

Registers double click callback.

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

Created in NX5.0.0

License requirements: None.

Parameters

doubleclickevent	Double click event
isDialogLaunchingEvent	TRUE if launch new dialog, FALSE if not

unsafe void NXOpen.UIStyler.SelectionBox.Append ( string[] multiEntries )

Appends one or more entries to be inserted into the list

Created in NX5.0.0

License requirements: None.

Parameters

multiEntries An array of entry names to be inserted into the list. This field is used only when more than one entry are to be inserted into the list.

unsafe void NXOpen.UIStyler.SelectionBox.DeleteSubItem ( int subItemIndex )

Deletes sub item

Created in NX5.0.0

License requirements: None.

Parameters

subItemIndex

unsafe void NXOpen.UIStyler.SelectionBox.DeselectSubItem ( int subItemIndex )

Requests a list entry to be deselected.

Created in NX5.0.0

License requirements: None.

Parameters

subItemIndex

delegate NXOpen.UIStyler.DialogState NXOpen.UIStyler.SelectionBox.DoubleClick ( NXOpen.UIStyler.StylerEvent eventobject )

Called when a dialog user double-clicks on an option in the selection box or presses Return when an item is already selected.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

unsafe string [] NXOpen.UIStyler.SelectionBox.GetListItems ( )

Gets an array of character strings for item names that are used as selectable choices for this dialog item.

Created in NX5.0.0

License requirements: None.

Returns: List of items

unsafe int NXOpen.UIStyler.SelectionBox.GetSelectedIndexValue ( )

Gets selected index value

Created in NX5.0.0

License requirements: None.

Returns

unsafe string NXOpen.UIStyler.SelectionBox.GetSelectedString ( )

Gets selected string

Created in NX5.0.0

License requirements: None.

Returns

unsafe void NXOpen.UIStyler.SelectionBox.InsertSubItem	(	int	subitemIndex,
		string[]	multiEntries
	)

Requests that one or more entries be inserted into the list.

You can insert entries at the bottom of the list or at any position within the list.

Created in NX5.0.0

License requirements: None.

Parameters

subitemIndex	Position index where the insertion should be made. If subitem_index equals UF_STYLER_NO_SUB_INDEX, then the new list entries are added to the bottom of the list.
multiEntries

unsafe void NXOpen.UIStyler.SelectionBox.SetFocus ( )

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0

License requirements: None.

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

Specifies the descriptive text string to display below the scrolled list and above the text field.

It describes the dialog item's usage.

Created in NX5.0.0

License requirements: None.

Parameters

strLabel Label string

unsafe void NXOpen.UIStyler.SelectionBox.SetListItems ( string[] values )

Specifies an array of character strings for item names that are used as selectable choices for this dialog item.

Created in NX5.0.0

License requirements: None.

Parameters

values List of items

unsafe void NXOpen.UIStyler.SelectionBox.SetValue ( int value )

Sets the value

Created in NX5.0.0

License requirements: None.

Parameters

value

unsafe void NXOpen.UIStyler.SelectionBox.ShowSubItem ( int subItemIndex )

Requests that a list entry be scrolled up to the first line in the list.

Created in NX5.0.0

License requirements: None.

Parameters

subItemIndex

Property Documentation

unsafe bool NXOpen.UIStyler.SelectionBox.Sensitivity

getset

Returns or sets the sensitivity of the selection box

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.UIStyler.SelectionBox.Visibility

getset

Returns or sets the visibility of the selection box

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:

dotnet_pool/UIStyler_SelectionBox.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation