TreeGroupingFolder

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder(internalObject: Any)

Bases: object

Defines a TreeGroupingFolder.

Overview

Methods

Activate	Activate the current object.
AddObject	Adds an object to this folder
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
DeleteTreeGroupAndChildren	Run the DeleteTreeGroupAndChildren action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.
Ungroup	Run the Ungroup action.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ChildrenInGroup	Gets the ChildrenInGroup.
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
State	State property.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property TreeGroupingFolder.AttachedRefs: List[int] | None

AttachedRefs property.

property TreeGroupingFolder.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property TreeGroupingFolder.ChildrenInGroup: int | None

Gets the ChildrenInGroup.

property TreeGroupingFolder.ClsId: int | None

ClsId property.

property TreeGroupingFolder.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property TreeGroupingFolder.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property TreeGroupingFolder.IconName: str | None

IconName property.

property TreeGroupingFolder.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property TreeGroupingFolder.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTreeGroupingFolderAuto | None

Gets the internal object. For advanced usage only.

property TreeGroupingFolder.Name: str | None

Name property.

property TreeGroupingFolder.ObjectId: int | None

ObjectId property.

property TreeGroupingFolder.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property TreeGroupingFolder.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property TreeGroupingFolder.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property TreeGroupingFolder.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property TreeGroupingFolder.ReadOnly: bool | None

Gets or sets the ReadOnly.

property TreeGroupingFolder.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property TreeGroupingFolder.Suppressed: bool | None

Gets or sets the Suppressed.

property TreeGroupingFolder.TransferableObjectId: str | None

TransferableObjectId property.

property TreeGroupingFolder.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

TreeGroupingFolder.Activate() → None

Activate the current object.

TreeGroupingFolder.AddObject(child: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → None

Adds an object to this folder

TreeGroupingFolder.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

TreeGroupingFolder.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

TreeGroupingFolder.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

TreeGroupingFolder.DeleteTreeGroupAndChildren() → None

Run the DeleteTreeGroupAndChildren action.

TreeGroupingFolder.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

TreeGroupingFolder.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

TreeGroupingFolder.GetAPIName(dispId: int) → str

Property name bound to dispId.

TreeGroupingFolder.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

TreeGroupingFolder.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

TreeGroupingFolder.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

TreeGroupingFolder.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

TreeGroupingFolder.GetHashCode() → int

GetHashCode method.

TreeGroupingFolder.GetIconFile() → System.Byte

GetIconFile method.

TreeGroupingFolder.GetLifetimeService() → Any

GetLifetimeService method.

TreeGroupingFolder.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

TreeGroupingFolder.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

TreeGroupingFolder.GetPath() → str

GetPath method.

TreeGroupingFolder.GetPropertyName(dispId: int) → str

GetPropertyName method.

TreeGroupingFolder.GetPropertyValue(name: str) → Any

GetPropertyValue method.

TreeGroupingFolder.GetType() → type

GetType method.

TreeGroupingFolder.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

TreeGroupingFolder.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

TreeGroupingFolder.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

TreeGroupingFolder.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

TreeGroupingFolder.InitializeLifetimeService() → Any

InitializeLifetimeService method.

TreeGroupingFolder.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

TreeGroupingFolder.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

TreeGroupingFolder.PropertyByAPIName(name: str) → 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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

TreeGroupingFolder.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

TreeGroupingFolder.RemoveParameter(propName: str) → None

Removes the parameter from the parameter set corresponding to the given property.

TreeGroupingFolder.ToString() → str

ToString method.

TreeGroupingFolder.Ungroup() → None

Run the Ungroup action.