|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IStatusBar
Provides access to members that define the application statusbar.
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.
The status bar is divided into sections called panes. The Panes property specifies which panes of the status bar are currently visible.
The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBar methods 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).
com.esri.arcgis.system.IApplication
,
IAnimationProgressor
Method Summary | |
---|---|
String |
getMessage(int pane)
The message displayed by one of the status bar panes. |
int |
getPanes()
Indicates which standard panes are shown by the status bar. |
IAnimationProgressor |
getProgressAnimation()
The progress animation object on the statusbar. |
IStepProgressor |
getProgressBar()
The progress bar object on the statusbar. |
void |
hideProgressAnimation()
Hides the progress animation. |
void |
hideProgressBar()
Hides the progress bar. |
boolean |
isVisible()
Indicates if the statusbar is visible. |
void |
playProgressAnimation(boolean playAnim)
Plays the progress animation if the parameter is true; otherwise stops it. |
void |
setMessage(int pane,
String message)
The message displayed by one of the status bar panes. |
void |
setPanes(int panes)
Indicates which standard panes are shown by the status bar. |
void |
setVisible(boolean visible)
Indicates if the statusbar is visible. |
void |
showProgressAnimation(String message,
String animationPath)
Makes the progress animation visible. |
void |
showProgressBar(String message,
int min,
int max,
int step,
boolean onePanel)
Makes the progress bar visible. |
void |
stepProgressBar()
Steps the progress bar to the next position. |
Method Detail |
---|
void setMessage(int pane, String message) throws IOException, AutomationException
pane
- The pane (in)message
- The message (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getMessage(int pane) throws IOException, AutomationException
pane
- The pane (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setPanes(int panes) throws IOException, AutomationException
panes
- The panes (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.esriStatusBarPanes
int getPanes() throws IOException, AutomationException
The status bar is divided into sections called panes. The Panes property 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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.esriStatusBarPanes
IStepProgressor getProgressBar() throws IOException, AutomationException
Use the ProgressBar property to get access to the step progress bar. The step progress bar is the blue moving line that displays the percentage of completeness.
The ProgressBar property 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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IStepProgressor
IAnimationProgressor getProgressAnimation() throws IOException, AutomationException
The ProgressAnimation property controls the animation progressor (spinning globe) on the status that displays in the animation pane.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IAnimationProgressor
boolean isVisible() throws IOException, AutomationException
The Visible property indicates whether the status bar is visible in the ArcGIS application window, providing information about the current state of the application.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setVisible(boolean visible) throws IOException, AutomationException
visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void showProgressBar(String message, int min, int max, int step, boolean onePanel) throws IOException, AutomationException
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)
The ShowProgressBar method 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.
message
- The message (in)min
- The min (in)max
- The max (in)step
- The step (in)onePanel
- The onePanel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void stepProgressBar() throws IOException, AutomationException
The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBar methods are used to control the step progress bar on the status bar.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void hideProgressBar() throws IOException, AutomationException
The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBar methods are used to control the step progress bar on the status bar.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void showProgressAnimation(String message, String animationPath) throws IOException, AutomationException
The ShowProgressAnimation method provides shortcuts to the properties of the animation progressor. This method allows you to set the message, and the animation file to be played.
message
- The message (in)animationPath
- The animationPath (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void playProgressAnimation(boolean playAnim) throws IOException, AutomationException
The PlayProgressAnimation method starts or stops playing the animation. Pass True to start playing the animation and False to stop playing the animation.
playAnim
- The playAnim (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void hideProgressAnimation() throws IOException, AutomationException
Hides the animation progressor. Use the ShowProgressAnimation method to show the animation progressor and the PlayProgressAnimation method to start or stop the animation.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |