Void Tree.Filter(String name, String tag, ObjectState state, VisibilityType visibility, TreeFilterObjectClass type, CoordinateSystem coordinateSystem, String model, Analysis environment, TreeFilterScopingType scoping, TreeFilterObjectState filterState, String propertyName, String propertyValue, Nullable<Boolean> invertSearchResults)

Filters the tree objects based on given parameters.

Remarks

Note that the tree can be filtered by only one thing at a time, so a maximum of one parameter can be changed from its default value. name: Defaults to "" tag: Defaults to "" state: Defaults to ObjectState.NoState visibility: Defaults to VisibilityType.All type: TreeFilterObjectClass.All coordinateSystem: None model: "All" environment: None scoping: TreeFilterScopingType.All filterState: TreeFilterObjectState.All propertyName: Defaults to "" propertyValue: Defaults to ""

Examples

The following example filters the tree for objects with a state of Suppressed. ExtAPI.DataModel.Tree.Filter(filterState=TreeFilterObjectState.Suppressed)
The following example filters the tree for objects with names who contain "Reaction". ExtAPI.DataModel.Tree.Filter(name="Reaction")
The following example filters the tree for objects that are visible. ExtAPI.DataModel.Tree.Filter(visibility=VisibilityType.Visible)
The following example filters the tree for objects that are part of the current model. ExtAPI.DataModel.Tree.Filter(model="Current")

Parameters

  • name
    Type: String
    Filter by a given name.
  • tag
    Type: String
    Filter by a given tag.
  • state
    Type: ObjectState
    Filter by Suppression state.
  • visibility
    Type: VisibilityType
    Filter by Visibile/Invisible objects.
  • type
    Type: TreeFilterObjectClass
    Filter by object Type.
  • coordinateSystem
    Type: CoordinateSystem
    Filter by Coordinate System scoping.
  • model
    Type: String
    Filter by Model ("All", "Current", "Dropdown String").
  • environment
    Type: Analysis
    Filter by Environment.
  • scoping
    Type: TreeFilterScopingType
    Filter by Scoping.
  • filterState
    Type: TreeFilterObjectState
    Filter by object State.
  • propertyName
    Type: String
    Filter by Property Name.
  • propertyValue
    Type: String
    Filter by Property Value.
  • invertSearchResults
    Type: Nullable<Boolean>
    Flag to invert the search results.