OperationStep

Definition

Assembly: CloudNimble.BlazorEssentials.dll

Namespace: CloudNimble.BlazorEssentials.Merlin

Inheritance: CloudNimble.BlazorEssentials.BlazorObservable

Syntax

CloudNimble.BlazorEssentials.Merlin.OperationStep

Constructors

.ctor

Syntax

public OperationStep(int id, string displayText, System.Func<System.Threading.Tasks.Task<bool>> onAction)

Parameters

Name	Type	Description
id	int	-
displayText	string	-
onAction	System.Func<System.Threading.Tasks.Task<bool>>	-

.ctor Inherited

Inherited from CloudNimble.BlazorEssentials.BlazorObservable

Creates a new instance of the BlazorObservable class.

Syntax

public BlazorObservable(CloudNimble.BlazorEssentials.StateHasChangedConfig stateHasChangedConfig = null)

Parameters

Name	Type	Description
stateHasChangedConfig	CloudNimble.BlazorEssentials.StateHasChangedConfig	-

Properties

DisplayText

The text to display to the end user regarding what is happening in this step.

Syntax

public string DisplayText { get; set; }

Property Value

Type: string

ErrorText

Any additional text you’d like to display to the end user when there is an error.

Syntax

public string ErrorText { get; set; }

Property Value

Type: string

Id

A zero-based index identifying this step in relation to other steps in the process.

Syntax

public int Id { get; set; }

Property Value

Type: int

Label

Returns a Bootstrap Label with the details of the a given OperationStep.Status.

Syntax

public string Label { get; set; }

Property Value

Type: string

LoadingStatus Inherited

Inherited from CloudNimble.BlazorEssentials.BlazorObservable

A BlazorObservable.LoadingStatus specifying the current state of the required data for this Observable.

Syntax

public CloudNimble.BlazorEssentials.LoadingStatus LoadingStatus { get; set; }

Property Value

Type: CloudNimble.BlazorEssentials.LoadingStatus

OnAction

An async function that returns a boolean indicating whether or not the action succeeded.

Syntax

public System.Func<System.Threading.Tasks.Task<bool>> OnAction { get; set; }

Property Value

Type: System.Func<System.Threading.Tasks.Task<bool>>

StateHasChanged Inherited

Inherited from CloudNimble.BlazorEssentials.BlazorObservable

Determines how to trigger StateHasChanged events in a Blazor component.

Syntax

public CloudNimble.BlazorEssentials.StateHasChangedConfig StateHasChanged { get; set; }

Property Value

Type: CloudNimble.BlazorEssentials.StateHasChangedConfig

Status

An OperationStepStatus where you can change the operation’s status and the UI is re-rendered automatically.

Syntax

public CloudNimble.BlazorEssentials.Merlin.OperationStepStatus Status { get; set; }

Property Value

Type: CloudNimble.BlazorEssentials.Merlin.OperationStepStatus

Methods

Dispose Override

Inherited from CloudNimble.BlazorEssentials.BlazorObservable

Syntax

protected override void Dispose(bool disposing)

Parameters

Name	Type	Description
disposing	bool	-

Reset

Resets the status of the OperationStep in the event it needs to run again.

Syntax

public void Reset()

Start

The Action that the Operation calls to trigger a Step. It wrapps the call to onAction with status update logic.

Syntax

public System.Threading.Tasks.Task Start()

Returns

Type: System.Threading.Tasks.Task