# Class LoopPlugin

OptimaJet.Workflow.Plugins.LoopPlugin

Namespace: [OptimaJet.Workflow.Plugins](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/)

```csharp
public class LoopPlugin : WorkflowPlugin<ActionsLoopPlugin, ActionsAsyncLoopPlugin, ConditionsLoopPlugin, ConditionsAsyncLoopPlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin
```

## Type Hierarchy

-   [WorkflowActionProvider<ActionsLoopPlugin, ActionsAsyncLoopPlugin, ConditionsLoopPlugin, ConditionsAsyncLoopPlugin>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowActionProvider-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)
    -   [WorkflowActionAndDesignerParameterFormatProvider<ActionsLoopPlugin, ActionsAsyncLoopPlugin, ConditionsLoopPlugin, ConditionsAsyncLoopPlugin>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowActionAndDesignerParameterFormatProvider-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)
        -   [CustomMixProvider<ActionsLoopPlugin, ActionsAsyncLoopPlugin, ConditionsLoopPlugin, ConditionsAsyncLoopPlugin>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/CustomMixProvider-EnumActions-EnumActionsAsync-EnumConditions-EnumConditionsAsync/)
            -   [WorkflowPlugin<ActionsLoopPlugin, ActionsAsyncLoopPlugin, ConditionsLoopPlugin, ConditionsAsyncLoopPlugin>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowPlugin-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)
                -   LoopPlugin Current type
                    -   Implemented interfaces
                        -   [ICustomMixProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomMixProvider/)
                            -   [ICustomActivityProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/ICustomActivityProvider/)
                            -   [ICustomConditionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomConditionProvider/)
                            -   [ICustomDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomDesignerParameterFormatProvider/)
                                -   [IDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IDesignerParameterFormatProvider/)
                            -   [ICustomWorkflowActionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomWorkflowActionProvider/)
                                -   [IDisableProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/IDisableProvider/)
                                -   [IWorkflowActionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IWorkflowActionProvider/)
                        -   [IWorkflowPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/IWorkflowPlugin/)

## Constructors

`public LoopPlugin()` 

## Properties

`public override string Name { get; protected set; }` 

The plugin name.

## Methods

`protected virtual void InitialActions()` 

`protected virtual void InitialActionsAsync()` 

`public virtual Task ActionStartLoopForAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`public virtual Task ActionStartLoopForeachAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`public virtual Task ActionStartLoopForeachFromParameterAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`public virtual Task ActionSetLoopStateAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`protected virtual void InitialConditions()` 

`protected virtual void InitialConditionsAsync()` 

`public virtual Task<bool> ConditionLoopIsBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Boolean>` |  |

`public virtual Task<bool> ConditionLoopIsCompletedAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Boolean>` |  |

`public virtual Task<bool> ConditionLoopIsCompletedOrBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Boolean>` |  |

`public virtual Task<bool> ConditionLoopIsDefaultAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Boolean>` |  |

`public virtual Task<bool> ConditionLoopIsNotDefaultAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Boolean>` |  |

`public virtual Task<bool> ConditionLoopIsNotCompletedAndBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `runtime` | `WorkflowRuntime` |  |
| `parameters` | `Dictionary<String, String>` |  |
| `token` | `CancellationToken` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Boolean>` |  |

`protected virtual Task<LoopState> GetLoopStateAsync(ProcessInstance processInstance, Dictionary<string, string> parameters)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` |  |
| `parameters` | `Dictionary<String, String>` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<LoopState>` |  |

`protected virtual void InitialFormatsActions()` 

`protected virtual void InitialFormatsActionsAsync()` 

`protected virtual void InitialFormatsConditions()` 

`protected virtual void InitialActionsAsyncTemplates()` 

`protected virtual void InitialFormatsConditionsAsync()` 

`public virtual List<CodeActionParameterDefinition> FormatStartLoopFor()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatStartLoopForeach()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatStartLoopForeachFromParameter()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatSetLoopState()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatLoopIsBroken()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatLoopIsCompleted()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatLoopIsCompletedOrBroken()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatLoopIsDefault()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatLoopIsNotCompletedAndBroken()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`public virtual List<CodeActionParameterDefinition> FormatLoopIsNotDefault()` 

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` |  |

`protected virtual void InitialExclude()` 

`public override void OnPluginAdd(WorkflowRuntime runtime, List<string> schemes = null)` 

Called when a plugin is added to a runtime.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `runtime` | `WorkflowRuntime` | The instance of the runtime. |
| `schemes` | `List<String>` | The list of schemes for which the plugin is being added. |

[Previous LoopCounter](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/LoopCounter/) [Next LoopState](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/LoopState/)