Explorer Class¶
-
class
NXOpen.BlockStyler.Explorer¶ Bases:
NXOpen.BlockStyler.UIBlockRepresents an Explorer block.
The Explorer block allows for collecting a large number of inputs into a single dialog. The inputs are organized into nodes and sub-nodes on a tree to allow for quick and easy navigation. The Explorer block provides the ability to have up to 3 levels of nodes in the Navigation Tree. Each node contains groups and individual inputs that are laid out like standard NX dialogs. When selecting level 1 and level 2 nodes that do not contain any groups and only contain sub-nodes the first sub-node containing groups is highlighted and its content shown.
New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| CurrentNode | Returns or sets the CurrentNode selected in the Navigation Tree. |
| Enable | Returns or sets the Enable. |
| Expanded | Returns or sets the Expanded |
| Group | Returns or sets the Group |
| Label | Returns or sets the Label |
| Localize | Returns or sets the localization of the block label. |
| Members | Returns the members. |
| Name | Returns the name of the block or BlockID |
| Show | Returns or sets the Visibility of block. |
| Tag | Returns the Tag for this object. |
| TreeWidth | Returns or sets the TreeWidth for the Navigation Tree. |
| Type | Returns the type of block |
Methods¶
| Method | Description |
|---|---|
| Focus | Focuses on the block. |
| GetProperties | Returns the properties of the block @return |
| SetChildMembers | Sets the parent member for the child members in the Explorer Navigation Tree. |
| SetNotifyNodeSelectedPostHandler | Sets the NotifyNodeSelectedPost handler. |
| SetNotifyNodeSelectedPreHandler | Sets the NotifyNodeSelectedPre handler. |
Property Detail¶
CurrentNode¶
-
Explorer.CurrentNode¶ Returns or sets the CurrentNode selected in the Navigation Tree.
-------------------------------------Getter Method
Signature
CurrentNode()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CurrentNode(currentNode)Parameters: currentNode (int) – New in version NX9.0.0.
License requirements: None.
Localize¶
-
Explorer.Localize¶ Returns or sets the localization of the block label.
If the label matches an English string in the NX string localization databse and the Localize property is set to true, then the Label is translated to the current locale language.
-------------------------------------Getter Method
Signature
Localize()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Localize(localize)Parameters: localize (bool) – New in version NX9.0.0.
License requirements: None.
Members¶
-
Explorer.Members¶ Returns the members.
-------------------------------------Getter Method
Signature
Members()Returns: Return type: NXOpen.BlockStyler.PropertyListNew in version NX9.0.0.
License requirements: None.
TreeWidth¶
-
Explorer.TreeWidth¶ Returns or sets the TreeWidth for the Navigation Tree.
-------------------------------------Getter Method
Signature
TreeWidth()Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TreeWidth(treeWidth)Parameters: treeWidth (int) – New in version NX11.0.0.
License requirements: None.
Method Detail¶
SetChildMembers¶
-
Explorer.SetChildMembers¶ Sets the parent member for the child members in the Explorer Navigation Tree.
The maximum Navigation Tree depth is 3 levels. An exception is thrown if the parent member depth is already at the maximum allowed depth.
Signature
SetChildMembers(parentMember, childMembers)Parameters: - parentMember (
NXOpen.BlockStyler.UIBlock) – Parent member for the child members. - childMembers (list of
NXOpen.BlockStyler.UIBlock) – Child members for the parent member.
New in version NX9.0.0.
License requirements: None.
- parentMember (