## On this page

  

 

 # `Surface`

 Last update: 09.03.2026 

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

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

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

Defines a Surface.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets the list of children.

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

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

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

Gets or sets the CoordinateSystem.

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

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

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

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

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

Gets the internal object. For advanced usage only.

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

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

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

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

### Surface.Activate()

Activate the current object.

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

### Surface.AddComment()

Creates a new child Comment.

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

### Surface.AddFigure()

Creates a new child Figure.

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

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### Surface.Delete()

Run the Delete action.

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

### Surface.Duplicate()

Creates a copy of the current DataModelObject.

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

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

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

Gets the parameter corresponding to the given property.

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

### Surface.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### Surface.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

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

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

Get a property by its unique name.

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

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

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