Tree
#
Overview#
selects an object in the tree. |
|
Clears the current filter. |
|
Clears the current sort. |
|
Filters the tree objects based on given parameters. |
|
Find method. |
|
Gets the full path that needs to be typed in order to go to the selected object. |
|
Groups a list of objects together. |
|
Checks if the tree is currently sorted alphabetically. |
|
Refreshes the tree. |
|
Sorts the tree objects based on given parameters. |
|
Prevents the tree from being updated. |
|
Removes groupingFolder from the tree. |
Gets a list of all selected objects. |
|
Gets a list of all objects available in the tree. |
|
Gets the current filter applied on the tree. |
|
Gets the current visibility. |
|
Gets the current search state. |
|
Gets the current search string (name/tag/propertyName/propertyValue). |
|
Gets the first object selected in the tree. |
|
Controls whether or not group folders are visible. |
Property detail#
- property Tree.ActiveObjects: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets a list of all selected objects.
- property Tree.AllObjects: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets a list of all objects available in the tree.
- property Tree.CurrentFilter: Ansys.Common.Interop.DSObjectTypes.DSTreeSearchType | None#
Gets the current filter applied on the tree.
- property Tree.CurrentSearchGraphics: Ansys.Mechanical.DataModel.Enums.VisibilityType | None#
Gets the current visibility.
- property Tree.CurrentSearchState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#
Gets the current search state.
- property Tree.CurrentSearchString: str | None#
Gets the current search string (name/tag/propertyName/propertyValue).
Method detail#
- Tree.Activate(dataModelObject: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) None #
selects an object in the tree.
- Tree.Filter(name: str, tag: str, state: Ansys.Mechanical.DataModel.Enums.ObjectState, visibility: Ansys.Mechanical.DataModel.Enums.VisibilityType, type: Ansys.Mechanical.DataModel.Enums.TreeFilterObjectClass, coordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem, model: str, environment: Ansys.ACT.Automation.Mechanical.Analysis, scoping: Ansys.Mechanical.DataModel.Enums.TreeFilterScopingType, filterState: Ansys.Mechanical.DataModel.Enums.TreeFilterObjectState, propertyName: str, propertyValue: str) None #
Filters the tree objects based on given parameters.
- Tree.Find(name: str, func: System.Func[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject, bool], tag: str, state: Ansys.Mechanical.DataModel.Enums.ObjectState) Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] #
Find method.
- Tree.GetPathToFirstActiveObject() str #
Gets the full path that needs to be typed in order to go to the selected object.
- Tree.Group(dataModelObjects: Iterable) Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Groups a list of objects together.
- Tree.Sort(type: Ansys.Mechanical.DataModel.Enums.SortingType, reverse: bool) None #
Sorts the tree objects based on given parameters.
type
reverse
- Tree.Suspend() System.IDisposable #
Prevents the tree from being updated.
- Tree.Ungroup(groupingFolder: Ansys.ACT.Automation.Mechanical.TreeGroupingFolder) None #
Removes groupingFolder from the tree.