.. vale off



:class:`Tree`
=============

.. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Tree

   Bases: :py:obj:`object`


   
   Tree class.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: Tree

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~Refresh`
            - Refreshes the tree.
          * - :py:attr:`~Suspend`
            - Prevents the tree from being updated.
          * - :py:attr:`~GetPathToFirstActiveObject`
            - Gets the full path that needs to be typed in order to go to the selected object.
          * - :py:attr:`~Find`
            - Find method.
          * - :py:attr:`~Sort`
            - Sorts the tree objects based on given parameters.
          * - :py:attr:`~ClearSort`
            - Clears the current sort.
          * - :py:attr:`~Filter`
            - Filters the tree objects based on given parameters.
          * - :py:attr:`~ClearFilter`
            - Clears the current filter.
          * - :py:attr:`~Group`
            - Groups a list of objects together.
          * - :py:attr:`~Group`
            - Moves dataModelObject to new tree grouping folder.
          * - :py:attr:`~Ungroup`
            - Removes groupingFolder from the tree.
          * - :py:attr:`~Activate`
            - selects an object in the tree.
          * - :py:attr:`~Activate`
            - Activate method.
          * - :py:attr:`~IsSorted`
            - Checks if the tree is currently sorted alphabetically.


   .. tab-item:: Properties

      .. list-table::
          :header-rows: 0
          :widths: auto

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







Property detail
---------------
.. py:property:: FirstActiveObject
   :no-index:
   :type: Optional[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

   
   Gets the first object selected in the tree.
















   ..
       !! processed by numpydoc !!

.. py:property:: ActiveObjects
   :no-index:
   :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]]

   
   Gets a list of all selected objects.
















   ..
       !! processed by numpydoc !!

.. py:property:: AllObjects
   :no-index:
   :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]]

   
   Gets a list of all objects available in the tree.
















   ..
       !! processed by numpydoc !!

.. py:property:: GroupingFoldersVisible
   :no-index:
   :type: Optional[System.Boolean]

   
   Controls whether or not group folders are visible.
















   ..
       !! processed by numpydoc !!

.. py:property:: CurrentFilter
   :no-index:
   :type: Optional[Ansys.Common.Interop.DSObjectTypes.DSTreeSearchType]

   
   Gets the current filter applied on the tree.
















   ..
       !! processed by numpydoc !!

.. py:property:: CurrentSearchString
   :no-index:
   :type: Optional[System.String]

   
   Gets the current search string (name/tag/propertyName/propertyValue).
















   ..
       !! processed by numpydoc !!

.. py:property:: CurrentSearchState
   :no-index:
   :type: Optional[Ansys.Mechanical.DataModel.Enums.ObjectState]

   
   Gets the current search state.
















   ..
       !! processed by numpydoc !!

.. py:property:: CurrentSearchGraphics
   :no-index:
   :type: Optional[Ansys.Mechanical.DataModel.Enums.VisibilityType]

   
   Gets the current visibility.
















   ..
       !! processed by numpydoc !!





Method detail
-------------
.. py:method:: Refresh() -> System.Void
   :no-index:

   Refreshes the tree.

   ..
       !! processed by numpydoc !!

.. py:method:: Suspend() -> System.IDisposable
   :no-index:

   Prevents the tree from being updated.

   ..
       !! processed by numpydoc !!

.. py:method:: GetPathToFirstActiveObject() -> System.String
   :no-index:

   Gets the full path that needs to be typed in order to go to the selected object.

   ..
       !! processed by numpydoc !!

.. py:method:: Find(name: System.String, func: System.Func[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject,System.Boolean], tag: System.String, state: Ansys.Mechanical.DataModel.Enums.ObjectState) -> System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]
   :no-index:

   Find method.

   ..
       !! processed by numpydoc !!

.. py:method:: Sort(type: Ansys.Mechanical.DataModel.Enums.SortingType, reverse: System.Boolean) -> System.Void
   :no-index:
.. code-block:: text

   Sorts the tree objects based on given parameters.
   type
   reverse

..
       !! processed by numpydoc !!

.. py:method:: ClearSort() -> System.Void
   :no-index:

   Clears the current sort.

   ..
       !! processed by numpydoc !!

.. py:method:: Filter(name: System.String, tag: System.String, 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: System.String, environment: Ansys.ACT.Automation.Mechanical.Analysis, scoping: Ansys.Mechanical.DataModel.Enums.TreeFilterScopingType, filterState: Ansys.Mechanical.DataModel.Enums.TreeFilterObjectState, propertyName: System.String, propertyValue: System.String) -> System.Void
   :no-index:

   Filters the tree objects based on given parameters.

   ..
       !! processed by numpydoc !!

.. py:method:: ClearFilter() -> System.Void
   :no-index:

   Clears the current filter.

   ..
       !! processed by numpydoc !!

.. py:method:: Group(dataModelObjects: System.Collections.IEnumerable) -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
   :no-index:

   Groups a list of objects together.

   ..
       !! processed by numpydoc !!

.. py:method:: Group(dataModelObject: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
   :no-index:

   Moves dataModelObject to new tree grouping folder.

   ..
       !! processed by numpydoc !!

.. py:method:: Ungroup(groupingFolder: Ansys.ACT.Automation.Mechanical.TreeGroupingFolder) -> System.Void
   :no-index:

   Removes groupingFolder from the tree.

   ..
       !! processed by numpydoc !!

.. py:method:: Activate(dataModelObject: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) -> System.Void
   :no-index:

   selects an object in the tree.

   ..
       !! processed by numpydoc !!

.. py:method:: Activate(dataModelObjects: System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) -> System.Void
   :no-index:

   Activate method.

   ..
       !! processed by numpydoc !!

.. py:method:: IsSorted() -> System.Boolean
   :no-index:

   Checks if the tree is currently sorted alphabetically.

   ..
       !! processed by numpydoc !!



.. vale on