Represents a SingleSelectList for UI Styler More...

Inheritance diagram for NXOpen.UIStyler.SingleSelectList:

Classes
class	_SingleSelectListActivateAdapter

class	_SingleSelectListDoubleClickAdapter

Public Member Functions
delegate NXOpen.UIStyler.DialogState	Activate (NXOpen.UIStyler.StylerEvent eventobject)
	Called when a dialog user selects an entry with a single mouse click or presses the spacebar on an already selected item. More...

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

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

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

unsafe void	SetSelected (int subIndex)
	Specifies particular list items to be selected More...

unsafe void	SetListItems (string[] itemVal)
	Specifies an array of character strings that are used as entries in the list More...

unsafe string[]	GetListItems ()
	Gets an array of character strings that are used as entries in the list. 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 one or more entries to 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)
	Requests a list entry to be deleted. More...

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

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

unsafe string	GetSelectedString ()
	Gets selected string More...

unsafe bool	HasSelected ()
	Returns whether or not an item has been selected 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 single select list More...

unsafe bool	Visibility `[get, set]`
	Returns or sets the visibility of the single select list 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 SingleSelectList for UI Styler

Created in NX5.0.0

Member Function Documentation

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

Called when a dialog user selects an entry with a single mouse click or presses the spacebar on an already selected item.

Created in NX5.0.0

License requirements: None.

Parameters

eventobject Event object

unsafe void NXOpen.UIStyler.SingleSelectList.AddActivateHandler	(	NXOpen.UIStyler.SingleSelectList.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 void NXOpen.UIStyler.SingleSelectList.AddDoubleClickHandler	(	NXOpen.UIStyler.SingleSelectList.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
isDialogLaunchingEvent

unsafe void NXOpen.UIStyler.SingleSelectList.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.SingleSelectList.DeleteSubItem ( int subItemIndex )

Requests a list entry to be deleted.

Created in NX5.0.0

License requirements: None.

Parameters

subItemIndex Zero-based index of a list entry to be deleted. If subitem_index equals UF_STYLER_NO_SUB_INDEX, then all list entries are deleted.

unsafe void NXOpen.UIStyler.SingleSelectList.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.SingleSelectList.DoubleClick ( NXOpen.UIStyler.StylerEvent eventobject )

Called when a dialog user double-clicks on an option 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.SingleSelectList.GetListItems ( )

Gets an array of character strings that are used as entries in the list.

Created in NX5.0.0

License requirements: None.

Returns: An array of string items

unsafe int NXOpen.UIStyler.SingleSelectList.GetSelectedIndexValue ( )

Gets selected index

Created in NX5.0.0

License requirements: None.

Returns

unsafe string NXOpen.UIStyler.SingleSelectList.GetSelectedString ( )

Gets selected string

Created in NX5.0.0

License requirements: None.

Returns

unsafe bool NXOpen.UIStyler.SingleSelectList.HasSelected ( )

Returns whether or not an item has been selected

Created in NX7.5.1

License requirements: None.

Returns

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

Requests one or more entries to 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	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.SingleSelectList.SetFocus ( )

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0

License requirements: None.

unsafe void NXOpen.UIStyler.SingleSelectList.SetListItems ( string[] itemVal )

Specifies an array of character strings that are used as entries in the list

Created in NX5.0.0

License requirements: None.

Parameters

itemVal An array of string items

unsafe void NXOpen.UIStyler.SingleSelectList.SetSelected ( int subIndex )

Specifies particular list items to be selected

Created in NX5.0.0

License requirements: None.

Parameters

subIndex Inndex of particular list items to be selected

unsafe void NXOpen.UIStyler.SingleSelectList.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 Zero-based index of a list entry to be scrolled up to the first line of the list.

Property Documentation

unsafe bool NXOpen.UIStyler.SingleSelectList.Sensitivity

getset

Returns or sets the sensitivity of the single select list

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.UIStyler.SingleSelectList.Visibility

getset

Returns or sets the visibility of the single select list

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_SingleSelectList.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation