Represents a SetList block More...

Inheritance diagram for NXOpen.BlockStyler.SetList:

Classes
class	_SetListAddCallbackAdapter

class	_SetListDeleteCallbackAdapter

class	_SetListReorderCallbackAdapter

Public Types
enum	InsertionLocation { Before, After }
	During Insert, indicates whether component should be inserted before or after the insertion location More...

Public Member Functions
delegate int	AddCallback (NXOpen.BlockStyler.SetList list)
	Add callback More...

unsafe NXOpen.BlockStyler.UIBlock	AddNewSet (bool copyPropertiesAndSelect)
	Adds an item to the end of the list More...

unsafe void	Delete (NXOpen.BlockStyler.UIBlock uicomp)
	Deletes an item from the list More...

delegate int	DeleteCallback (NXOpen.BlockStyler.SetList list, NXOpen.BlockStyler.UIBlock blockToDelete)
	Delete callback. More...

unsafe NXOpen.BlockStyler.UIBlock	FindUpdated ()
	When an update event occurs on the list, this method finds the item in the list that was updated More...

unsafe string[]	GetColumnLabels ()
	Gets the ColumnLabels More...

unsafe int[]	GetColumnWidths ()
	Gets the ColumnWidths More...

unsafe NXOpen.BlockStyler.UIBlock[]	GetItems ()
	Gets all the items in the list More...

unsafe string[]	GetItemText (NXOpen.BlockStyler.UIBlock item)
	Gets the text for the specified item. More...

unsafe string[]	GetLayoutMembers ()
	Gets the Layout members More...

unsafe NXOpen.BlockStyler.UIBlock[]	GetSelected ()
	Gets the selected items More...

unsafe NXOpen.BlockStyler.UIBlock	InsertNewSet (NXOpen.BlockStyler.UIBlock location, NXOpen.BlockStyler.SetList.InsertionLocation insertBeforeOrAfter, bool copyPropertiesAndSelect)
	Inserts an item before or after a specified item More...

delegate int	ReorderCallback (NXOpen.BlockStyler.SetList list, NXOpen.BlockStyler.UIBlock reorderedBlock, int oldPosition, int newPosition)
	Reorder callback More...

unsafe void	SetAddHandler (NXOpen.BlockStyler.SetList.AddCallback cb)
	Sets the AddNewSet handler. More...

unsafe void	SetColumnLabels (string[] labels)
	Sets the ColumnLabels More...

unsafe void	SetColumnWidths (int[] width)
	Sets the ColumnWidths More...

unsafe void	SetDeleteHandler (NXOpen.BlockStyler.SetList.DeleteCallback cb)
	Sets the Delete handler. More...

unsafe void	SetItemText (NXOpen.BlockStyler.UIBlock item, string[] strings)
	Sets the text for the specified item. More...

unsafe void	SetReorderObserver (NXOpen.BlockStyler.SetList.ReorderCallback cb)
	Sets the Reorder observer. More...

unsafe void	SetSeed (string dlxFile)
	Sets the seed using a dlx file. More...

unsafe void	SetSelected (NXOpen.BlockStyler.UIBlock[] items)
	Sets the selected items. More...

unsafe void	Swap (NXOpen.BlockStyler.UIBlock uicomp1, NXOpen.BlockStyler.UIBlock uicomp2)
	Swaps the location of two items More...

Public Member Functions inherited from NXOpen.BlockStyler.UIBlock
unsafe void	Focus ()
	Focuses on the block. More...

unsafe NXOpen.BlockStyler.PropertyList	GetProperties ()
	Returns the properties of the block More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override 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 string	AddNewSetLabel `[get, set]`
	Returns or sets the AddNewSetLabel. More...

unsafe int	DefaultColumnWidth `[get, set]`
	Returns or sets the DefaultColumnWidth More...

unsafe bool	IsAddButtonSensitive `[get, set]`
	Returns or sets the IsAddButtonSensitive More...

unsafe string	LayoutAsString `[get, set]`
	Returns or sets the Layout as string More...

unsafe bool	ListExpanded `[get, set]`
	Returns or sets the ListExpanded. More...

unsafe bool	ListHideGroup `[get, set]`
	Returns or sets the ListHideGroup More...

unsafe int	MaximumHeight `[get, set]`
	Returns or sets the MaximumHeight More...

unsafe int	MinimumHeight `[get, set]`
	Returns or sets the MinimumHeight More...

unsafe bool	MultipleEdit `[get, set]`
	Returns or sets the MultipleEdit More...

unsafe string	NumberColumnString `[get, set]`
	Returns or sets the NumberColumnString as string More...

unsafe int	NumberOfColumns `[get, set]`
	Returns or sets the NumberOfColumns More...

unsafe bool	ResizeHeightWithDialog `[get, set]`
	Returns or sets the ResizeHeightWithDialog. More...

unsafe string	SeedDlxFile `[get, set]`
	Returns or sets the SeedDlxFile as string More...

unsafe bool	ShowAddNewSet `[get, set]`
	Returns or sets the ShowAddNewSet. More...

unsafe bool	ShowColumnHeadings `[get, set]`
	Returns or sets the ShowColumnHeadings More...

unsafe bool	ShowRemove `[get, set]`
	Returns or sets the ShowRemove. More...

unsafe bool	ShowReorderControls `[get, set]`
	Returns or sets the ShowReorderControls More...

Properties inherited from NXOpen.BlockStyler.UIBlock
unsafe bool	Enable `[get, set]`
	Returns or sets the Enable. More...

unsafe bool	Expanded `[get, set]`
	Returns or sets the Expanded More...

unsafe bool	Group `[get, set]`
	Returns or sets the Group More...

unsafe string	Label `[get, set]`
	Returns or sets the Label More...

unsafe string	Name `[get]`
	Returns the name of the block or BlockID More...

unsafe bool	Show `[get, set]`
	Returns or sets the Visibility of block. More...

unsafe string	Type `[get]`
	Returns the type of block More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a SetList block

Created in NX6.0.0

Member Enumeration Documentation

enum NXOpen.BlockStyler.SetList.InsertionLocation

During Insert, indicates whether component should be inserted before or after the insertion location

Enumerator
Before
After

Member Function Documentation

delegate int NXOpen.BlockStyler.SetList.AddCallback ( NXOpen.BlockStyler.SetList list )

Add callback

Created in NX6.0.0

License requirements: None.

Parameters

list

unsafe NXOpen.BlockStyler.UIBlock NXOpen.BlockStyler.SetList.AddNewSet ( bool copyPropertiesAndSelect )

inline

Adds an item to the end of the list

Created in NX6.0.0

License requirements: None.

Parameters

copyPropertiesAndSelect Indicates whether to copy properties from the currently selected component and set focus to the new set

Returns: The added item

unsafe void NXOpen.BlockStyler.SetList.Delete ( NXOpen.BlockStyler.UIBlock uicomp )

inline

Deletes an item from the list

Created in NX6.0.0

License requirements: None.

Parameters

uicomp Item to delete

delegate int NXOpen.BlockStyler.SetList.DeleteCallback	(	NXOpen.BlockStyler.SetList	list,
		NXOpen.BlockStyler.UIBlock	blockToDelete
	)

Delete callback.

Return a non-zero value in order to veto the deletion.

Created in NX6.0.0

License requirements: None.

Parameters

list
blockToDelete	The block that is targeted for deletion

unsafe NXOpen.BlockStyler.UIBlock NXOpen.BlockStyler.SetList.FindUpdated ( )

inline

When an update event occurs on the list, this method finds the item in the list that was updated

Created in NX6.0.0

License requirements: None.

Returns

unsafe string [] NXOpen.BlockStyler.SetList.GetColumnLabels ( )

inline

Gets the ColumnLabels

Created in NX8.5.0

License requirements: None.

Returns: Values to get from the property

unsafe int [] NXOpen.BlockStyler.SetList.GetColumnWidths ( )

inline

Gets the ColumnWidths

Created in NX8.5.0

License requirements: None.

Returns: Values to get from the property

unsafe NXOpen.BlockStyler.UIBlock [] NXOpen.BlockStyler.SetList.GetItems ( )

inline

Gets all the items in the list

Created in NX6.0.0

License requirements: None.

Returns

unsafe string [] NXOpen.BlockStyler.SetList.GetItemText ( NXOpen.BlockStyler.UIBlock item )

inline

Gets the text for the specified item.

If the list has a title column, the title column is not included in the item text.

Created in NX6.0.0

License requirements: None.

Parameters

item

Returns: The text

unsafe string [] NXOpen.BlockStyler.SetList.GetLayoutMembers ( )

inline

Gets the Layout members

Created in NX8.5.0

License requirements: None.

Returns

unsafe NXOpen.BlockStyler.UIBlock [] NXOpen.BlockStyler.SetList.GetSelected ( )

inline

Gets the selected items

Created in NX6.0.0

License requirements: None.

Returns

unsafe NXOpen.BlockStyler.UIBlock NXOpen.BlockStyler.SetList.InsertNewSet	(	NXOpen.BlockStyler.UIBlock	location,
		NXOpen.BlockStyler.SetList.InsertionLocation	insertBeforeOrAfter,
		bool	copyPropertiesAndSelect
	)

inline

Inserts an item before or after a specified item

Created in NX6.0.0

License requirements: None.

Parameters

location	Location to insert the new item
insertBeforeOrAfter	Indicates whether to insert the new item before or after the specified location
copyPropertiesAndSelect	Indicates whether to copy properties from the currently selected component and set focus to the new set

Returns: The inserted item

delegate int NXOpen.BlockStyler.SetList.ReorderCallback	(	NXOpen.BlockStyler.SetList	list,
		NXOpen.BlockStyler.UIBlock	reorderedBlock,
		int	oldPosition,
		int	newPosition
	)

Reorder callback

Created in NX6.0.0

License requirements: None.

Parameters

list
reorderedBlock	The block that is moved
oldPosition	Old position in the list
newPosition	New position in the list

unsafe void NXOpen.BlockStyler.SetList.SetAddHandler ( NXOpen.BlockStyler.SetList.AddCallback cb )

inline

Sets the AddNewSet handler.

If you set this handler, the handler will be called when the Add New Set button is pressed, and the handler will be responsible for adding an item to the list. Nothing will be added to the list unless the handler adds it.

Created in NX6.0.0

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.SetList.SetColumnLabels ( string[] labels )

inline

Sets the ColumnLabels

Created in NX8.5.0

License requirements: None.

Parameters

labels Values to set to the property

unsafe void NXOpen.BlockStyler.SetList.SetColumnWidths ( int[] width )

inline

Sets the ColumnWidths

Created in NX8.5.0

License requirements: None.

Parameters

width Values to set to the property

unsafe void NXOpen.BlockStyler.SetList.SetDeleteHandler ( NXOpen.BlockStyler.SetList.DeleteCallback cb )

inline

Sets the Delete handler.

If you set this handler, the handler will be called when the Delete button is pressed. The handler does not need to implement code to delete the item. The list will delete the item if and only if the handler returns 0.

Created in NX6.0.0

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.SetList.SetItemText	(	NXOpen.BlockStyler.UIBlock	item,
		string[]	strings
	)

inline

Sets the text for the specified item.

If the list has a title column, the title column is not included in the item text.

Created in NX6.0.0

License requirements: None.

Parameters

item
strings	The text. The text may only contain characters in the locale character set

unsafe void NXOpen.BlockStyler.SetList.SetReorderObserver ( NXOpen.BlockStyler.SetList.ReorderCallback cb )

inline

Sets the Reorder observer.

If you set this observer, the observer will be called after an item is moved by pressing the Move Up and Down buttons. The observer does not need to implement the move up and down behavior and is called after the item has already been moved.

Created in NX6.0.0

License requirements: None.

Parameters

cb

unsafe void NXOpen.BlockStyler.SetList.SetSeed ( string dlxFile )

inline

Sets the seed using a dlx file.

The seed must be set during initialization. Setting the seed will also reset any Add and Delete handlers that has been registered, so SetSeed should be called prior to calling SetAddHandler or SetDeleteHandler.

Created in NX6.0.0

License requirements: None.

Parameters

dlxFile The dlx file used to create the seed

unsafe void NXOpen.BlockStyler.SetList.SetSelected ( NXOpen.BlockStyler.UIBlock[] items )

inline

Sets the selected items.

If the "Multiple Edit" property is false, no more than one item can be selected

Created in NX6.0.0

License requirements: None.

Parameters

items

unsafe void NXOpen.BlockStyler.SetList.Swap	(	NXOpen.BlockStyler.UIBlock	uicomp1,
		NXOpen.BlockStyler.UIBlock	uicomp2
	)

inline

Swaps the location of two items

Created in NX6.0.0

License requirements: None.

Parameters

uicomp1	Item to swap
uicomp2	Item to swap

Property Documentation

unsafe string NXOpen.BlockStyler.SetList.AddNewSetLabel

getset

Returns or sets the AddNewSetLabel.

Specifies the label for AddNewSet button.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.SetList.DefaultColumnWidth

getset

Returns or sets the DefaultColumnWidth

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.IsAddButtonSensitive

getset

Returns or sets the IsAddButtonSensitive

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SetList.LayoutAsString

getset

Returns or sets the Layout as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.ListExpanded

getset

Returns or sets the ListExpanded.

If true, the list is expanded.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.ListHideGroup

getset

Returns or sets the ListHideGroup

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.SetList.MaximumHeight

getset

Returns or sets the MaximumHeight

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.SetList.MinimumHeight

getset

Returns or sets the MinimumHeight

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.MultipleEdit

getset

Returns or sets the MultipleEdit

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SetList.NumberColumnString

getset

Returns or sets the NumberColumnString as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.SetList.NumberOfColumns

getset

Returns or sets the NumberOfColumns

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.ResizeHeightWithDialog

getset

Returns or sets the ResizeHeightWithDialog.

If true, height of the block changes dynamically with dialog.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SetList.SeedDlxFile

getset

Returns or sets the SeedDlxFile as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.ShowAddNewSet

getset

Returns or sets the ShowAddNewSet.

If true, "Add New Set" button is shown.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.ShowColumnHeadings

getset

Returns or sets the ShowColumnHeadings

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.ShowRemove

getset

Returns or sets the ShowRemove.

If true, "Remove" button is shown.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SetList.ShowReorderControls

getset

Returns or sets the ShowReorderControls

Created in NX8.5.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:

BlockStyler_SetList.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation