StatusBar Interface

Represents the Status Bar in the Visual Studio integrated development environment (IDE).

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

Syntax

'Declaration
<GuidAttribute("C34301A1-3EF1-41D8-932A-FEA4A8A8CE0C")> _
Public Interface StatusBar

[GuidAttribute("C34301A1-3EF1-41D8-932A-FEA4A8A8CE0C")]
public interface StatusBar

[GuidAttribute(L"C34301A1-3EF1-41D8-932A-FEA4A8A8CE0C")]
public interface class StatusBar

[<GuidAttribute("C34301A1-3EF1-41D8-932A-FEA4A8A8CE0C")>]
type StatusBar =  interface end

public interface StatusBar

The StatusBar type exposes the following members.

Properties

	Name	Description
	DTE	Gets the top-level extensibility object.
	Parent	Gets the immediate parent object of a StatusBar object.
	Text	Sets or gets the selected text.

Top

Methods

	Name	Description
	Animate	Displays an animated picture in the StatusBar.
	Clear	Clears all text from the StatusBar.
	Highlight	Toggles highlighting of text within the StatusBar.
	Progress	Creates, modifies, and clears the meter control inside the StatusBar .
	SetLineColumnCharacter	Sets the text column and character indicators in the StatusBar .
	SetXYWidthHeight	Sets the x, y, width, and height coordinate indicators in the StatusBar.
	ShowTextUpdates	Determines whether the StatusBar shows text updates.

Top

Remarks

There is only one StatusBar object in the IDE.

Because this example lists all of the tasks currently in the TaskList, make sure it contains some tasks before running the code.

Examples

Sub StatusBarExample()
   ' Create object references and initialize variables.
   Dim SBar As StatusBar
   Dim TList As TaskList
   Dim TItems As TaskItems
   Dim TI As TaskItem
   Dim count As Long
   Dim i As Long

   SBar = DTE.StatusBar
   ' Get references to Task List.
   TList = DTE.Windows().Item(Constants.vsWindowKindTaskList).Object
   TItems = TList.TaskItems
   i = 1
   count = TItems.Count
   
   ' Loop through Task List items, updating progress bar for each item.
   For Each TI In TItems
      SBar.Progress(True, TI.Description, i, count)
      SBar.SetLineColumnCharacter(i, count, 0)
      i = i + 1
      MsgBox("Task: " & i - 1 & vbCr & "Description: " & TI.Description & vbCr & "Next task item...")
   Next
   ' All done, so get rid of the bar.
   SBar.Progress(False)
End Sub

See Also

Reference

EnvDTE Namespace