Represents a SetList block
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::BlockStyler::SetList:

Public Types
typedef NXOpen::Callback1< int, NXOpen::BlockStyler::SetList * >	AddCallback
	Add callback Created in NX6.0.0.

typedef NXOpen::Callback2< int, NXOpen::BlockStyler::SetList , NXOpen::BlockStyler::UIBlock >	DeleteCallback
	Delete callback.

enum	InsertionLocation { InsertionLocationBefore, InsertionLocationAfter }
	During Insert, indicates whether component should be inserted before or after the insertion location. More...

typedef NXOpen::Callback4< int, NXOpen::BlockStyler::SetList , NXOpen::BlockStyler::UIBlock , int, int >	ReorderCallback
	Reorder callback Created in NX6.0.0.

Public Member Functions
NXOpen::BlockStyler::UIBlock *	AddNewSet (bool copyPropertiesAndSelect)
	Adds an item to the end of the list.

NXString	AddNewSetLabel ()
	Returns the AddNewSetLabel.

int	DefaultColumnWidth ()
	Returns the DefaultColumnWidth Created in NX8.5.0.

void	Delete (NXOpen::BlockStyler::UIBlock *uicomp)
	Deletes an item from the list Created in NX6.0.0.

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

std::vector< NXString >	GetColumnLabels ()
	Gets the ColumnLabels.

std::vector< int >	GetColumnWidths ()
	Gets the ColumnWidths.

std::vector < NXOpen::BlockStyler::UIBlock * >	GetItems ()
	Gets all the items in the list.

std::vector< NXString >	GetItemText (NXOpen::BlockStyler::UIBlock *item)
	Gets the text for the specified item.

std::vector< NXString >	GetLayoutMembers ()
	Gets the Layout members.

std::vector < NXOpen::BlockStyler::UIBlock * >	GetSelected ()
	Gets the selected items.

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

bool	IsAddButtonSensitive ()
	Returns the IsAddButtonSensitive Created in NX8.5.0.

NXString	LayoutAsString ()
	Returns the Layout as string Created in NX8.5.0.

bool	ListExpanded ()
	Returns the ListExpanded.

bool	ListHideGroup ()
	Returns the ListHideGroup Created in NX8.5.0.

int	MaximumHeight ()
	Returns the MaximumHeight Created in NX8.5.0.

int	MinimumHeight ()
	Returns the MinimumHeight Created in NX8.5.0.

bool	MultipleEdit ()
	Returns the MultipleEdit Created in NX8.5.0.

NXString	NumberColumnString ()
	Returns the NumberColumnString as string Created in NX8.5.0.

int	NumberOfColumns ()
	Returns the NumberOfColumns Created in NX8.5.0.

bool	ResizeHeightWithDialog ()
	Returns the ResizeHeightWithDialog.

NXString	SeedDlxFile ()
	Returns the SeedDlxFile as string Created in NX8.5.0.

void	SetAddButtonSensitive (bool addButton)
	Sets the IsAddButtonSensitive Created in NX8.5.0.

void	SetAddHandler (const NXOpen::BlockStyler::SetList::AddCallback &cb)
	Sets the AddNewSet handler.

void	SetAddNewSetLabel (const NXString &label)
	Sets the AddNewSetLabel.

void	SetAddNewSetLabel (const char *label)
	Sets the AddNewSetLabel.

void	SetColumnLabels (std::vector< NXString > &labels)
	Sets the ColumnLabels Created in NX8.5.0.

void	SetColumnWidths (const std::vector< int > &width)
	Sets the ColumnWidths Created in NX8.5.0.

void	SetDefaultColumnWidth (int defaultWidth)
	Sets the DefaultColumnWidth Created in NX8.5.0.

void	SetDeleteHandler (const NXOpen::BlockStyler::SetList::DeleteCallback &cb)
	Sets the Delete handler.

void	SetItemText (NXOpen::BlockStyler::UIBlock *item, std::vector< NXString > &strings)
	Sets the text for the specified item.

void	SetLayoutAsString (const NXString &enumString)
	Sets the Layout as string Created in NX8.5.0.

void	SetLayoutAsString (const char *enumString)
	Sets the Layout as string Created in NX8.5.0.

void	SetListExpanded (bool expanded)
	Sets the ListExpanded.

void	SetListHideGroup (bool listHideGroup)
	Sets the ListHideGroup Created in NX8.5.0.

void	SetMaximumHeight (int maxHeight)
	Sets the MaximumHeight Created in NX8.5.0.

void	SetMinimumHeight (int minHeight)
	Sets the MinimumHeight Created in NX8.5.0.

void	SetMultipleEdit (bool multipleEdit)
	Sets the MultipleEdit Created in NX8.5.0.

void	SetNumberColumnString (const NXString &columnString)
	Sets the NumberColumnString as string Created in NX8.5.0.

void	SetNumberColumnString (const char *columnString)
	Sets the NumberColumnString as string Created in NX8.5.0.

void	SetNumberOfColumns (int numColumns)
	Sets the NumberOfColumns Created in NX8.5.0.

void	SetReorderObserver (const NXOpen::BlockStyler::SetList::ReorderCallback &cb)
	Sets the Reorder observer.

void	SetResizeHeightWithDialog (bool resize)
	Sets the ResizeHeightWithDialog.

void	SetSeed (const NXString &dlxFile)
	Sets the seed using a dlx file.

void	SetSeed (const char *dlxFile)
	Sets the seed using a dlx file.

void	SetSeedDlxFile (const NXString &dlxName)
	Sets the SeedDlxFile as string Created in NX8.5.0.

void	SetSeedDlxFile (const char *dlxName)
	Sets the SeedDlxFile as string Created in NX8.5.0.

void	SetSelected (const std::vector< NXOpen::BlockStyler::UIBlock * > &items)
	Sets the selected items.

void	SetShowAddNewSet (bool show)
	Sets the ShowAddNewSet.

void	SetShowColumnHeadings (bool show)
	Sets the ShowColumnHeadings Created in NX8.5.0.

void	SetShowRemove (bool show)
	Sets the ShowRemove.

void	SetShowReorderControls (bool show)
	Sets the ShowReorderControls Created in NX8.5.0.

bool	ShowAddNewSet ()
	Returns the ShowAddNewSet.

bool	ShowColumnHeadings ()
	Returns the ShowColumnHeadings Created in NX8.5.0.

bool	ShowRemove ()
	Returns the ShowRemove.

bool	ShowReorderControls ()
	Returns the ShowReorderControls Created in NX8.5.0.

void	Swap (NXOpen::BlockStyler::UIBlock uicomp1, NXOpen::BlockStyler::UIBlock uicomp2)
	Swaps the location of two items Created in NX6.0.0.

Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool	Enable ()
	Returns the Enable.

bool	Expanded ()
	Returns the Expanded Created in NX8.5.0.

void	Focus ()
	Focuses on the block.

NXOpen::BlockStyler::PropertyList *	GetProperties ()
	Returns the properties of the block.

bool	Group ()
	Returns the Group Created in NX8.5.0.

NXString	Label ()
	Returns the Label Created in NX8.5.0.

NXString	Name ()
	Returns the name of the block or BlockID Created in NX6.0.0.

void	SetEnable (bool enable)
	Sets the Enable.

void	SetExpanded (bool expanded)
	Sets the Expanded Created in NX8.5.0.

void	SetGroup (bool group)
	Sets the Group Created in NX8.5.0.

void	SetLabel (const NXString &label)
	Sets the Label Created in NX8.5.0.

void	SetLabel (const char *label)
	Sets the Label Created in NX8.5.0.

void	SetShow (bool show)
	Sets the Visibility of block.

bool	Show ()
	Returns the Visibility of block.

NXString	Type ()
	Returns the type of block Created in NX6.0.0.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a SetList block
Created in NX6.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<int, NXOpen::BlockStyler::SetList *> NXOpen::BlockStyler::SetList::AddCallback

       Add callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback2<int, NXOpen::BlockStyler::SetList *, NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::SetList::DeleteCallback

Delete callback.

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

License requirements : None

typedef NXOpen::Callback4<int, NXOpen::BlockStyler::SetList *, NXOpen::BlockStyler::UIBlock *, int, int> NXOpen::BlockStyler::SetList::ReorderCallback

       Reorder callback

Created in NX6.0.0.

License requirements : None

Member Enumeration Documentation

enum NXOpen::BlockStyler::SetList::InsertionLocation

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

Enumerator:

InsertionLocationBefore	before
InsertionLocationAfter	after

Member Function Documentation

NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::SetList::AddNewSet ( bool copyPropertiesAndSelect )

Adds an item to the end of the list.

Returns: The added item
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

NXString NXOpen::BlockStyler::SetList::AddNewSetLabel ( )

Returns the AddNewSetLabel.

Specifies the label for AddNewSet button.
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::SetList::DefaultColumnWidth ( )

Returns the DefaultColumnWidth
Created in NX8.5.0.

License requirements : None

void NXOpen::BlockStyler::SetList::Delete ( NXOpen::BlockStyler::UIBlock * uicomp )

Deletes an item from the list
Created in NX6.0.0.

License requirements : None

Parameters

uicomp Item to delete

NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::SetList::FindUpdated ( )

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

Returns: Created in NX6.0.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::SetList::GetColumnLabels ( )

Gets the ColumnLabels.

Returns: Values to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<int> NXOpen::BlockStyler::SetList::GetColumnWidths ( )

Gets the ColumnWidths.

Returns: Values to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::SetList::GetItems ( )

Gets all the items in the list.

Returns: Created in NX6.0.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::SetList::GetItemText ( NXOpen::BlockStyler::UIBlock * item )

Gets the text for the specified item.

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

Created in NX6.0.0.

License requirements : None

Parameters

item item

std::vector<NXString> NXOpen::BlockStyler::SetList::GetLayoutMembers ( )

Gets the Layout members.

Returns: Created in NX8.5.0.

License requirements : None

std::vector<NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::SetList::GetSelected ( )

Gets the selected items.

Returns: Created in NX6.0.0.

License requirements : None

NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::SetList::InsertNewSet	(	NXOpen::BlockStyler::UIBlock *	location,
		NXOpen::BlockStyler::SetList::InsertionLocation	insertBeforeOrAfter,
		bool	copyPropertiesAndSelect
	)

Inserts an item before or after a specified item.

Returns: The inserted 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

bool NXOpen::BlockStyler::SetList::IsAddButtonSensitive ( )

Returns the IsAddButtonSensitive
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SetList::LayoutAsString ( )

Returns the Layout as string
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SetList::ListExpanded ( )

Returns the ListExpanded.

If true, the list is expanded.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SetList::ListHideGroup ( )

Returns the ListHideGroup
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::SetList::MaximumHeight ( )

Returns the MaximumHeight
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::SetList::MinimumHeight ( )

Returns the MinimumHeight
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SetList::MultipleEdit ( )

Returns the MultipleEdit
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SetList::NumberColumnString ( )

Returns the NumberColumnString as string
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::SetList::NumberOfColumns ( )

Returns the NumberOfColumns
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SetList::ResizeHeightWithDialog ( )

Returns the ResizeHeightWithDialog.

If true, height of the block changes dynamically with dialog.
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::SetList::SeedDlxFile ( )

Returns the SeedDlxFile as string
Created in NX8.5.0.

License requirements : None

void NXOpen::BlockStyler::SetList::SetAddButtonSensitive ( bool addButton )

Sets the IsAddButtonSensitive
Created in NX8.5.0.

License requirements : None

Parameters

addButton addbutton

void NXOpen::BlockStyler::SetList::SetAddHandler ( const NXOpen::BlockStyler::SetList::AddCallback & cb )

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 cb

void NXOpen::BlockStyler::SetList::SetAddNewSetLabel ( const NXString & label )

Sets the AddNewSetLabel.

Specifies the label for AddNewSet button.
Created in NX8.5.0.

License requirements : None

Parameters

label label

void NXOpen::BlockStyler::SetList::SetAddNewSetLabel ( const char * label )

Sets the AddNewSetLabel.

Specifies the label for AddNewSet button.
Created in NX8.5.0.

License requirements : None

Parameters

label label

void NXOpen::BlockStyler::SetList::SetColumnLabels ( std::vector< NXString > & labels )

Sets the ColumnLabels
Created in NX8.5.0.

License requirements : None

Parameters

labels Values to set to the property

void NXOpen::BlockStyler::SetList::SetColumnWidths ( const std::vector< int > & width )

Sets the ColumnWidths
Created in NX8.5.0.

License requirements : None

Parameters

width Values to set to the property

void NXOpen::BlockStyler::SetList::SetDefaultColumnWidth ( int defaultWidth )

Sets the DefaultColumnWidth
Created in NX8.5.0.

License requirements : None

Parameters

defaultWidth defaultwidth

void NXOpen::BlockStyler::SetList::SetDeleteHandler ( const NXOpen::BlockStyler::SetList::DeleteCallback & cb )

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 cb

void NXOpen::BlockStyler::SetList::SetItemText	(	NXOpen::BlockStyler::UIBlock *	item,
		std::vector< NXString > &	strings
	)

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	item
strings	The text. The text may only contain characters in the locale character set

void NXOpen::BlockStyler::SetList::SetLayoutAsString ( const NXString & enumString )

Sets the Layout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SetList::SetLayoutAsString ( const char * enumString )

Sets the Layout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::SetList::SetListExpanded ( bool expanded )

Sets the ListExpanded.

If true, the list is expanded.
Created in NX8.5.0.

License requirements : None

Parameters

expanded expanded

void NXOpen::BlockStyler::SetList::SetListHideGroup ( bool listHideGroup )

Sets the ListHideGroup
Created in NX8.5.0.

License requirements : None

Parameters

listHideGroup listhidegroup

void NXOpen::BlockStyler::SetList::SetMaximumHeight ( int maxHeight )

Sets the MaximumHeight
Created in NX8.5.0.

License requirements : None

Parameters

maxHeight maxheight

void NXOpen::BlockStyler::SetList::SetMinimumHeight ( int minHeight )

Sets the MinimumHeight
Created in NX8.5.0.

License requirements : None

Parameters

minHeight minheight

void NXOpen::BlockStyler::SetList::SetMultipleEdit ( bool multipleEdit )

Sets the MultipleEdit
Created in NX8.5.0.

License requirements : None

Parameters

multipleEdit multipleedit

void NXOpen::BlockStyler::SetList::SetNumberColumnString ( const NXString & columnString )

Sets the NumberColumnString as string
Created in NX8.5.0.

License requirements : None

Parameters

columnString columnstring

void NXOpen::BlockStyler::SetList::SetNumberColumnString ( const char * columnString )

Sets the NumberColumnString as string
Created in NX8.5.0.

License requirements : None

Parameters

columnString columnstring

void NXOpen::BlockStyler::SetList::SetNumberOfColumns ( int numColumns )

Sets the NumberOfColumns
Created in NX8.5.0.

License requirements : None

Parameters

numColumns numcolumns

void NXOpen::BlockStyler::SetList::SetReorderObserver ( const NXOpen::BlockStyler::SetList::ReorderCallback & cb )

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 cb

void NXOpen::BlockStyler::SetList::SetResizeHeightWithDialog ( bool resize )

Sets the ResizeHeightWithDialog.

If true, height of the block changes dynamically with dialog.
Created in NX8.5.0.

License requirements : None

Parameters

resize resize

void NXOpen::BlockStyler::SetList::SetSeed ( const NXString & dlxFile )

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
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::BlockStyler::SetList::SetSeed ( const char * dlxFile )

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
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::BlockStyler::SetList::SetSeedDlxFile ( const NXString & dlxName )

Sets the SeedDlxFile as string
Created in NX8.5.0.

License requirements : None

Parameters

dlxName dlxname

void NXOpen::BlockStyler::SetList::SetSeedDlxFile ( const char * dlxName )

Sets the SeedDlxFile as string
Created in NX8.5.0.

License requirements : None

Parameters

dlxName dlxname

void NXOpen::BlockStyler::SetList::SetSelected ( const std::vector< NXOpen::BlockStyler::UIBlock * > & items )

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 items

void NXOpen::BlockStyler::SetList::SetShowAddNewSet ( bool show )

Sets the ShowAddNewSet.

If true, "Add New Set" button is shown.
Created in NX8.5.0.

License requirements : None

Parameters

show show

void NXOpen::BlockStyler::SetList::SetShowColumnHeadings ( bool show )

Sets the ShowColumnHeadings
Created in NX8.5.0.

License requirements : None

Parameters

show show

void NXOpen::BlockStyler::SetList::SetShowRemove ( bool show )

Sets the ShowRemove.

If true, "Remove" button is shown.
Created in NX8.5.0.

License requirements : None

Parameters

show show

void NXOpen::BlockStyler::SetList::SetShowReorderControls ( bool show )

Sets the ShowReorderControls
Created in NX8.5.0.

License requirements : None

Parameters

show show

bool NXOpen::BlockStyler::SetList::ShowAddNewSet ( )

Returns the ShowAddNewSet.

If true, "Add New Set" button is shown.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SetList::ShowColumnHeadings ( )

Returns the ShowColumnHeadings
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SetList::ShowRemove ( )

Returns the ShowRemove.

If true, "Remove" button is shown.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::SetList::ShowReorderControls ( )

Returns the ShowReorderControls
Created in NX8.5.0.

License requirements : None

void NXOpen::BlockStyler::SetList::Swap	(	NXOpen::BlockStyler::UIBlock *	uicomp1,
		NXOpen::BlockStyler::UIBlock *	uicomp2
	)

Swaps the location of two items
Created in NX6.0.0.

License requirements : None

Parameters

uicomp1	Item to swap
uicomp2	Item to swap

The documentation for this class was generated from the following file:

BlockStyler_SetList.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation