## On this page

  

 

 # `NamedSelection`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.NamedSelection"></a>

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

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

Defines a NamedSelection.

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

## Overview

### Methods

NameDescription[`Activate`](#NamedSelection.Activate)Activate the current object.[`AddComment`](#NamedSelection.AddComment)Creates a new child Comment.[`AddFigure`](#NamedSelection.AddFigure)Creates a new child Figure.[`AddImage`](#NamedSelection.AddImage)Creates a new child Image.[`CopyTo`](#NamedSelection.CopyTo)Copies all visible properties from this object to another.[`CreateNodalNamedSelection`](#NamedSelection.CreateNodalNamedSelection)Creates a new Named Selection object containing all the nodes from the entities in the current named selection .[`CreateParameter`](#NamedSelection.CreateParameter)Creates a new parameter for a Property.[`Delete`](#NamedSelection.Delete)Run the Delete action.[`Duplicate`](#NamedSelection.Duplicate)Creates a copy of the current DataModelObject.[`ExportNamedSelectionToCDBFile`](#NamedSelection.ExportNamedSelectionToCDBFile)Export Named Selection to CDB file[`ExportToTextFile`](#NamedSelection.ExportToTextFile)Run the ExportToTextFile action.[`Generate`](#NamedSelection.Generate)Generates the selection based on the generation criteria.[`GetChildren`](#NamedSelection.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#NamedSelection.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#NamedSelection.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#NamedSelection.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#NamedSelection.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#NamedSelection.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#NamedSelection.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`Children`](#NamedSelection.Children)Gets the list of children.[`Comments`](#NamedSelection.Comments)Gets the list of associated comments.[`CrackFrontNumber`](#NamedSelection.CrackFrontNumber)Gets the CrackFrontNumber.[`CreatedForCrack`](#NamedSelection.CreatedForCrack)Gets the CreatedForCrack.[`DataModelObjectCategory`](#NamedSelection.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Figures`](#NamedSelection.Figures)Gets the list of associated figures.[`GenerationCriteria`](#NamedSelection.GenerationCriteria)Returns the generation criteria that is used to generate the selection.[`Images`](#NamedSelection.Images)Gets the list of associated images.[`IncludeProgramControlledInflation`](#NamedSelection.IncludeProgramControlledInflation)Gets or sets the IncludeProgramControlledInflation.[`InternalObject`](#NamedSelection.InternalObject)Gets the internal object. For advanced usage only.[`LSDynaUserId`](#NamedSelection.LSDynaUserId)Gets or sets the LSDynaUserId.[`Location`](#NamedSelection.Location)Gets or sets the Location.[`PreserveDuringSolve`](#NamedSelection.PreserveDuringSolve)Gets or sets the PreserveDuringSolve.[`Properties`](#NamedSelection.Properties)Gets the list of properties for this object.[`Protected`](#NamedSelection.Protected)Gets or sets how the corresponding contact entities (faces, edges or vertices) are protected while meshing. Default:Program Controlled[`ReadOnly`](#NamedSelection.ReadOnly)Gets or sets the ReadOnly.[`RelativeTolerance`](#NamedSelection.RelativeTolerance)Gets or sets the RelativeTolerance.[`ScopingMethod`](#NamedSelection.ScopingMethod)Gets or sets the ScopingMethod.[`SendAs`](#NamedSelection.SendAs)Gets or sets the SendAs.[`SendToSolver`](#NamedSelection.SendToSolver)Gets or sets the SendToSolver.[`Suppressed`](#NamedSelection.Suppressed)Gets the Suppressed.[`ToleranceType`](#NamedSelection.ToleranceType)Gets or sets the ToleranceType.[`TotalSelection`](#NamedSelection.TotalSelection)Gets the TotalSelection.[`Type`](#NamedSelection.Type)Gets the Type.[`UsedByMeshWorksheet`](#NamedSelection.UsedByMeshWorksheet)Gets the UsedByMeshWorksheet.[`Visible`](#NamedSelection.Visible)Gets or sets the Visible.[`VisibleProperties`](#NamedSelection.VisibleProperties)Gets the list of properties that are visible for this object.[`ZeroTolerance`](#NamedSelection.ZeroTolerance)Gets or sets the ZeroTolerance.<a id="property-detail"></a>

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

<a id="NamedSelection.CrackFrontNumber"></a>

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

Gets the CrackFrontNumber.

<a id="NamedSelection.CreatedForCrack"></a>

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

Gets the CreatedForCrack.

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

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

Gets the current DataModelObject’s category.

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

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

Gets the list of associated figures.

<a id="NamedSelection.GenerationCriteria"></a>

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

Returns the generation criteria that is used to generate the selection.

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

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

Gets the list of associated images.

<a id="NamedSelection.IncludeProgramControlledInflation"></a>

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

Gets or sets the IncludeProgramControlledInflation.

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

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

Gets the internal object. For advanced usage only.

<a id="NamedSelection.LSDynaUserId"></a>

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

Gets or sets the LSDynaUserId.

<a id="NamedSelection.Location"></a>

### *property* NamedSelection.Location *: [Ansys.ACT.Interfaces.Common.ISelectionInfo](../../Interfaces/Common/ISelectionInfo.md#ansys.mechanical.stubs.v252.Ansys.ACT.Interfaces.Common.ISelectionInfo) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="NamedSelection.PreserveDuringSolve"></a>

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

Gets or sets the PreserveDuringSolve.

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

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

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

Gets or sets how the corresponding contact entities (faces, edges or vertices) are protected while meshing. Default:Program Controlled

<a id="NamedSelection.ReadOnly"></a>

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

Gets or sets the ReadOnly.

<a id="NamedSelection.RelativeTolerance"></a>

### *property* NamedSelection.RelativeTolerance *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RelativeTolerance.

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

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

Gets or sets the ScopingMethod.

<a id="NamedSelection.SendAs"></a>

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

Gets or sets the SendAs.

<a id="NamedSelection.SendToSolver"></a>

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

Gets or sets the SendToSolver.

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

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

Gets the Suppressed.

<a id="NamedSelection.ToleranceType"></a>

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

Gets or sets the ToleranceType.

<a id="NamedSelection.TotalSelection"></a>

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

Gets the TotalSelection.

<a id="NamedSelection.Type"></a>

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

Gets the Type.

<a id="NamedSelection.UsedByMeshWorksheet"></a>

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

Gets the UsedByMeshWorksheet.

<a id="NamedSelection.Visible"></a>

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

Gets or sets the Visible.

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

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

### *property* NamedSelection.ZeroTolerance *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ZeroTolerance.

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

## Method detail

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

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

Activate the current object.

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

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

Creates a new child Comment.

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

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

Creates a new child Figure.

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

### NamedSelection.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v252.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="NamedSelection.CopyTo"></a>

### NamedSelection.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="NamedSelection.CreateNodalNamedSelection"></a>

### NamedSelection.CreateNodalNamedSelection() → [Ansys.ACT.Automation.Mechanical.NamedSelection](#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.NamedSelection)

Creates a new Named Selection object containing all the nodes from the entities in the current named selection .

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

### NamedSelection.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="NamedSelection.Delete"></a>

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

Run the Delete action.

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

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

Creates a copy of the current DataModelObject.

<a id="NamedSelection.ExportNamedSelectionToCDBFile"></a>

### NamedSelection.ExportNamedSelectionToCDBFile(filepath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

Export Named Selection to CDB file

<a id="NamedSelection.ExportToTextFile"></a>

### NamedSelection.ExportToTextFile(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

Run the ExportToTextFile action.

<a id="NamedSelection.Generate"></a>

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

Generates the selection based on the generation criteria.

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

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

### NamedSelection.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="NamedSelection.GroupAllSimilarChildren"></a>

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

Run the GroupAllSimilarChildren action.

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

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

Run the GroupSimilarObjects action.

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

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

### NamedSelection.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="NamedSelection.RemoveParameter"></a>

### NamedSelection.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.