Skip to main content

Introducing Formengine - The New Formbuilder, try for FREE formengine.io.

Class LoopPlugin

Inheritance

↳ object

    ↳ WorkflowActionProvider<ActionsLoopPlugin,ActionsAsyncLoopPlugin,ConditionsLoopPlugin,ConditionsAsyncLoopPlugin>

        ↳ WorkflowActionAndDesignerParameterFormatProvider<ActionsLoopPlugin,ActionsAsyncLoopPlugin,ConditionsLoopPlugin,ConditionsAsyncLoopPlugin>

            ↳ CustomMixProvider<ActionsLoopPlugin,ActionsAsyncLoopPlugin,ConditionsLoopPlugin,ConditionsAsyncLoopPlugin>

                ↳ WorkflowPlugin<ActionsLoopPlugin,ActionsAsyncLoopPlugin,ConditionsLoopPlugin,ConditionsAsyncLoopPlugin>

                    ↳ LoopPlugin

Implements

ICustomMixProvider

ICustomWorkflowActionProvider

IWorkflowActionProvider

IDisableProvider

ICustomDesignerParameterFormatProvider

IDesignerParameterFormatProvider

ICustomActivityProvider

ICustomConditionProvider

IWorkflowPlugin

Inherited Members

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Disabled

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.DefaultValues

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Name

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ShowSettingsParameters

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.PluginSettings

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.OnPluginAdd(WorkflowRuntime, List<string>)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.OnRuntimeStartAsync(WorkflowRuntime)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetParameterOrFromSettingsOrDefault<TParameter>(Dictionary<string, string>, TParameter, string, bool)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.IfSettingNotSetOrShowSettingsParameters(Action, Enum)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.SetSettingDefaultValue(Enum, string)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.SettingValue(Enum, string)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.SetSettingNewValue(Enum, string)

CustomMixProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync>.GetCustomActivities()

CustomMixProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync>.GetCustomConditions()

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetParameter<TParameter>(Dictionary<string, string>, TParameter)

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetParameterOrDefault<TParameter>(Dictionary<string, string>, TParameter, string, bool)

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetFormat(CodeActionType, string, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Actions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsync

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Conditions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsync

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncTemplates

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncTemplates

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExcludeAction(string, ExcludeRule)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExcludeCondition(string, ExcludeRule)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionParameter

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteAction(string, ProcessInstance, WorkflowRuntime, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteActionAsync(string, ProcessInstance, WorkflowRuntime, string, CancellationToken)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteCondition(string, ProcessInstance, WorkflowRuntime, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteConditionAsync(string, ProcessInstance, WorkflowRuntime, string, CancellationToken)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetActions(string, NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetConditions(string, NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.IsActionAsync(string, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetActionsAsync(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetActions(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetConditions(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetConditionsAsync(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.IsConditionAsync(string, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ToParameters(string)

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Plugins

Assembly: OptimaJet.Workflow.Core.dll

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

Constructors

LoopPlugin()

Declaration
public LoopPlugin()

Properties

Name

Declaration
public override string Name { get; protected set; }
Property value
TypeDescription
string

Methods

InitialActions()

Declaration
protected virtual void InitialActions()

InitialActionsAsync()

Declaration
protected virtual void InitialActionsAsync()

ActionStartLoopForAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task ActionStartLoopForAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task

ActionStartLoopForeachAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task ActionStartLoopForeachAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task

ActionStartLoopForeachFromParameterAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task ActionStartLoopForeachFromParameterAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task

ActionSetLoopStateAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task ActionSetLoopStateAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task

InitialConditions()

Declaration
protected virtual void InitialConditions()

InitialConditionsAsync()

Declaration
protected virtual void InitialConditionsAsync()

ConditionLoopIsBrokenAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task<bool> ConditionLoopIsBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task<bool>

ConditionLoopIsCompletedAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task<bool> ConditionLoopIsCompletedAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task<bool>

ConditionLoopIsCompletedOrBrokenAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task<bool> ConditionLoopIsCompletedOrBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task<bool>

ConditionLoopIsDefaultAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task<bool> ConditionLoopIsDefaultAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task<bool>

ConditionLoopIsNotDefaultAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task<bool> ConditionLoopIsNotDefaultAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task<bool>

ConditionLoopIsNotCompletedAndBrokenAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration
public virtual Task<bool> ConditionLoopIsNotCompletedAndBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
WorkflowRuntimeruntime
Dictionary<string, string>parameters
CancellationTokentoken
Returns
TypeDescription
Task<bool>

GetLoopStateAsync(ProcessInstance, Dictionary<string, string>)

Declaration
protected virtual Task<LoopState> GetLoopStateAsync(ProcessInstance processInstance, Dictionary<string, string> parameters)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Dictionary<string, string>parameters
Returns
TypeDescription
Task<LoopState>

InitialFormatsActions()

Declaration
protected virtual void InitialFormatsActions()

InitialFormatsActionsAsync()

Declaration
protected virtual void InitialFormatsActionsAsync()

InitialFormatsConditions()

Declaration
protected virtual void InitialFormatsConditions()

InitialActionsAsyncTemplates()

Declaration
protected virtual void InitialActionsAsyncTemplates()

InitialFormatsConditionsAsync()

Declaration
protected virtual void InitialFormatsConditionsAsync()

FormatStartLoopFor()

Declaration
public virtual List<CodeActionParameterDefinition> FormatStartLoopFor()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatStartLoopForeach()

Declaration
public virtual List<CodeActionParameterDefinition> FormatStartLoopForeach()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatStartLoopForeachFromParameter()

Declaration
public virtual List<CodeActionParameterDefinition> FormatStartLoopForeachFromParameter()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatSetLoopState()

Declaration
public virtual List<CodeActionParameterDefinition> FormatSetLoopState()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatLoopIsBroken()

Declaration
public virtual List<CodeActionParameterDefinition> FormatLoopIsBroken()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatLoopIsCompleted()

Declaration
public virtual List<CodeActionParameterDefinition> FormatLoopIsCompleted()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatLoopIsCompletedOrBroken()

Declaration
public virtual List<CodeActionParameterDefinition> FormatLoopIsCompletedOrBroken()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatLoopIsDefault()

Declaration
public virtual List<CodeActionParameterDefinition> FormatLoopIsDefault()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatLoopIsNotCompletedAndBroken()

Declaration
public virtual List<CodeActionParameterDefinition> FormatLoopIsNotCompletedAndBroken()
Returns
TypeDescription
List<CodeActionParameterDefinition>

FormatLoopIsNotDefault()

Declaration
public virtual List<CodeActionParameterDefinition> FormatLoopIsNotDefault()
Returns
TypeDescription
List<CodeActionParameterDefinition>

InitialExclude()

Declaration
protected virtual void InitialExclude()

OnPluginAdd(WorkflowRuntime, List<string>)

Declaration
public override void OnPluginAdd(WorkflowRuntime runtime, List<string> schemes = null)
Parameters
TypeNameDescription
WorkflowRuntimeruntime
List<string>schemes

Extension Methods

Stay in the know
Build Workflow Applications Faster
Star us on GitHub