Documentation Index
Fetch the complete documentation index at: https://easyaf.dev/llms.txt
Use this file to discover all available pages before exploring further.
Definition
Assembly: CloudNimble.BlazorEssentials.dll Namespace: CloudNimble.BlazorEssentials.Merlin Inheritance: CloudNimble.BlazorEssentials.BlazorObservableSyntax
Summary
A class with observable elements to describe the different components of reporting operation progress to an end user.Constructors
.ctor
Syntax
Parameters
| Name | Type | Description |
|---|---|---|
title | string | - |
steps | System.Collections.Generic.IEnumerable<CloudNimble.BlazorEssentials.Merlin.OperationStep> | - |
successText | string | Initializer for the Success value on the DisplayText property. |
failureText | string | Initializer for the Failure value on the DisplayText property. |
inProgressText | string | Initializer for the InProgress value on the DisplayText property. |
notStartedText | string | Initializer for the NotStarted value on the DisplayText property. |
shouldObserveStatus | bool | Initializer for internal flag indicating if the control should trigger the StateHasChanged action in the BlazorObservable when the OperationStatus changes. |
.ctor Inherited
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
Parameters
| Name | Type | Description |
|---|---|---|
stateHasChangedConfig | CloudNimble.BlazorEssentials.StateHasChangedConfig | - |
Properties
CurrentIcon
A computed string that determines what the icon should be as the Steps change.Syntax
Property Value
Type:string
CurrentIconColor
A computed string that determines what the icon color should be as the Steps change.Syntax
Property Value
Type:string
CurrentProgressClass
A computed string containing the DisplayText for the currently running OperationStep.Syntax
Property Value
Type:string
DisplayIcon
The icon to display to the end user through the Operation lifecycle.Syntax
Property Value
Type:CloudNimble.BlazorEssentials.Merlin.OperationStatusDisplay
Remarks
This property is is not observable.DisplayIconColor
The colors to use for the Operation.CurrentIcon through the Operation lifecycle.Syntax
Property Value
Type:CloudNimble.BlazorEssentials.Merlin.OperationStatusDisplay
Remarks
This property is is not observable.DisplayProgressClass
The CSS Class to use for the Alert’s background through the Operation lifecycle.Syntax
Property Value
Type:CloudNimble.BlazorEssentials.Merlin.OperationStatusDisplay
Remarks
This property is is not observable.DisplayText
The text to display to the end user through the Operation lifecycle.Syntax
Property Value
Type:CloudNimble.BlazorEssentials.Merlin.OperationStatusDisplay
Remarks
This property is is not observable.LoadingStatus Inherited
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
Property Value
Type:CloudNimble.BlazorEssentials.LoadingStatus
ProgressPercent
A computed number containing the percentage of all the OperationSteps in the “Succeeded” status.Syntax
Property Value
Type:System.Decimal
ProgressText
A computed string containing the DisplayText for the currently running OperationStep.Syntax
Property Value
Type:string
ResultText
A computed string that determines if we display the SuccessText or FailureText based on the collective outcome of all the Steps.Syntax
Property Value
Type:string
ShowPanel
A computed boolean specifying whether or not the <div> showing the status of this Operation should be displayed.Syntax
Property Value
Type:bool
StateHasChanged Inherited
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
Property Value
Type:CloudNimble.BlazorEssentials.StateHasChangedConfig
Status
A computed boolean specifying whether or not ALL of the OperationSteps are successful.Syntax
Property Value
Type:CloudNimble.BlazorEssentials.Merlin.OperationStatus
Steps
A ObservableCollection`1 containing the different steps of the Operation.Syntax
Property Value
Type:System.Collections.ObjectModel.ObservableCollection<CloudNimble.BlazorEssentials.Merlin.OperationStep>
Title
The text to display to the end user regarding what is happening in this step.Syntax
Property Value
Type:string
Methods
Dispose Override
Inherited from
CloudNimble.BlazorEssentials.BlazorObservableSyntax
Parameters
| Name | Type | Description |
|---|---|---|
disposing | bool | - |
ReplaceSteps
Syntax
Parameters
| Name | Type | Description |
|---|---|---|
steps | System.Collections.Generic.List<CloudNimble.BlazorEssentials.Merlin.OperationStep> | - |
Reset
Changes all of the Steps back to “NotStarted” so the Operation can be run again.Syntax
Start
Starts the Operation, looping through each step until it is finished or until a step fails.Syntax
UpdateStep
Modify the status of a specific OperationStep.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
id | int | OperationStep identifier. |
status | CloudNimble.BlazorEssentials.Merlin.OperationStepStatus | New OperationStepStatus. |
errorText | string | New value for the ErrorText property on the OperationStep. |