Class: Tree

Methods

Name Description
Activate(IDataModelObject) selects an object in the tree.
Activate(IEnumerable<IDataModelObject>) Multi-selects a list of objects in the tree.
ClearFilter() Clears the current filter.
ClearSort() Clears the current sort.
Filter(String, String, ObjectState, VisibilityType, TreeFilterObjectClass, CoordinateSystem, String, Analysis, TreeFilterScopingType, TreeFilterObjectState, String, String) Filters the tree objects based on given parameters.
Find(String, Func<IDataModelObject, Boolean>, String, ObjectState) Gets a list of all objects with the specified parameters.
GetPathToFirstActiveObject() Gets the full path that needs to be typed in order to go to the selected object.
Group(IEnumerable) Groups a list of objects together.
Group(IDataModelObject) Moves dataModelObject to new tree grouping folder.
IsSorted() Checks if the tree is currently sorted alphabetically.
Refresh() Refreshes the tree.
Sort(SortingType, Boolean) Sorts the tree objects based on given parameters. Type of sorting to apply.Wheter to sort in reverse order. Note that all parameters of Sort are optional. type: Defaults to alphabetical reverse: Defaults to false sorting in reverse order is currently not supported Usage example - sort alphabetically ExtAPI.DataModel.Tree.Sort() Usage example - sort alphabetically ExtAPI.DataModel.Tree.Find(type=SortingType.Alphabetical, reverse=False)
Suspend() ***OBSOLETE*** Use 'Transaction' instead. Prevents the tree from being updated.
Ungroup(TreeGroupingFolder) Removes groupingFolder from the tree.

Properties

Name Description
ActiveObjects Gets a list of all selected objects.
AllObjects Gets a list of all objects available in the tree.
CurrentFilter Gets the current filter applied on the tree.
CurrentSearchGraphics Gets the current visibility.
CurrentSearchState Gets the current search state.
CurrentSearchString Gets the current search string (name/tag/propertyName/propertyValue).
FirstActiveObject Gets the first object selected in the tree.
GroupingFoldersVisible Controls whether or not group folders are visible.