SetList Class

class NXOpen.BlockStyler.SetList

Bases: NXOpen.BlockStyler.UIBlock

Represents a SetList block

New in version NX6.0.0.

Properties

Property Description
AddNewSetLabel Returns or sets the AddNewSetLabel.
DefaultColumnWidth Returns or sets the DefaultColumnWidth
Enable Returns or sets the Enable.
Expanded Returns or sets the Expanded
Group Returns or sets the Group
IsAddButtonSensitive Returns or sets the IsAddButtonSensitive
Label Returns or sets the Label
LayoutAsString Returns or sets the Layout as string
ListExpanded Returns or sets the ListExpanded.
ListHideGroup Returns or sets the ListHideGroup
MaximumHeight Returns or sets the MaximumHeight
MinimumHeight Returns or sets the MinimumHeight
MultipleEdit Returns or sets the MultipleEdit
Name Returns the name of the block or BlockID
NumberColumnString Returns or sets the NumberColumnString as string
NumberOfColumns Returns or sets the NumberOfColumns
ResizeHeightWithDialog Returns or sets the ResizeHeightWithDialog.
SeedDlxFile Returns or sets the SeedDlxFile as string
Show Returns or sets the Visibility of block.
ShowAddNewSet Returns or sets the ShowAddNewSet.
ShowColumnHeadings Returns or sets the ShowColumnHeadings
ShowRemove Returns or sets the ShowRemove.
ShowReorderControls Returns or sets the ShowReorderControls
Tag Returns the Tag for this object.
Type Returns the type of block

Methods

Method Description
AddNewSet Adds an item to the end of the list @return The added item
Delete Deletes an item from the list
FindUpdated When an update event occurs on the list, this method finds the item in the list that was updated @return
Focus Focuses on the block.
GetColumnLabels Gets the ColumnLabels @return Values to get from the property
GetColumnWidths Gets the ColumnWidths @return Values to get from the property
GetItemText Gets the text for the specified item.
GetItems Gets all the items in the list @return
GetLayoutMembers Gets the Layout members @return
GetProperties Returns the properties of the block @return
GetSelected Gets the selected items @return
InsertNewSet Inserts an item before or after a specified item @return The inserted item
SetAddHandler Sets the AddNewSet handler.
SetColumnLabels Sets the ColumnLabels
SetColumnWidths Sets the ColumnWidths
SetDeleteHandler Sets the Delete handler.
SetItemText Sets the text for the specified item.
SetReorderObserver Sets the Reorder observer.
SetSeed Sets the seed using a dlx file.
SetSelected Sets the selected items.
Swap Swaps the location of two items

Enumerations

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

Property Detail

AddNewSetLabel

SetList.AddNewSetLabel

Returns or sets the AddNewSetLabel.

Specifies the label for AddNewSet button.

-------------------------------------

Getter Method

Signature AddNewSetLabel()

Returns:
Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AddNewSetLabel(label)

Parameters:label (str) –

New in version NX8.5.0.

License requirements: None.

DefaultColumnWidth

SetList.DefaultColumnWidth

Returns or sets the DefaultColumnWidth

-------------------------------------

Getter Method

Signature DefaultColumnWidth()

Returns:
Return type:int

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefaultColumnWidth(defaultWidth)

Parameters:defaultWidth (int) –

New in version NX8.5.0.

License requirements: None.

IsAddButtonSensitive

SetList.IsAddButtonSensitive

Returns or sets the IsAddButtonSensitive

-------------------------------------

Getter Method

Signature IsAddButtonSensitive()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsAddButtonSensitive(addButton)

Parameters:addButton (bool) –

New in version NX8.5.0.

License requirements: None.

LayoutAsString

SetList.LayoutAsString

Returns or sets the Layout as string

-------------------------------------

Getter Method

Signature LayoutAsString()

Returns:
Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LayoutAsString(enumString)

Parameters:enumString (str) –

New in version NX8.5.0.

License requirements: None.

ListExpanded

SetList.ListExpanded

Returns or sets the ListExpanded.

If true, the list is expanded.

-------------------------------------

Getter Method

Signature ListExpanded()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ListExpanded(expanded)

Parameters:expanded (bool) –

New in version NX8.5.0.

License requirements: None.

ListHideGroup

SetList.ListHideGroup

Returns or sets the ListHideGroup

-------------------------------------

Getter Method

Signature ListHideGroup()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ListHideGroup(listHideGroup)

Parameters:listHideGroup (bool) –

New in version NX8.5.0.

License requirements: None.

MaximumHeight

SetList.MaximumHeight

Returns or sets the MaximumHeight

-------------------------------------

Getter Method

Signature MaximumHeight()

Returns:
Return type:int

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MaximumHeight(maxHeight)

Parameters:maxHeight (int) –

New in version NX8.5.0.

License requirements: None.

MinimumHeight

SetList.MinimumHeight

Returns or sets the MinimumHeight

-------------------------------------

Getter Method

Signature MinimumHeight()

Returns:
Return type:int

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MinimumHeight(minHeight)

Parameters:minHeight (int) –

New in version NX8.5.0.

License requirements: None.

MultipleEdit

SetList.MultipleEdit

Returns or sets the MultipleEdit

-------------------------------------

Getter Method

Signature MultipleEdit()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MultipleEdit(multipleEdit)

Parameters:multipleEdit (bool) –

New in version NX8.5.0.

License requirements: None.

NumberColumnString

SetList.NumberColumnString

Returns or sets the NumberColumnString as string

-------------------------------------

Getter Method

Signature NumberColumnString()

Returns:
Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature NumberColumnString(columnString)

Parameters:columnString (str) –

New in version NX8.5.0.

License requirements: None.

NumberOfColumns

SetList.NumberOfColumns

Returns or sets the NumberOfColumns

-------------------------------------

Getter Method

Signature NumberOfColumns()

Returns:
Return type:int

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature NumberOfColumns(numColumns)

Parameters:numColumns (int) –

New in version NX8.5.0.

License requirements: None.

ResizeHeightWithDialog

SetList.ResizeHeightWithDialog

Returns or sets the ResizeHeightWithDialog.

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

-------------------------------------

Getter Method

Signature ResizeHeightWithDialog()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ResizeHeightWithDialog(resize)

Parameters:resize (bool) –

New in version NX8.5.0.

License requirements: None.

SeedDlxFile

SetList.SeedDlxFile

Returns or sets the SeedDlxFile as string

-------------------------------------

Getter Method

Signature SeedDlxFile()

Returns:
Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SeedDlxFile(dlxName)

Parameters:dlxName (str) –

New in version NX8.5.0.

License requirements: None.

ShowAddNewSet

SetList.ShowAddNewSet

Returns or sets the ShowAddNewSet.

If true, “Add New Set” button is shown.

-------------------------------------

Getter Method

Signature ShowAddNewSet()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowAddNewSet(show)

Parameters:show (bool) –

New in version NX8.5.0.

License requirements: None.

ShowColumnHeadings

SetList.ShowColumnHeadings

Returns or sets the ShowColumnHeadings

-------------------------------------

Getter Method

Signature ShowColumnHeadings()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowColumnHeadings(show)

Parameters:show (bool) –

New in version NX8.5.0.

License requirements: None.

ShowRemove

SetList.ShowRemove

Returns or sets the ShowRemove.

If true, “Remove” button is shown.

-------------------------------------

Getter Method

Signature ShowRemove()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowRemove(show)

Parameters:show (bool) –

New in version NX8.5.0.

License requirements: None.

ShowReorderControls

SetList.ShowReorderControls

Returns or sets the ShowReorderControls

-------------------------------------

Getter Method

Signature ShowReorderControls()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowReorderControls(show)

Parameters:show (bool) –

New in version NX8.5.0.

License requirements: None.

Method Detail

AddNewSet

SetList.AddNewSet

Adds an item to the end of the list

Signature AddNewSet(copyPropertiesAndSelect)

Parameters:copyPropertiesAndSelect (bool) – Indicates whether to copy properties from the currently selected component and set focus to the new set
Returns:The added item
Return type:NXOpen.BlockStyler.UIBlock

New in version NX6.0.0.

License requirements: None.

Delete

SetList.Delete

Deletes an item from the list

Signature Delete(uicomp)

Parameters:uicomp (NXOpen.BlockStyler.UIBlock) – Item to delete

New in version NX6.0.0.

License requirements: None.

FindUpdated

SetList.FindUpdated

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

Signature FindUpdated()

Returns:
Return type:NXOpen.BlockStyler.UIBlock

New in version NX6.0.0.

License requirements: None.

GetColumnLabels

SetList.GetColumnLabels

Gets the ColumnLabels

Signature GetColumnLabels()

Returns:Values to get from the property
Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetColumnWidths

SetList.GetColumnWidths

Gets the ColumnWidths

Signature GetColumnWidths()

Returns:Values to get from the property
Return type:list of int

New in version NX8.5.0.

License requirements: None.

GetItemText

SetList.GetItemText

Gets the text for the specified item.

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

Signature GetItemText(item)

Parameters:item (NXOpen.BlockStyler.UIBlock) –
Returns:The text
Return type:list of str

New in version NX6.0.0.

License requirements: None.

GetItems

SetList.GetItems

Gets all the items in the list

Signature GetItems()

Returns:
Return type:list of NXOpen.BlockStyler.UIBlock

New in version NX6.0.0.

License requirements: None.

GetLayoutMembers

SetList.GetLayoutMembers

Gets the Layout members

Signature GetLayoutMembers()

Returns:
Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetSelected

SetList.GetSelected

Gets the selected items

Signature GetSelected()

Returns:
Return type:list of NXOpen.BlockStyler.UIBlock

New in version NX6.0.0.

License requirements: None.

InsertNewSet

SetList.InsertNewSet

Inserts an item before or after a specified item

Signature InsertNewSet(location, insertBeforeOrAfter, copyPropertiesAndSelect)

Parameters:
  • location (NXOpen.BlockStyler.UIBlock) – Location to insert the new item
  • insertBeforeOrAfter (NXOpen.BlockStyler.SetListInsertionLocation) – Indicates whether to insert the new item before or after the specified location
  • copyPropertiesAndSelect (bool) – Indicates whether to copy properties from the currently selected component and set focus to the new set
Returns:

The inserted item
Return type:

NXOpen.BlockStyler.UIBlock

New in version NX6.0.0.

License requirements: None.

SetAddHandler

SetList.SetAddHandler

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.

Signature SetAddHandler(cb)

Parameters:cb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

SetColumnLabels

SetList.SetColumnLabels

Sets the ColumnLabels

Signature SetColumnLabels(labels)

Parameters:labels (list of str) – Values to set to the property

New in version NX8.5.0.

License requirements: None.

SetColumnWidths

SetList.SetColumnWidths

Sets the ColumnWidths

Signature SetColumnWidths(width)

Parameters:width (list of int) – Values to set to the property

New in version NX8.5.0.

License requirements: None.

SetDeleteHandler

SetList.SetDeleteHandler

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.

Signature SetDeleteHandler(cb)

Parameters:cb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

SetItemText

SetList.SetItemText

Sets the text for the specified item.

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

Signature SetItemText(item, strings)

Parameters:
  • item (NXOpen.BlockStyler.UIBlock) –
  • strings (list of str) – The text. The text may only contain characters in the locale character set

New in version NX6.0.0.

License requirements: None.

SetReorderObserver

SetList.SetReorderObserver

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.

Signature SetReorderObserver(cb)

Parameters:cb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

SetSeed

SetList.SetSeed

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.

Signature SetSeed(dlxFile)

Parameters:dlxFile (str) – The dlx file used to create the seed

New in version NX6.0.0.

License requirements: None.

SetSelected

SetList.SetSelected

Sets the selected items.

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

Signature SetSelected(items)

Parameters:items (list of NXOpen.BlockStyler.UIBlock) –

New in version NX6.0.0.

License requirements: None.

Swap

SetList.Swap

Swaps the location of two items

Signature Swap(uicomp1, uicomp2)

Parameters:

New in version NX6.0.0.

License requirements: None.