`TreeGroupingFolder`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Defines a TreeGroupingFolder.

Overview#

Methods

`DeleteTreeGroupAndChildren`	Run the DeleteTreeGroupAndChildren action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`Suppressed`	Gets or sets the Suppressed.
`InternalObject`	Gets the internal object. For advanced usage only.
`ChildrenInGroup`	Gets the ChildrenInGroup.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

property TreeGroupingFolder.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property TreeGroupingFolder.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTreeGroupingFolderAuto | None: Gets the internal object. For advanced usage only.

property TreeGroupingFolder.ChildrenInGroup: System.UInt32 | None: Gets the ChildrenInGroup.

property TreeGroupingFolder.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property TreeGroupingFolder.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property TreeGroupingFolder.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property TreeGroupingFolder.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property TreeGroupingFolder.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property TreeGroupingFolder.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

TreeGroupingFolder.DeleteTreeGroupAndChildren() → System.Void: Run the DeleteTreeGroupAndChildren action.

TreeGroupingFolder.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

TreeGroupingFolder.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

TreeGroupingFolder.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

TreeGroupingFolder.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

TreeGroupingFolder.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

TreeGroupingFolder.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

TreeGroupingFolder.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

TreeGroupingFolder.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

TreeGroupingFolder.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

TreeGroupingFolder.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

TreeGroupingFolder.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.