C# Class SonarLint.VisualStudio.Progress.Controller.ProgressControllerStep

Partial class implementation of IProgressStepExecutionEvents
Inheritance: IProgressStepExecutionEvents
Show file Open project: SonarSource-VisualStudio/sonarlint-visualstudio Class Usage Examples

Private Properties

Property Type Description
DoStatefulExecution void
GetContext VsTaskRunContext
IProgressStepExecutionEvents void
IProgressStepOperation Task
Initialize void

Public Methods

Method Description
ProgressControllerStep ( IProgressController controller, ProgressStepDefinition definition ) : Microsoft.VisualStudio

Creates a step from definition

Protected Methods

Method Description
ExecuteOperation ( CancellationToken cancellationToken, IProgressStepExecutionEvents progressCallback ) : void

Executes the operation
OnExecutionStateChanged ( ) : void

Invokes the StateChanged event based on the ExecutionState of the object
SetStepKind ( bool indeterminate ) : void

Sets the whether Indeterminate and updates the inital Progress
UpdateProgress ( string progressDetailText, double progress ) : void

Updates the progress with the specified values

Private Methods

Method Description
DoStatefulExecution ( IProgressStepExecutionEvents progressCallback, CancellationToken cancellationToken ) : void
GetContext ( StepExecution execution ) : VsTaskRunContext

Returns the VsTaskRunContext for StepExecution
IProgressStepExecutionEvents ( string progressDetailText, double progress ) : void
IProgressStepOperation ( CancellationToken cancellationToken, IProgressStepExecutionEvents progressCallback ) : Task
Initialize ( ) : void

Initializes the step

Method Details

ExecuteOperation() protected method

Executes the operation
protected ExecuteOperation ( CancellationToken cancellationToken, IProgressStepExecutionEvents progressCallback ) : void
cancellationToken CancellationToken Cancellation token
progressCallback IProgressStepExecutionEvents The callback instance to use when executing the operation
return void

OnExecutionStateChanged() protected method

Invokes the StateChanged event based on the ExecutionState of the object
protected OnExecutionStateChanged ( ) : void
return void

ProgressControllerStep() public method

Creates a step from definition
public ProgressControllerStep ( IProgressController controller, ProgressStepDefinition definition ) : Microsoft.VisualStudio
controller IProgressController The hosting for this step
definition ProgressStepDefinition The for which to create the step
return Microsoft.VisualStudio

SetStepKind() protected method

Sets the whether Indeterminate and updates the inital Progress
protected SetStepKind ( bool indeterminate ) : void
indeterminate bool Whether requested an indeterminate step
return void

UpdateProgress() protected method

Updates the progress with the specified values
protected UpdateProgress ( string progressDetailText, double progress ) : void
progressDetailText string Optional progress detail text
progress double Progress in a range of 0.0 to 1.0
return void