This topic has not yet been rated - Rate this topic

StatusBar.Progress Method

Visual Studio 2005

Other Versions

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

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

Syntax

C++

Copy

void Progress (
	bool InProgress,
	[OptionalAttribute] [InAttribute] string Label,
	[OptionalAttribute] [InAttribute] int AmountCompleted,
	[OptionalAttribute] [InAttribute] int Total
)

Copy

void Progress (
	boolean InProgress, 
	/** @attribute InAttribute() */ /** @attribute OptionalAttribute() */ String Label, 
	/** @attribute InAttribute() */ /** @attribute OptionalAttribute() */ int AmountCompleted, 
	/** @attribute InAttribute() */ /** @attribute OptionalAttribute() */ int Total
)

JScript

Copy

function Progress (
	InProgress : boolean, 
	Label : String, 
	AmountCompleted : int, 
	Total : int
)

Parameters

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

Label: Optional. The label to display on the meter control.

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

Total: Optional. The total number of steps in the operation.

Example

Copy

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

Reference

StatusBar Interface
StatusBar Members
EnvDTE Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ