StatusBar.Progress(Boolean, String, Int32, Int32) Method

  • Reference

Definition

Namespace:
EnvDTE
Assembly:
EnvDTE.dll
Assembly:
Microsoft.VisualStudio.Interop.dll

Creates, modifies, and clears the meter control inside the StatusBar .

void Progress(bool InProgress, std::wstring const & Label = "", int AmountCompleted = 0, int Total = 0);
[System.Runtime.InteropServices.DispId(6)]
public void Progress (bool InProgress, string Label = "", int AmountCompleted = 0, int Total = 0);
[<System.Runtime.InteropServices.DispId(6)>]
abstract member Progress : bool * string * int * int -> unit
Public Sub Progress (InProgress As Boolean, Optional Label As String = "", Optional AmountCompleted As Integer = 0, Optional Total As Integer = 0)

Parameters

InProgress
Boolean

Required. Indicates whether the meter is displayed. If InProgress is set to False, the meter is turned off. Otherwise, the meter is displayed.

Label
String

Optional. The label to display on the meter control.

AmountCompleted
Int32

Optional. The number of steps of the operation that have completed.

Total
Int32

Optional. The total number of steps in the operation.

Attributes
DispIdAttribute

Examples

Sub ProgressExample()  
   Dim SBar As StatusBar  
   SBar = DTE.StatusBar  
   SBar.Progress(True, "doing something", 90, 100)  
   SBar.Progress(False)  
   SBar.Animate(True, vsStatusAnimation.vsStatusAnimationSave)  
End Sub

Applies to