Mechanical scripting interface 2025

`Stage`

Last update: 09.03.2026

class Ansys.ACT.Automation.Mechanical.Stage

Bases: object

Defines a Stage.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
GetChildren Gets the list of children, filtered by type.
GetHarmonicIndexForEnvironmentByIndex Gets the worksheet harmonic index for a given environment at index.
GetHarmonicIndexNumberForEnvironment Gets the worksheet number of harmonic indexes for a given environment.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
SetHarmonicIndexForEnvironmentByIndex Sets the worksheet harmonic index for a given environment at index.
SetHarmonicIndexNumberForEnvironment Sets the worksheet number of harmonic indexes for a given environment.

Properties

Name Description
Behavior Gets the Behavior.
Children Gets the list of children.
Comments Gets the list of associated comments.
CyclicRegion Gets or sets the CyclicRegion.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
StageName Gets the StageName.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property Stage.Behavior : Ansys.Mechanical.DataModel.Enums.StageBehavior | None

Gets the Behavior.

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

Gets the list of children.

property Stage.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Stage.CyclicRegion : Ansys.ACT.Automation.Mechanical.SymmetryGeneral | None

Gets or sets the CyclicRegion.

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

Gets the current DataModelObject’s category.

property Stage.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Stage.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Stage.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSStageAuto | None

Gets the internal object. For advanced usage only.

property Stage.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

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

Gets the list of properties for this object.

property Stage.ReadOnly : bool | None

Gets or sets the ReadOnly.

property Stage.StageName : str | None

Gets the StageName.

property Stage.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

Stage.Activate() → None

Activate the current object.

Stage.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Stage.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

Stage.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

Stage.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

Stage.GetHarmonicIndexForEnvironmentByIndex(envId: int, index: int) → int

Gets the worksheet harmonic index for a given environment at index.

Stage.GetHarmonicIndexNumberForEnvironment(envId: int) → int

Gets the worksheet number of harmonic indexes for a given environment.

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

Gets the parameter corresponding to the given property.

Stage.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Stage.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.

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

Get a property by its unique name.

Stage.RemoveParameter(propName: str) → None

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

Stage.SetHarmonicIndexForEnvironmentByIndex(envId: int, index: int, newVal: int) → None

Sets the worksheet harmonic index for a given environment at index.

Stage.SetHarmonicIndexNumberForEnvironment(envId: int, newVal: int) → None

Sets the worksheet number of harmonic indexes for a given environment.

Connect with Ansys