## On this page

  

 

 # `ObjectiveWorksheet`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.ObjectiveWorksheet"></a>

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

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

ObjectiveWorksheet class.

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

## Overview

### Methods

NameDescription[`AddRow`](#ObjectiveWorksheet.AddRow)Adds a Row to the worksheet.[`DeleteRow`](#ObjectiveWorksheet.DeleteRow)Deletes a row from the worksheet at index.[`GetCriterion`](#ObjectiveWorksheet.GetCriterion)Gets the worksheet Environment property at index.[`GetEnabled`](#ObjectiveWorksheet.GetEnabled)Gets the worksheet Enabled property at row index[`GetEndMode`](#ObjectiveWorksheet.GetEndMode)Gets the worksheet End Mode property at index.[`GetEndStep`](#ObjectiveWorksheet.GetEndStep)Gets the worksheet End Step property at index.[`GetEnvironment`](#ObjectiveWorksheet.GetEnvironment)Gets the worksheet Environment property at index.[`GetFormulation`](#ObjectiveWorksheet.GetFormulation)Gets the worksheet Formulation property at index.[`GetMode`](#ObjectiveWorksheet.GetMode)Gets the worksheet Mode property at index.[`GetMultipleSets`](#ObjectiveWorksheet.GetMultipleSets)Gets the worksheet Multiple Sets property at row index[`GetObjectiveType`](#ObjectiveWorksheet.GetObjectiveType)Gets the Objective Type property at index.[`GetStartMode`](#ObjectiveWorksheet.GetStartMode)Gets the worksheet Start Mode property at index.[`GetStartStep`](#ObjectiveWorksheet.GetStartStep)Gets the worksheet Start Step property at index.[`GetStep`](#ObjectiveWorksheet.GetStep)Gets the worksheet Step property at index.[`GetWeight`](#ObjectiveWorksheet.GetWeight)Gets the worksheet Weight property at index.[`SetCriterion`](#ObjectiveWorksheet.SetCriterion)Sets the worksheet Environment property at index.[`SetEnabled`](#ObjectiveWorksheet.SetEnabled)Sets the worksheet Enabled property at row index.[`SetEndMode`](#ObjectiveWorksheet.SetEndMode)Sets the worksheet End Mode property at index.[`SetEndStep`](#ObjectiveWorksheet.SetEndStep)Sets the worksheet End Step property at index.[`SetEnvironment`](#ObjectiveWorksheet.SetEnvironment)Sets the worksheet Environment property at index.[`SetFormulation`](#ObjectiveWorksheet.SetFormulation)Sets the worksheet Formulation property at index.[`SetMode`](#ObjectiveWorksheet.SetMode)Sets the worksheet Mode property at index.[`SetMultipleSets`](#ObjectiveWorksheet.SetMultipleSets)Sets the worksheet Multiple Sets property at row index.[`SetObjectiveType`](#ObjectiveWorksheet.SetObjectiveType)Sets the ObjectiveType property at index.[`SetStartMode`](#ObjectiveWorksheet.SetStartMode)Sets the worksheet Start Mode property at index.[`SetStartStep`](#ObjectiveWorksheet.SetStartStep)Sets the worksheet Start Step property at index.[`SetStep`](#ObjectiveWorksheet.SetStep)Sets the worksheet Step property at index.[`SetWeight`](#ObjectiveWorksheet.SetWeight)Sets the worksheet Weight property at index.### Properties

NameDescription[`RowCount`](#ObjectiveWorksheet.RowCount)Deletes a row from the worksheet at index.<a id="property-detail"></a>

## Property detail

<a id="ObjectiveWorksheet.RowCount"></a>

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

Deletes a row from the worksheet at index.

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

## Method detail

<a id="ObjectiveWorksheet.AddRow"></a>

### ObjectiveWorksheet.AddRow()

Adds a Row to the worksheet.

<a id="ObjectiveWorksheet.DeleteRow"></a>

### ObjectiveWorksheet.DeleteRow(index: [int](https://docs.python.org/3/library/functions.html#int))

Deletes a row from the worksheet at index.

<a id="ObjectiveWorksheet.GetCriterion"></a>

### ObjectiveWorksheet.GetCriterion(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Environment property at index.

<a id="ObjectiveWorksheet.GetEnabled"></a>

### ObjectiveWorksheet.GetEnabled(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Enabled property at row index

<a id="ObjectiveWorksheet.GetEndMode"></a>

### ObjectiveWorksheet.GetEndMode(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet End Mode property at index.

<a id="ObjectiveWorksheet.GetEndStep"></a>

### ObjectiveWorksheet.GetEndStep(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet End Step property at index.

<a id="ObjectiveWorksheet.GetEnvironment"></a>

### ObjectiveWorksheet.GetEnvironment(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Environment property at index.

<a id="ObjectiveWorksheet.GetFormulation"></a>

### ObjectiveWorksheet.GetFormulation(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Formulation property at index.

<a id="ObjectiveWorksheet.GetMode"></a>

### ObjectiveWorksheet.GetMode(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Mode property at index.

<a id="ObjectiveWorksheet.GetMultipleSets"></a>

### ObjectiveWorksheet.GetMultipleSets(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Multiple Sets property at row index

<a id="ObjectiveWorksheet.GetObjectiveType"></a>

### ObjectiveWorksheet.GetObjectiveType(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the Objective Type property at index.

<a id="ObjectiveWorksheet.GetStartMode"></a>

### ObjectiveWorksheet.GetStartMode(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Start Mode property at index.

<a id="ObjectiveWorksheet.GetStartStep"></a>

### ObjectiveWorksheet.GetStartStep(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Start Step property at index.

<a id="ObjectiveWorksheet.GetStep"></a>

### ObjectiveWorksheet.GetStep(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Step property at index.

<a id="ObjectiveWorksheet.GetWeight"></a>

### ObjectiveWorksheet.GetWeight(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Weight property at index.

<a id="ObjectiveWorksheet.SetCriterion"></a>

### ObjectiveWorksheet.SetCriterion(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [Ansys.ACT.Automation.Mechanical.Criterion](Criterion.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Criterion))

Sets the worksheet Environment property at index.

<a id="ObjectiveWorksheet.SetEnabled"></a>

### ObjectiveWorksheet.SetEnabled(index: [int](https://docs.python.org/3/library/functions.html#int), value: [bool](https://docs.python.org/3/library/functions.html#bool))

Sets the worksheet Enabled property at row index.

<a id="ObjectiveWorksheet.SetEndMode"></a>

### ObjectiveWorksheet.SetEndMode(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [int](https://docs.python.org/3/library/functions.html#int))

Sets the worksheet End Mode property at index.

<a id="ObjectiveWorksheet.SetEndStep"></a>

### ObjectiveWorksheet.SetEndStep(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [int](https://docs.python.org/3/library/functions.html#int))

Sets the worksheet End Step property at index.

<a id="ObjectiveWorksheet.SetEnvironment"></a>

### ObjectiveWorksheet.SetEnvironment(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [Ansys.ACT.Automation.Mechanical.Analysis](Analysis.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Analysis))

Sets the worksheet Environment property at index.

<a id="ObjectiveWorksheet.SetFormulation"></a>

### ObjectiveWorksheet.SetFormulation(index: [int](https://docs.python.org/3/library/functions.html#int), value: [Ansys.Mechanical.DataModel.Enums.TopoObjectiveFormulation](../../../Mechanical/DataModel/Enums/TopoObjectiveFormulation.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.TopoObjectiveFormulation))

Sets the worksheet Formulation property at index.

<a id="ObjectiveWorksheet.SetMode"></a>

### ObjectiveWorksheet.SetMode(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [int](https://docs.python.org/3/library/functions.html#int))

Sets the worksheet Mode property at index.

<a id="ObjectiveWorksheet.SetMultipleSets"></a>

### ObjectiveWorksheet.SetMultipleSets(index: [int](https://docs.python.org/3/library/functions.html#int), value: [bool](https://docs.python.org/3/library/functions.html#bool))

Sets the worksheet Multiple Sets property at row index.

<a id="ObjectiveWorksheet.SetObjectiveType"></a>

### ObjectiveWorksheet.SetObjectiveType(index: [int](https://docs.python.org/3/library/functions.html#int), value: [Ansys.Mechanical.DataModel.Enums.ObjectiveType](../../../Mechanical/DataModel/Enums/ObjectiveType.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.ObjectiveType))

Sets the ObjectiveType property at index.

<a id="ObjectiveWorksheet.SetStartMode"></a>

### ObjectiveWorksheet.SetStartMode(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [int](https://docs.python.org/3/library/functions.html#int))

Sets the worksheet Start Mode property at index.

<a id="ObjectiveWorksheet.SetStartStep"></a>

### ObjectiveWorksheet.SetStartStep(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [int](https://docs.python.org/3/library/functions.html#int))

Sets the worksheet Start Step property at index.

<a id="ObjectiveWorksheet.SetStep"></a>

### ObjectiveWorksheet.SetStep(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [int](https://docs.python.org/3/library/functions.html#int))

Sets the worksheet Step property at index.

<a id="ObjectiveWorksheet.SetWeight"></a>

### ObjectiveWorksheet.SetWeight(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [float](https://docs.python.org/3/library/functions.html#float))

Sets the worksheet Weight property at index.