## On this page

  

 

 # `MatchControl`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MeshControls.MatchControl"></a>

#### *class* Ansys.ACT.Automation.Mechanical.MeshControls.MatchControl

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

Defines a MatchControl.

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

## Overview

### Methods

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

NameDescription[`Children`](#MatchControl.Children)Gets the list of children.[`Comments`](#MatchControl.Comments)Gets the list of associated comments.[`ControlMessages`](#MatchControl.ControlMessages)Gets the ControlMessages.[`DataModelObjectCategory`](#MatchControl.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Figures`](#MatchControl.Figures)Gets the list of associated figures.[`HighCoordinateSystem`](#MatchControl.HighCoordinateSystem)Gets or sets the HighCoordinateSystem.[`HighGeometrySelection`](#MatchControl.HighGeometrySelection)Gets or sets the HighGeometrySelection.[`HighNamedSelection`](#MatchControl.HighNamedSelection)Gets or sets the HighNamedSelection.[`Images`](#MatchControl.Images)Gets the list of associated images.[`InternalObject`](#MatchControl.InternalObject)Gets the internal object. For advanced usage only.[`LowCoordinateSystem`](#MatchControl.LowCoordinateSystem)Gets or sets the LowCoordinateSystem.[`LowGeometrySelection`](#MatchControl.LowGeometrySelection)Gets or sets the LowGeometrySelection.[`LowNamedSelection`](#MatchControl.LowNamedSelection)Gets or sets the LowNamedSelection.[`Properties`](#MatchControl.Properties)Gets the list of properties for this object.[`RotationAxis`](#MatchControl.RotationAxis)Gets or sets the RotationAxis.[`ScopingMethod`](#MatchControl.ScopingMethod)Gets or sets the ScopingMethod.[`Suppressed`](#MatchControl.Suppressed)Gets or sets the Suppressed.[`Transformation`](#MatchControl.Transformation)Gets or sets the Transformation.[`VisibleProperties`](#MatchControl.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

<a id="MatchControl.ControlMessages"></a>

### *property* MatchControl.ControlMessages *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ControlMessages.

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

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

Gets the current DataModelObject’s category.

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

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

Gets the list of associated figures.

<a id="MatchControl.HighCoordinateSystem"></a>

### *property* MatchControl.HighCoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../CoordinateSystem.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the HighCoordinateSystem.

<a id="MatchControl.HighGeometrySelection"></a>

### *property* MatchControl.HighGeometrySelection *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the HighGeometrySelection.

<a id="MatchControl.HighNamedSelection"></a>

### *property* MatchControl.HighNamedSelection *: [Ansys.ACT.Automation.Mechanical.NamedSelection](../NamedSelection.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.NamedSelection) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the HighNamedSelection.

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

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

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

<a id="MatchControl.LowCoordinateSystem"></a>

### *property* MatchControl.LowCoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../CoordinateSystem.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LowCoordinateSystem.

<a id="MatchControl.LowGeometrySelection"></a>

### *property* MatchControl.LowGeometrySelection *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LowGeometrySelection.

<a id="MatchControl.LowNamedSelection"></a>

### *property* MatchControl.LowNamedSelection *: [Ansys.ACT.Automation.Mechanical.NamedSelection](../NamedSelection.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.NamedSelection) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LowNamedSelection.

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

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

### *property* MatchControl.RotationAxis *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../CoordinateSystem.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RotationAxis.

<a id="MatchControl.ScopingMethod"></a>

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

Gets or sets the ScopingMethod.

<a id="MatchControl.Suppressed"></a>

### *property* MatchControl.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="MatchControl.Transformation"></a>

### *property* MatchControl.Transformation *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Transformation.

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

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

### MatchControl.Activate()

Activate the current object.

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

### MatchControl.AddComment()

Creates a new child Comment.

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

### MatchControl.AddFigure()

Creates a new child Figure.

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

### MatchControl.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="MatchControl.CopyTo"></a>

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

<a id="MatchControl.Delete"></a>

### MatchControl.Delete()

Run the Delete action.

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

### MatchControl.Duplicate()

Creates a copy of the current DataModelObject.

<a id="MatchControl.GenerateMesh"></a>

### MatchControl.GenerateMesh()

Generate the Mesh.

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

### MatchControl.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="MatchControl.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### MatchControl.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### MatchControl.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### MatchControl.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="MatchControl.PropertyByName"></a>

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

Get a property by its unique name.

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

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

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

<a id="MatchControl.RenameBasedOnDefinition"></a>

### MatchControl.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.