Definition
Assembly: CloudNimble.BlazorEssentials.dll Namespace: CloudNimble.BlazorEssentials.Merlin Inheritance: CloudNimble.BlazorEssentials.BlazorObservableSyntax
Constructors
.ctor
Syntax
Parameters
| Name | Type | Description |
|---|---|---|
id | int | - |
displayText | string | - |
onAction | System.Func<System.Threading.Tasks.Task<bool>> | - |
.ctor Inherited
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
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
Property Value
Type:string
ErrorText
Any additional text you’d like to display to the end user when there is an error.Syntax
Property Value
Type:string
Id
A zero-based index identifying this step in relation to other steps in the process.Syntax
Property Value
Type:int
Label
Returns a Bootstrap Label with the details of the a given OperationStep.Status.Syntax
Property Value
Type:string
LoadingStatus Inherited
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
Property Value
Type:CloudNimble.BlazorEssentials.LoadingStatus
OnAction
An async function that returns a boolean indicating whether or not the action succeeded.Syntax
Property Value
Type:System.Func<System.Threading.Tasks.Task<bool>>
StateHasChanged Inherited
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
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
Property Value
Type:CloudNimble.BlazorEssentials.Merlin.OperationStepStatus
Methods
Dispose Override
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
Parameters
| Name | Type | Description |
|---|---|---|
disposing | bool | - |
Reset
Resets the status of the OperationStep in the event it needs to run again.Syntax
Start
The Action that the Operation calls to trigger a Step. It wrapps the call to onAction with status update logic.Syntax
Returns
Type:System.Threading.Tasks.Task