Tree Class¶
-
class
NXOpen.BlockStyler.
Tree
¶ Bases:
NXOpen.BlockStyler.UIBlock
Represents the Tree block in block styler automation.
To start utilizing the tree use methods such as
BlockStyler.Tree.InsertColumn()
,BlockStyler.Tree.CreateNode()
,BlockStyler.Tree.InsertNode()
etc. It is must to insert the column on the tree before inserting any node. Node can be created but cannot be inserted without the column available on the tree. Note that some of the methods of this class such asBlockStyler.Tree.InsertColumn()
must be used in or after the BlockStyler.BlockDialog.DialogShown callback after which tree is fully constructed and ready for use. .. versionadded:: NX7.5.0
Properties¶
Property | Description |
---|---|
CanStretchHeight | Returns or sets the CanStretchHeight. |
Enable | Returns or sets the Enable. |
Expanded | Returns or sets the Expanded |
FirstSelectedNode | Returns the first selected node among the available selected nodes. |
Group | Returns or sets the Group |
Height | Returns or sets the Height |
Label | Returns or sets the Label |
Localize | Returns or sets the Localize |
MaximumHeight | Returns or sets the MaximumHeight |
MinimumHeight | Returns or sets the MinimumHeight |
Name | Returns the name of the block or BlockID |
NumberOfColumns | Returns the number of column inserted in the tree. |
RootNode | Returns the root node. |
ScrollFrozenColumn | Returns or sets the ScrollFrozenColumn. |
ScrollLineNumber | Returns or sets the ScrollLineNumber. |
SelectionModeAsString | Returns or sets the SelectionMode |
Show | Returns or sets the Visibility of block. |
ShowExpandCollapseMarker | Returns or sets the ShowExpandCollapseMarker. |
ShowHeader | Returns or sets the ShowHeader |
ShowMultipleColumns | Returns or sets the ShowMultipleColumns |
ShowToolTips | Returns or sets the ShowToolTips |
SortRootNodes | Returns or sets the SortRootNodes. |
Tag | Returns the Tag for this object. |
Type | Returns the type of block |
Methods¶
Method | Description |
---|---|
CopyNode | Copies the existing BlockStyler.Node . |
CreateMenu | Creates the menu. |
CreateNode | Creates the node but does not insert it. |
DeleteNode | Deletes the node from tree. |
Focus | Focuses on the block. |
GetColumnDisplayType | Gets the display type of the column. |
GetColumnId | Gets the column Id for the provided column position. |
GetColumnPosition | Gets column position. |
GetColumnResizePolicy | Gets the column resize policy. |
GetColumnSortOption | Gets the column sort option. |
GetColumnSortable | Gets the flag indicating whether the column is sortable. |
GetColumnTitle | Gets the column title. |
GetColumnVisible | Gets the flag indicating whether the column is visible. |
GetColumnWidth | Gets column width @return Column width. |
GetProperties | Returns the properties of the block @return |
GetSelectedNodes | Gets the selected nodes. |
GetSelectionModeMembers | Gets the SelectionMode @return Value to get from the property |
InsertColumn | Inserts a column. |
InsertNode | Inserts the node. |
Redraw | Freezes the tree if the value is set to False which implies that no changes would occur in the tree after this point. |
SelectNode | Selects the provided node. |
SelectNodes | Selects the provided nodes. |
SetAskEditControlHandler | Sets the node-edit-control callback |
SetColumnDisplayType | Sets the display type of the column. |
SetColumnResizePolicy | Sets the column resize policy. |
SetColumnSortHandler | Sets the column sort callback. |
SetColumnSortOption | Sets the column sort option. |
SetColumnSortable | Sets the flag indicating whether the column is sortable. |
SetColumnTitle | Sets the column title. |
SetColumnVisible | Sets the flag indicating whether the column is visible |
SetColumnWidth | Sets the column width |
SetEditOptions | Sets the options in edit-control. This method must be used in BlockStyler.Tree.AskEditControlCallback to make available the options in edit-control. |
SetIsDragAllowedHandler | Sets the callback handler for node drag |
SetIsDropAllowedHandler | Sets the callback handler for node drop |
SetMenu | Sets the menu, resulting the menu to appear on the screen. |
SetOnBeginLabelEditHandler | Sets the on-begin-label-edit callback |
SetOnDefaultActionHandler | Sets the on select node callback |
SetOnDeleteNodeHandler | Sets on delete node callback |
SetOnDropHandler | Sets the callback handler for node drop |
SetOnDropMenuHandler | Sets the callback handler for on drop menu. |
SetOnEditOptionSelectedHandler | Sets the on-end-label-edit callback |
SetOnEndLabelEditHandler | Sets the on-end-label-edit callback |
SetOnExpandHandler | Sets the on expand callback to the tree. |
SetOnInsertColumnHandler | Sets the on insert column callback to the tree. |
SetOnInsertNodeHandler | Sets the on insert node callback. |
SetOnMenuHandler | Sets the on menu callback |
SetOnMenuSelectionHandler | Sets the on menu selection callback |
SetOnPreSelectHandler | Sets on pre select callback |
SetOnSelectHandler | Sets the on select node callback |
SetOnStateChangeHandler | Sets the on state change callback. |
SetPreSelectionTimeOut | Sets the pre selection time out. |
SetStateIconNameHandler | Sets the state icon name callback. |
SetToolTipTextHandler | Sets the tool tip callback. |
Enumerations¶
TreeBeginLabelEditState Enumeration | Represents the state to allow/disallow the node label edit. |
TreeColumnDisplay Enumeration | Represents the column display type. |
TreeColumnResizePolicy Enumeration | Represents column resize policy. |
TreeColumnSortOption Enumeration | Represents the column sort option. |
TreeControlType Enumeration | Represents the type of edit options. |
TreeEditControlOption Enumeration | Represents the options to accept or reject the changed value. |
TreeEndLabelEditState Enumeration | Represents the state to accept/reject the edited label of node. |
TreeNodeInsertOption Enumeration | Represents the node insert option which is used while inserting the node in tree. |
Property Detail¶
CanStretchHeight¶
-
Tree.
CanStretchHeight
¶ Returns or sets the CanStretchHeight.
If true, height of list box will change.
-------------------------------------
Getter Method
Signature
CanStretchHeight()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CanStretchHeight(stretchHeight)
Parameters: stretchHeight (bool) – New in version NX8.5.0.
License requirements: None.
FirstSelectedNode¶
-
Tree.
FirstSelectedNode
¶ Returns the first selected node among the available selected nodes.
Returns None if no node is selected.
-------------------------------------
Getter Method
Signature
FirstSelectedNode()
Returns: First selected node in the whole hierarchy Return type: NXOpen.BlockStyler.Node
New in version NX7.5.0.
License requirements: None.
Height¶
-
Tree.
Height
¶ Returns or sets the Height
-------------------------------------
Getter Method
Signature
Height()
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Height(height)
Parameters: height (int) – New in version NX8.5.0.
License requirements: None.
Localize¶
-
Tree.
Localize
¶ Returns or sets the Localize
-------------------------------------
Getter Method
Signature
Localize()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Localize(localize)
Parameters: localize (bool) – New in version NX8.5.0.
License requirements: None.
MaximumHeight¶
-
Tree.
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¶
-
Tree.
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.
NumberOfColumns¶
-
Tree.
NumberOfColumns
¶ Returns the number of column inserted in the tree.
-------------------------------------
Getter Method
Signature
NumberOfColumns()
Returns: Total number of column. Return type: int New in version NX7.5.0.
License requirements: None.
RootNode¶
-
Tree.
RootNode
¶ Returns the root node.
If more than one root node is available in top hierarchy then the first root node is returned.
-------------------------------------
Getter Method
Signature
RootNode()
Returns: Root node. Return type: NXOpen.BlockStyler.Node
New in version NX7.5.0.
License requirements: None.
ScrollFrozenColumn¶
-
Tree.
ScrollFrozenColumn
¶ Returns or sets the ScrollFrozenColumn.
It specifies the number of columns to freeze while scrolling.
-------------------------------------
Getter Method
Signature
ScrollFrozenColumn()
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScrollFrozenColumn(scrollFrozenColumn)
Parameters: scrollFrozenColumn (int) – New in version NX8.5.0.
License requirements: None.
ScrollLineNumber¶
-
Tree.
ScrollLineNumber
¶ Returns or sets the ScrollLineNumber.
It specifies the number of lines to scroll when the mouse wheel rotates.
-------------------------------------
Getter Method
Signature
ScrollLineNumber()
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScrollLineNumber(scrollLineNumber)
Parameters: scrollLineNumber (int) – New in version NX8.5.0.
License requirements: None.
SelectionModeAsString¶
-
Tree.
SelectionModeAsString
¶ Returns or sets the SelectionMode
-------------------------------------
Getter Method
Signature
SelectionModeAsString()
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectionModeAsString(enumString)
Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
ShowExpandCollapseMarker¶
-
Tree.
ShowExpandCollapseMarker
¶ Returns or sets the ShowExpandCollapseMarker.
If true, displays a sign as a marker alongside first node of the tree indicating if it is expanded or collapsed.
-------------------------------------
Getter Method
Signature
ShowExpandCollapseMarker()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowExpandCollapseMarker(show)
Parameters: show (bool) – New in version NX8.5.0.
License requirements: None.
ShowHeader¶
-
Tree.
ShowHeader
¶ Returns or sets the ShowHeader
-------------------------------------
Getter Method
Signature
ShowHeader()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowHeader(show)
Parameters: show (bool) – New in version NX8.5.0.
License requirements: None.
ShowMultipleColumns¶
-
Tree.
ShowMultipleColumns
¶ Returns or sets the ShowMultipleColumns
-------------------------------------
Getter Method
Signature
ShowMultipleColumns()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowMultipleColumns(show)
Parameters: show (bool) – New in version NX8.5.0.
License requirements: None.
ShowToolTips¶
-
Tree.
ShowToolTips
¶ Returns or sets the ShowToolTips
-------------------------------------
Getter Method
Signature
ShowToolTips()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowToolTips(show)
Parameters: show (bool) – New in version NX8.5.0.
License requirements: None.
SortRootNodes¶
-
Tree.
SortRootNodes
¶ Returns or sets the SortRootNodes.
If true, sorting of root nodes is allowed.
-------------------------------------
Getter Method
Signature
SortRootNodes()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SortRootNodes(sort)
Parameters: sort (bool) – New in version NX8.5.0.
License requirements: None.
Method Detail¶
CopyNode¶
-
Tree.
CopyNode
¶ Copies the existing
BlockStyler.Node
.The tree can copy either its own node or the node of another tree. The copied node can only be inserted into the tree which has copied that node. The column texts are not passed to the copied node.
Signature
CopyNode(sourceNode)
Parameters: sourceNode ( NXOpen.BlockStyler.Node
) – Source node. Can be node of other tree.Returns: Copied node. Return type: NXOpen.BlockStyler.Node
New in version NX7.5.0.
License requirements: None.
CreateNode¶
-
Tree.
CreateNode
¶ Creates the node but does not insert it.
Use
BlockStyler.Tree.InsertNode()
to insert the node.Signature
CreateNode(displayText)
Parameters: displayText (str) – Specifies the display text of the node. Returns: Node Return type: NXOpen.BlockStyler.Node
New in version NX7.5.0.
License requirements: None.
DeleteNode¶
-
Tree.
DeleteNode
¶ Deletes the node from tree.
Further usage of deleted node is illegal. The last place where node can be used is in BlockStyler.Tree.OnDeleteNodeCallaback callback which gets called when node is deleted.
Signature
DeleteNode(node)
Parameters: node ( NXOpen.BlockStyler.Node
) – Node to deleteNew in version NX7.5.0.
License requirements: None.
GetColumnDisplayType¶
-
Tree.
GetColumnDisplayType
¶ Gets the display type of the column.
Signature
GetColumnDisplayType(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Display type. Return type: NXOpen.BlockStyler.TreeColumnDisplay
New in version NX7.5.0.
License requirements: None.
GetColumnId¶
-
Tree.
GetColumnId
¶ Gets the column Id for the provided column position.
Signature
GetColumnId(columnPosition)
Parameters: columnPosition (int) – Column position. Returns: Unique column Id associated with the column. Return type: int New in version NX7.5.0.
License requirements: None.
GetColumnPosition¶
-
Tree.
GetColumnPosition
¶ Gets column position.
Returns -1 if no column is associated with the provided column Id.
Signature
GetColumnPosition(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Column position. Return type: int New in version NX7.5.0.
License requirements: None.
GetColumnResizePolicy¶
-
Tree.
GetColumnResizePolicy
¶ Gets the column resize policy.
Signature
GetColumnResizePolicy(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Resize policy. Return type: NXOpen.BlockStyler.TreeColumnResizePolicy
New in version NX7.5.0.
License requirements: None.
GetColumnSortOption¶
-
Tree.
GetColumnSortOption
¶ Gets the column sort option.
Signature
GetColumnSortOption(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Column sort option. Return type: NXOpen.BlockStyler.TreeColumnSortOption
New in version NX7.5.0.
License requirements: None.
GetColumnSortable¶
-
Tree.
GetColumnSortable
¶ Gets the flag indicating whether the column is sortable.
Signature
GetColumnSortable(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Flag indicating whether the column is sortable. Return type: bool New in version NX7.5.0.
License requirements: None.
GetColumnTitle¶
-
Tree.
GetColumnTitle
¶ Gets the column title.
Signature
GetColumnTitle(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Column header title. Return type: str New in version NX7.5.0.
License requirements: None.
GetColumnVisible¶
-
Tree.
GetColumnVisible
¶ Gets the flag indicating whether the column is visible.
Signature
GetColumnVisible(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Flag indicating whether the column is visible. Return type: bool New in version NX7.5.0.
License requirements: None.
GetColumnWidth¶
-
Tree.
GetColumnWidth
¶ Gets column width
Signature
GetColumnWidth(columnID)
Parameters: columnID (int) – Unique column Id associated with the column. Returns: Column width. Return type: int New in version NX7.5.0.
License requirements: None.
GetSelectedNodes¶
-
Tree.
GetSelectedNodes
¶ Gets the selected nodes.
Signature
GetSelectedNodes()
Returns: Selected nodes. Return type: list of NXOpen.BlockStyler.Node
New in version NX7.5.0.
License requirements: None.
GetSelectionModeMembers¶
-
Tree.
GetSelectionModeMembers
¶ Gets the SelectionMode
Signature
GetSelectionModeMembers()
Returns: Value to get from the property Return type: list of str New in version NX8.5.0.
License requirements: None.
InsertColumn¶
-
Tree.
InsertColumn
¶ Inserts a column.
Inserts a column with following defaults:
BlockStyler.TreeColumnSortOption
asBlockStyler.TreeColumnSortOption.Ascending
- Column sortable as True
- Column visible as True
BlockStyler.TreeColumnDisplay
asBlockStyler.TreeColumnDisplay.Text
BlockStyler.TreeColumnResizePolicy
asBlockStyler.TreeColumnResizePolicy.ConstantWidth
The new column is placed after the last available column. If no column is available then the inserted one becomes the first column of the tree.
Signature
InsertColumn(columnID, columnTitle, columnWidth)
Parameters: - columnID (int) – Unique column Id associated with the column. Any further interaction with the column is done with this column Id.
- columnTitle (str) – Column header title.
- columnWidth (int) – Providing value less than zero will set the default width of 0 for the column.
Returns: Absolute column position.
Return type: int
New in version NX7.5.0.
License requirements: None.
InsertNode¶
-
Tree.
InsertNode
¶ Inserts the node.
Subsequently BlockStyler.Tree.OnInsertNodeCallback is called. Reinserting the node in same or different tree is not allowed.
Signature
InsertNode(newNode, parentNode, afterNode, nodeInsertOption)
Parameters: - newNode (
NXOpen.BlockStyler.Node
) – New Node. - parentNode (
NXOpen.BlockStyler.Node
) – Parent node under which new node is supposed to be placed. - afterNode (
NXOpen.BlockStyler.Node
) – New node placed after this node. If there is mismatch between parent-node and after-node then former is honoured. - nodeInsertOption (
NXOpen.BlockStyler.TreeNodeInsertOption
) – Node insert option. Provide the value if after node is None. This value is not considered if a valid after-node is supplied.
New in version NX7.5.0.
License requirements: None.
- newNode (
Redraw¶
-
Tree.
Redraw
¶ Freezes the tree if the value is set to False which implies that no changes would occur in the tree after this point.
The tree remains in that state until the value is set to True, after which the tree completely updates itself with the changes performed on it in between the two calls. Use this method to efficiently utilize the tree when it is subjected to enourmous changes.
Signature
Redraw(redraw)
Parameters: redraw (bool) – Flag corresponds to freeze/unfreeze of tree changes. New in version NX7.5.0.
License requirements: None.
SelectNode¶
-
Tree.
SelectNode
¶ Selects the provided node.
Signature
SelectNode(node, isSelect, isOtherNodeAffected)
Parameters: - node (
NXOpen.BlockStyler.Node
) – Node to be selected - isSelect (bool) – Select/Deselect flag. If true, the provided node is selected, else deselected.
- isOtherNodeAffected (bool) – Flag indicating whether selection of other nodes is affected. If true, all the previous selected nodes are deselected, else unaffected.
New in version NX7.5.0.
License requirements: None.
- node (
SelectNodes¶
-
Tree.
SelectNodes
¶ Selects the provided nodes.
Signature
SelectNodes(node, isSelect, isOtherNodeAffected)
Parameters: - node (list of
NXOpen.BlockStyler.Node
) – Nodes to be selected - isSelect (bool) – Select/Deselect flag. If true, the provided nodes are selected, else deselected.
- isOtherNodeAffected (bool) – Flag indicating whether selection of other nodes is affected. If true, all the previous selected nodes are deselected, else remain so.
New in version NX7.5.0.
License requirements: None.
- node (list of
SetAskEditControlHandler¶
-
Tree.
SetAskEditControlHandler
¶ Sets the node-edit-control callback
Signature
SetAskEditControlHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetColumnDisplayType¶
-
Tree.
SetColumnDisplayType
¶ Sets the display type of the column.
Signature
SetColumnDisplayType(columnID, displayType)
Parameters: - columnID (int) – Unique column Id associated with the column.
- displayType (
NXOpen.BlockStyler.TreeColumnDisplay
) – Display type.
New in version NX7.5.0.
License requirements: None.
SetColumnResizePolicy¶
-
Tree.
SetColumnResizePolicy
¶ Sets the column resize policy.
Signature
SetColumnResizePolicy(columnID, resizePolicy)
Parameters: - columnID (int) – Unique column Id associated with the column
- resizePolicy (
NXOpen.BlockStyler.TreeColumnResizePolicy
) – Resize policy
New in version NX7.5.0.
License requirements: None.
SetColumnSortHandler¶
-
Tree.
SetColumnSortHandler
¶ Sets the column sort callback.
Signature
SetColumnSortHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetColumnSortOption¶
-
Tree.
SetColumnSortOption
¶ Sets the column sort option.
Signature
SetColumnSortOption(columnID, sortOption)
Parameters: - columnID (int) – Unique column Id associated with the column.
- sortOption (
NXOpen.BlockStyler.TreeColumnSortOption
) – Column sort option.
New in version NX7.5.0.
License requirements: None.
SetColumnSortable¶
-
Tree.
SetColumnSortable
¶ Sets the flag indicating whether the column is sortable.
Signature
SetColumnSortable(columnID, isSortable)
Parameters: - columnID (int) – Unique column Id associated with the column.
- isSortable (bool) – Flag indicating whether the column is sortable.
New in version NX7.5.0.
License requirements: None.
SetColumnTitle¶
-
Tree.
SetColumnTitle
¶ Sets the column title.
Signature
SetColumnTitle(columnID, columnHeaderTitle)
Parameters: - columnID (int) – Unique column Id associated with the column.
- columnHeaderTitle (str) – Column header title.
New in version NX7.5.0.
License requirements: None.
SetColumnVisible¶
-
Tree.
SetColumnVisible
¶ Sets the flag indicating whether the column is visible
Signature
SetColumnVisible(columnID, isVisible)
Parameters: - columnID (int) – Unique column Id associated with the column
- isVisible (bool) – Flag indicating whether the column is visible
New in version NX7.5.0.
License requirements: None.
SetColumnWidth¶
-
Tree.
SetColumnWidth
¶ Sets the column width
Signature
SetColumnWidth(columnID, columnWidth)
Parameters: - columnID (int) – Unique column Id associated with the column.
- columnWidth (int) – Column width.
New in version NX7.5.0.
License requirements: None.
SetEditOptions¶
-
Tree.
SetEditOptions
¶ Sets the options in edit-control. This method must be used in BlockStyler.Tree.AskEditControlCallback to make available the options in edit-control.
Signature
SetEditOptions(stringArray, defaultIndex)
Parameters: - stringArray (list of str) – Options to be made availabe in edit-control
- defaultIndex (int) – Index for default selection. This is zero based, for instance if it is set to 1 then 2nd option is selected by default during edit operation.
New in version NX7.5.0.
License requirements: None.
SetIsDragAllowedHandler¶
-
Tree.
SetIsDragAllowedHandler
¶ Sets the callback handler for node drag
Signature
SetIsDragAllowedHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetIsDropAllowedHandler¶
-
Tree.
SetIsDropAllowedHandler
¶ Sets the callback handler for node drop
Signature
SetIsDropAllowedHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetOnBeginLabelEditHandler¶
-
Tree.
SetOnBeginLabelEditHandler
¶ Sets the on-begin-label-edit callback
Signature
SetOnBeginLabelEditHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetOnDefaultActionHandler¶
-
Tree.
SetOnDefaultActionHandler
¶ Sets the on select node callback
Signature
SetOnDefaultActionHandler(cb)
Parameters: cb (CallableObject) – Callback. New in version NX7.5.2.
License requirements: None.
SetOnDeleteNodeHandler¶
-
Tree.
SetOnDeleteNodeHandler
¶ Sets on delete node callback
Signature
SetOnDeleteNodeHandler(cb)
Parameters: cb (CallableObject) – Callback. New in version NX6.0.0.
License requirements: None.
SetOnDropHandler¶
-
Tree.
SetOnDropHandler
¶ Sets the callback handler for node drop
Signature
SetOnDropHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetOnEditOptionSelectedHandler¶
-
Tree.
SetOnEditOptionSelectedHandler
¶ Sets the on-end-label-edit callback
Signature
SetOnEditOptionSelectedHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetOnEndLabelEditHandler¶
-
Tree.
SetOnEndLabelEditHandler
¶ Sets the on-end-label-edit callback
Signature
SetOnEndLabelEditHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetOnExpandHandler¶
-
Tree.
SetOnExpandHandler
¶ Sets the on expand callback to the tree.
Signature
SetOnExpandHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetOnInsertColumnHandler¶
-
Tree.
SetOnInsertColumnHandler
¶ Sets the on insert column callback to the tree.
Signature
SetOnInsertColumnHandler(cb)
Parameters: cb (CallableObject) – Callback. New in version NX7.5.0.
License requirements: None.
SetOnInsertNodeHandler¶
-
Tree.
SetOnInsertNodeHandler
¶ Sets the on insert node callback.
Signature
SetOnInsertNodeHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX6.0.0.
License requirements: None.
SetOnPreSelectHandler¶
-
Tree.
SetOnPreSelectHandler
¶ Sets on pre select callback
Signature
SetOnPreSelectHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetOnSelectHandler¶
-
Tree.
SetOnSelectHandler
¶ Sets the on select node callback
Signature
SetOnSelectHandler(cb)
Parameters: cb (CallableObject) – Callback. New in version NX7.5.0.
License requirements: None.
SetOnStateChangeHandler¶
-
Tree.
SetOnStateChangeHandler
¶ Sets the on state change callback.
Signature
SetOnStateChangeHandler(cb)
Parameters: cb (CallableObject) – Callback New in version NX7.5.0.
License requirements: None.
SetPreSelectionTimeOut¶
-
Tree.
SetPreSelectionTimeOut
¶ Sets the pre selection time out.
BlockStyler.Tree.OnPreSelectCallback is called based on this value.
Signature
SetPreSelectionTimeOut(timeOut)
Parameters: timeOut (float) – Time in millisecond New in version NX7.5.0.
License requirements: None.