## On this page

  

 

 # `TableGroup`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.TableGroup"></a>

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

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

Defines a TableGroup.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

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

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

Gets the list of associated figures.

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

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

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

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

### *property* TableGroup.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="TableGroup.VisibleProperties"></a>

### *property* TableGroup.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="TableGroup.Activate"></a>

### TableGroup.Activate()

Activate the current object.

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

### TableGroup.AddComment()

Creates a new child Comment.

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

### TableGroup.AddFigure()

Creates a new child Figure.

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

### TableGroup.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="TableGroup.AddTable"></a>

### TableGroup.AddTable(activate: [bool](https://docs.python.org/3/library/functions.html#bool), expandGroup: [bool](https://docs.python.org/3/library/functions.html#bool))

Create the object for working with an imported part.

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

### TableGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

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

### TableGroup.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

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

### TableGroup.Duplicate()

Creates a copy of the current DataModelObject.

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

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

Gets the list of children, filtered by type.

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

### TableGroup.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

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

### TableGroup.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### TableGroup.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### TableGroup.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="TableGroup.PropertyByName"></a>

### TableGroup.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

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

### TableGroup.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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