IStatusBar Interface

Provides access to members that define the application statusbar.

Description

The status bar is the horizontal area at the bottom of an ArcGIS application window. It provides information about the current state of the application.

The status bar provides information about the selected command, and may also display a progress bar while something is being processed. For example, if you select a layer in the table of contents in ArcMap, the status bar will tell you how many features are currently selected.

The IStatusBar interface allows you to set the properties of the status bar. Use IApplication::StatusBar to get a reference to the status bar object of the application.

Members

	Name	Description
	HideProgressAnimation	Hides the progress animation.
	HideProgressBar	Hides the progress bar.
	Message	The message displayed by one of the status bar panes.
	Panes	Indicates which standard panes are shown by the status bar. Use a combination of esriStatusBarPanes constants.
	PlayProgressAnimation	Plays the progress animation if the parameter is true; otherwise stops it.
	ProgressAnimation	The progress animation object on the statusbar.
	ProgressBar	The progress bar object on the statusbar.
	ShowProgressAnimation	Makes the progress animation visible.
	ShowProgressBar	Makes the progress bar visible.
	StepProgressBar	Steps the progress bar to the next position.
	Visible	Indicates if the statusbar is visible.

IStatusBar.HideProgressAnimation Method

Hides the progress animation.

Public Sub HideProgressAnimation ( _
)

public void HideProgressAnimation (
);

Remarks

Hides the animation progressor. Use the ShowProgressAnimation method to show the animation progressor and the PlayProgressAnimation method to start or stop the animation.

IStatusBar.HideProgressBar Method

Hides the progress bar.

Public Sub HideProgressBar ( _
)

public void HideProgressBar (
);

Remarks

The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBar methods are used to control the step progress bar on the status bar.

IStatusBar.Message Property

The message displayed by one of the status bar panes.

Public Function get_Message ( _
    ByVal pane As Integer _
) As String

Public Sub set_Message ( _
    ByVal pane As Integer, _
    ByVal Message As String _
)

public string get_Message (
    int pane
);

public void set_Message (
    int pane,
    string Message
);

Description

For valid values for pane, refer to the esriStatusBarPanesconstants.

Remarks

The Messageproperty allows you to display text in the status bar. Most commonly, the main pane (esriStatusMain, value 0) is used for the display of messages; however, any pane can be used.

IStatusBar.Panes Property

Indicates which standard panes are shown by the status bar. Use a combination of esriStatusBarPanes constants.

Public Property Panes As Integer

public int Panes {get; set;}

Remarks

The status bar is divided into sections called panes. The Panesproperty specifies which panes of the status bar are currently visible.

The esriStatusBarPanes constants define which panes are shown. The Panes property is a bit field; this means that you can use a combination of the esriStatusBarPanes constants. Add up the values of the panes you want shown and set the Panes property to the total.

Although, the esriStatusBarPanes enumeration is only available to developers with ArcGIS for Desktop, all developers can work with this property as a long.

The default value of Panes is 7; this means that the main (0), animation (1), position (2), and page position (4) panes are visible (0 + 1 + 2 + 4 = 7).

You can set the Panes property to 255 to show all panes.

IStatusBar.PlayProgressAnimation Method

Plays the progress animation if the parameter is true; otherwise stops it.

Public Sub PlayProgressAnimation ( _
    ByVal playAnim As Boolean _
)

public void PlayProgressAnimation (
    bool playAnim
);

Remarks

The PlayProgressAnimation method starts or stops playing the animation. Pass True to start playing the animation and False to stop playing the animation.

IStatusBar.ProgressAnimation Property

The progress animation object on the statusbar.

Public ReadOnly Property ProgressAnimation As IAnimationProgressor

public IAnimationProgressor ProgressAnimation {get;}

Remarks

The ProgressAnimation property controls the animation progressor (spinning globe) on the status that displays in the animation pane.

IStatusBar.ProgressBar Property

The progress bar object on the statusbar.

Public ReadOnly Property ProgressBar As IStepProgressor

public IStepProgressor ProgressBar {get;}

Remarks

Use the ProgressBarproperty to get access to the step progress bar. The step progress bar is the blue moving line that displays the percentage of completeness.

The ProgressBarproperty and the HideProgressBar, ShowProgressBar, and StepProgressBar methods are used to control the step progress bar on the status bar. The step progress bar displays in the main status bar pane.

IStatusBar.ShowProgressAnimation Method

Makes the progress animation visible.

Public Sub ShowProgressAnimation ( _
    ByVal Message As String, _
    ByVal animationPath As String _
)

public void ShowProgressAnimation (
    string Message,
    string animationPath
);

Remarks

The ShowProgressAnimationmethod provides shortcuts to the properties of the animation progressor. This method allows you to set the message, and the animation file to be played.

IStatusBar.ShowProgressBar Method

Makes the progress bar visible.

Public Sub ShowProgressBar ( _
    ByVal Message As String, _
    ByVal min As Integer, _
    ByVal max As Integer, _
    ByVal Step As Integer, _
    ByVal onePanel As Boolean _
)

public void ShowProgressBar (
    string Message,
    int min,
    int max,
    int Step,
    bool onePanel
);

Description

_Message_is the string that is to be displayed beside the step progressor on the status bar.

_min_specifies the minimum range of the progression.

_max_specifies the maximum range of the progression.

_Step_specifies step increment of the progression.

onePanel (this parameter is no longer used)

Remarks

The ShowProgressBarmethod provides shortcuts to the properties of the step progress bar (IStepProgressor). This method allows you to set the message, minimum and maximum values, and the step size of the step progress bar and also display the step progress bar.

IStatusBar.StepProgressBar Method

Steps the progress bar to the next position.

Public Sub StepProgressBar ( _
)

public void StepProgressBar (
);

Remarks

The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBarmethods are used to control the step progress bar on the status bar.

IStatusBar.Visible Property

Indicates if the statusbar is visible.

Public Property Visible As Boolean

public bool Visible {get; set;}

Remarks

The Visible property indicates whether the status bar is visible in the ArcGIS application window, providing information about the current state of the application.

Classes that implement IStatusBar

Classes	Description

Remarks

The status bar is divided into sections called panes. The Panesproperty specifies which panes of the status bar are currently visible.

The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBarmethods are used to control the step progress bar on the status bar.

The ProgressAnimation property and the HideProgressAnimation, ShowProgressAnimation, and PlayProgressAnimation methods control the animation progressor (spinning globe) on the status bar. The animation progressor displays in the animation pane. You can use the default spinning globe for the animation progressor or specify your own animation file (.avi).