## On this page

  

 

 # `ParameterVariableGroup`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.ParameterVariableGroup"></a>

#### *class* Ansys.ACT.Automation.Mechanical.ParameterVariableGroup

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a ParameterVariableGroup.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#ParameterVariableGroup.Activate)Activate the current object.[`AddComment`](#ParameterVariableGroup.AddComment)Creates a new child Comment.[`AddFigure`](#ParameterVariableGroup.AddFigure)Creates a new child Figure.[`AddImage`](#ParameterVariableGroup.AddImage)Creates a new child Image.[`AddParameterVariable`](#ParameterVariableGroup.AddParameterVariable)Create the object for working with an imported part.[`CopyTo`](#ParameterVariableGroup.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#ParameterVariableGroup.CreateParameter)Creates a new parameter for a Property.[`Duplicate`](#ParameterVariableGroup.Duplicate)Creates a copy of the current DataModelObject.[`GetChildren`](#ParameterVariableGroup.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#ParameterVariableGroup.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#ParameterVariableGroup.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#ParameterVariableGroup.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#ParameterVariableGroup.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#ParameterVariableGroup.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#ParameterVariableGroup.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`Children`](#ParameterVariableGroup.Children)Gets the list of children.[`Comments`](#ParameterVariableGroup.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#ParameterVariableGroup.DataModelObjectCategory)Gets the current DataModelObject's category.[`Figures`](#ParameterVariableGroup.Figures)Gets the list of associated figures.[`Images`](#ParameterVariableGroup.Images)Gets the list of associated images.[`InternalObject`](#ParameterVariableGroup.InternalObject)Gets the internal object. For advanced usage only.[`Properties`](#ParameterVariableGroup.Properties)Gets the list of properties for this object.[`VisibleProperties`](#ParameterVariableGroup.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="ParameterVariableGroup.Children"></a>

### *property* ParameterVariableGroup.Children *: List\[[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="ParameterVariableGroup.Comments"></a>

### *property* ParameterVariableGroup.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="ParameterVariableGroup.DataModelObjectCategory"></a>

### *property* ParameterVariableGroup.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject's category.

<a id="ParameterVariableGroup.Figures"></a>

### *property* ParameterVariableGroup.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](Figure.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="ParameterVariableGroup.Images"></a>

### *property* ParameterVariableGroup.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="ParameterVariableGroup.InternalObject"></a>

### *property* ParameterVariableGroup.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSParameterVariableGroupAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="ParameterVariableGroup.Properties"></a>

### *property* ParameterVariableGroup.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="ParameterVariableGroup.VisibleProperties"></a>

### *property* ParameterVariableGroup.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="method-detail"></a>

## Method detail

<a id="ParameterVariableGroup.Activate"></a>

### ParameterVariableGroup.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

<a id="ParameterVariableGroup.AddComment"></a>

### ParameterVariableGroup.AddComment() → [Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Comment)

Creates a new child Comment.

<a id="ParameterVariableGroup.AddFigure"></a>

### ParameterVariableGroup.AddFigure() → [Ansys.ACT.Automation.Mechanical.Figure](Figure.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Figure)

Creates a new child Figure.

<a id="ParameterVariableGroup.AddImage"></a>

### ParameterVariableGroup.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Image)

```text
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.

```

<a id="ParameterVariableGroup.AddParameterVariable"></a>

### ParameterVariableGroup.AddParameterVariable() → [Ansys.ACT.Automation.Mechanical.ParameterVariable](ParameterVariable.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.ParameterVariable)

Create the object for working with an imported part.

<a id="ParameterVariableGroup.CopyTo"></a>

### ParameterVariableGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

<a id="ParameterVariableGroup.CreateParameter"></a>

### ParameterVariableGroup.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

<a id="ParameterVariableGroup.Duplicate"></a>

### ParameterVariableGroup.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

<a id="ParameterVariableGroup.GetChildren"></a>

### ParameterVariableGroup.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\]) → List\[ChildrenType\]

Gets the list of children, filtered by type.

<a id="ParameterVariableGroup.GetParameter"></a>

### ParameterVariableGroup.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

<a id="ParameterVariableGroup.GroupAllSimilarChildren"></a>

### ParameterVariableGroup.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

<a id="ParameterVariableGroup.GroupSimilarObjects"></a>

### ParameterVariableGroup.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](TreeGroupingFolder.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

<a id="ParameterVariableGroup.PropertyByAPIName"></a>

### ParameterVariableGroup.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

```text
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.

```

<a id="ParameterVariableGroup.PropertyByName"></a>

### ParameterVariableGroup.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

<a id="ParameterVariableGroup.RemoveParameter"></a>

### ParameterVariableGroup.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

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