CodeAnalysisProgress Class

  • Reference

Definition

Namespace:
Microsoft.CodeAnalysis
Assembly:
Microsoft.CodeAnalysis.Workspaces.dll
Package:
Microsoft.CodeAnalysis.Workspaces.Common v4.9.2
Source:
CodeAnalysisProgress.cs

Represents the progress of an operation. Commonly used to update a UI visible to a user when a long running operation is happening.

public sealed class CodeAnalysisProgress
type CodeAnalysisProgress = class
Public NotInheritable Class CodeAnalysisProgress
Inheritance
Object
CodeAnalysisProgress

Constructors

CodeAnalysisProgress()

Methods

AddCompleteItems(Int32, String)

When passed to an appropriate IProgress<T>, will indicate that some items of work have transitioned from being incomplete (see AddIncompleteItems(Int32, String) to complete. This is commonly presented with a progress bar. An optional description can also be provided to update the UI accordingly (see Description(String)).
AddIncompleteItems(Int32, String)

When passed to an appropriate IProgress<T>, will add the requested number of incomplete items to the UI showing the progress of the current operation. This is commonly presented with a progress bar. An optional description can also be provided to update the UI accordingly (see Description(String)).
Description(String)

When passed to an appropriate IProgress<T>, will updates the UI showing the progress of the current operation to the specified description.

Applies to