## On this page

  

 

 # `BoltTool`

 Last update: 09.03.2026 

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

#### *class* Ansys.ACT.Automation.Mechanical.Results.BoltToolResults.BoltTool

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

Defines a BoltTool.

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

## Overview

### Methods

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

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

## Property detail

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

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

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

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

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

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

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

Gets the internal object. For advanced usage only.

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

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

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

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

Activate the current object.

<a id="BoltTool.AddAdjustment"></a>

### BoltTool.AddAdjustment() → [Ansys.ACT.Automation.Mechanical.Results.BoltToolResults.BoltAdjustment](BoltAdjustment.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.BoltToolResults.BoltAdjustment)

Creates a new BoltAdjustment

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

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

Creates a new child Comment.

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

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

Creates a new child Figure.

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

### BoltTool.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="BoltTool.AddWorkingLoad"></a>

### BoltTool.AddWorkingLoad() → [Ansys.ACT.Automation.Mechanical.Results.BoltToolResults.BoltWorkingLoad](BoltWorkingLoad.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.BoltToolResults.BoltWorkingLoad)

Creates a new BoltWorkingLoad

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

### BoltTool.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="BoltTool.CreateParameter"></a>

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

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

Run the Delete action.

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

### BoltTool.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="BoltTool.EvaluateAllResults"></a>

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

Run the EvaluateAllResults action.

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

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

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

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

Run the GroupAllSimilarChildren action.

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

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

Run the GroupSimilarObjects action.

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

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

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

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