StatusBar Interface

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public interface class StatusBar

public interface class StatusBar

__interface StatusBar

[System.Runtime.InteropServices.Guid("C34301A1-3EF1-41D8-932A-FEA4A8A8CE0C")]
public interface StatusBar

[<System.Runtime.InteropServices.Guid("C34301A1-3EF1-41D8-932A-FEA4A8A8CE0C")>]
type StatusBar = interface

Public Interface StatusBar

Attributes

GuidAttribute

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  

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.

Properties

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

Methods

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