StatusBar.Progress Method

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

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Sub Progress ( _
    InProgress As Boolean, _
    Label As String, _
    AmountCompleted As Integer, _
    Total As Integer _
)
void Progress(
    bool InProgress,
    string Label,
    int AmountCompleted,
    int Total
)
void Progress(
    bool InProgress, 
    [InAttribute] String^ Label, 
    [InAttribute] int AmountCompleted, 
    [InAttribute] int Total
)
abstract Progress : 
        InProgress:bool * 
        Label:string * 
        AmountCompleted:int * 
        Total:int -> unit
function Progress(
    InProgress : boolean, 
    Label : String, 
    AmountCompleted : int, 
    Total : int
)

Parameters

  • InProgress
    Type: System.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
    Type: System.String

    Optional. The label to display on the meter control.

  • AmountCompleted
    Type: System.Int32

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

  • Total
    Type: System.Int32

    Optional. The total number of steps in the operation.

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

.NET Framework Security

See Also

Reference

StatusBar Interface

EnvDTE Namespace