## On this page

  

 

 # `RemoteForce`

 Last update: 16.07.2025 

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

#### *class* Ansys.ACT.Automation.Mechanical.BoundaryConditions.RemoteForce

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

Defines a RemoteForce.

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

## Overview

### Methods

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

NameDescription[`BeamMaterial`](#RemoteForce.BeamMaterial)Gets or sets the BeamMaterial.[`BeamRadius`](#RemoteForce.BeamRadius)Gets or sets the BeamRadius.[`Behavior`](#RemoteForce.Behavior)Gets or sets the Behavior.[`Children`](#RemoteForce.Children)Gets the list of children.[`Comments`](#RemoteForce.Comments)Gets the list of associated comments.[`CoordinateSystem`](#RemoteForce.CoordinateSystem)Gets or sets the CoordinateSystem.[`DataModelObjectCategory`](#RemoteForce.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DefineBy`](#RemoteForce.DefineBy)Gets or sets the DefineBy.[`Direction`](#RemoteForce.Direction)Gets or sets the Direction.[`Figures`](#RemoteForce.Figures)Gets the list of associated figures.[`FollowerLoad`](#RemoteForce.FollowerLoad)Gets or sets the FollowerLoad.[`HarmonicIndex`](#RemoteForce.HarmonicIndex)Gets or sets the HarmonicIndex.[`Images`](#RemoteForce.Images)Gets the list of associated images.[`IndependentVariable`](#RemoteForce.IndependentVariable)Gets or sets the IndependentVariable.[`InternalObject`](#RemoteForce.InternalObject)Gets the internal object. For advanced usage only.[`LoadingApplicationType`](#RemoteForce.LoadingApplicationType)Gets or sets the LoadingApplicationType.[`Location`](#RemoteForce.Location)Gets or sets the Location.[`Magnitude`](#RemoteForce.Magnitude)Gets the Magnitude.[`MagnitudeImag`](#RemoteForce.MagnitudeImag)Gets the MagnitudeImag.[`NonCyclicLoadingType`](#RemoteForce.NonCyclicLoadingType)Gets or sets the NonCyclicLoadingType.[`NumberOfSegments`](#RemoteForce.NumberOfSegments)Gets or sets the NumberOfSegments.[`PhaseAngle`](#RemoteForce.PhaseAngle)Gets the PhaseAngle.[`PinballRegion`](#RemoteForce.PinballRegion)Gets or sets the PinballRegion.[`Properties`](#RemoteForce.Properties)Gets the list of properties for this object.[`ReadOnly`](#RemoteForce.ReadOnly)Gets or sets the ReadOnly.[`RpmSelection`](#RemoteForce.RpmSelection)Gets or sets the RpmSelection.[`SectorNumber`](#RemoteForce.SectorNumber)Gets or sets the SectorNumber.[`SharedRefBody`](#RemoteForce.SharedRefBody)Gets or sets the SharedRefBody.[`StepSelection`](#RemoteForce.StepSelection)Gets or sets the StepSelection.[`StepVarying`](#RemoteForce.StepVarying)Gets or sets the StepVarying.[`Suppressed`](#RemoteForce.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#RemoteForce.VisibleProperties)Gets the list of properties that are visible for this object.[`XComponent`](#RemoteForce.XComponent)Gets the XComponent.[`XComponentImag`](#RemoteForce.XComponentImag)Gets the XComponentImag.[`XCoordinate`](#RemoteForce.XCoordinate)Gets or sets the XCoordinate.[`XPhaseAngle`](#RemoteForce.XPhaseAngle)Gets the XPhaseAngle.[`YComponent`](#RemoteForce.YComponent)Gets the YComponent.[`YComponentImag`](#RemoteForce.YComponentImag)Gets the YComponentImag.[`YCoordinate`](#RemoteForce.YCoordinate)Gets or sets the YCoordinate.[`YPhaseAngle`](#RemoteForce.YPhaseAngle)Gets the YPhaseAngle.[`ZComponent`](#RemoteForce.ZComponent)Gets the ZComponent.[`ZComponentImag`](#RemoteForce.ZComponentImag)Gets the ZComponentImag.[`ZCoordinate`](#RemoteForce.ZCoordinate)Gets or sets the ZCoordinate.[`ZPhaseAngle`](#RemoteForce.ZPhaseAngle)Gets the ZPhaseAngle.<a id="property-detail"></a>

## Property detail

<a id="RemoteForce.BeamMaterial"></a>

### *property* RemoteForce.BeamMaterial *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BeamMaterial.

<a id="RemoteForce.BeamRadius"></a>

### *property* RemoteForce.BeamRadius *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BeamRadius.

<a id="RemoteForce.Behavior"></a>

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

Gets or sets the Behavior.

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

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

Gets the list of children.

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

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

### *property* RemoteForce.CoordinateSystem *: [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 CoordinateSystem.

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

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

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

Gets or sets the DefineBy.

<a id="RemoteForce.Direction"></a>

### *property* RemoteForce.Direction *: Ansys.ACT.Math.Vector3D | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Direction.

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

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

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

Gets or sets the FollowerLoad.

<a id="RemoteForce.HarmonicIndex"></a>

### *property* RemoteForce.HarmonicIndex *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the HarmonicIndex.

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

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

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

Gets or sets the IndependentVariable.

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

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

Gets the internal object. For advanced usage only.

<a id="RemoteForce.LoadingApplicationType"></a>

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

Gets or sets the LoadingApplicationType.

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

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

Gets or sets the Location.

<a id="RemoteForce.Magnitude"></a>

### *property* RemoteForce.Magnitude *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Magnitude.

<a id="RemoteForce.MagnitudeImag"></a>

### *property* RemoteForce.MagnitudeImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MagnitudeImag.

<a id="RemoteForce.NonCyclicLoadingType"></a>

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

Gets or sets the NonCyclicLoadingType.

<a id="RemoteForce.NumberOfSegments"></a>

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

Gets or sets the NumberOfSegments.

<a id="RemoteForce.PhaseAngle"></a>

### *property* RemoteForce.PhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the PhaseAngle.

<a id="RemoteForce.PinballRegion"></a>

### *property* RemoteForce.PinballRegion *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the PinballRegion.

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

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

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

### *property* RemoteForce.RpmSelection *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RpmSelection.

<a id="RemoteForce.SectorNumber"></a>

### *property* RemoteForce.SectorNumber *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SectorNumber.

<a id="RemoteForce.SharedRefBody"></a>

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

Gets or sets the SharedRefBody.

<a id="RemoteForce.StepSelection"></a>

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

Gets or sets the StepSelection.

<a id="RemoteForce.StepVarying"></a>

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

Gets or sets the StepVarying.

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

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

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

### *property* RemoteForce.XComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XComponent.

<a id="RemoteForce.XComponentImag"></a>

### *property* RemoteForce.XComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XComponentImag.

<a id="RemoteForce.XCoordinate"></a>

### *property* RemoteForce.XCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the XCoordinate.

<a id="RemoteForce.XPhaseAngle"></a>

### *property* RemoteForce.XPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XPhaseAngle.

<a id="RemoteForce.YComponent"></a>

### *property* RemoteForce.YComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YComponent.

<a id="RemoteForce.YComponentImag"></a>

### *property* RemoteForce.YComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YComponentImag.

<a id="RemoteForce.YCoordinate"></a>

### *property* RemoteForce.YCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the YCoordinate.

<a id="RemoteForce.YPhaseAngle"></a>

### *property* RemoteForce.YPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YPhaseAngle.

<a id="RemoteForce.ZComponent"></a>

### *property* RemoteForce.ZComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZComponent.

<a id="RemoteForce.ZComponentImag"></a>

### *property* RemoteForce.ZComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZComponentImag.

<a id="RemoteForce.ZCoordinate"></a>

### *property* RemoteForce.ZCoordinate *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ZCoordinate.

<a id="RemoteForce.ZPhaseAngle"></a>

### *property* RemoteForce.ZPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZPhaseAngle.

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

## Method detail

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

### RemoteForce.Activate()

Activate the current object.

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

### RemoteForce.AddComment()

Creates a new child Comment.

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

### RemoteForce.AddFigure()

Creates a new child Figure.

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

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### RemoteForce.Delete()

Run the Delete action.

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

### RemoteForce.Duplicate()

Creates a copy of the current DataModelObject.

<a id="RemoteForce.GetActivateAtLoadStep"></a>

### RemoteForce.GetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int))

GetActivateAtLoadStep method.

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

### RemoteForce.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="RemoteForce.GetComponentActivateAtLoadStep"></a>

### RemoteForce.GetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int))

GetComponentActivateAtLoadStep method.

<a id="RemoteForce.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### RemoteForce.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### RemoteForce.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="RemoteForce.PromoteToNamedSelection"></a>

### RemoteForce.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

<a id="RemoteForce.PromoteToRemotePoint"></a>

### RemoteForce.PromoteToRemotePoint()

Run the PromoteToRemotePoint action.

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

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

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

Get a property by its unique name.

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

### RemoteForce.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="RemoteForce.SetActivateAtLoadStep"></a>

### RemoteForce.SetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool))

SetActivateAtLoadStep method.

<a id="RemoteForce.SetComponentActivateAtLoadStep"></a>

### RemoteForce.SetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool))

SetComponentActivateAtLoadStep method.