Provides access to members that report progress using an animation.
Description
The IAnimationProgresor interface has methods for controlling the animation progessor. The animation progressor displays in the animation pane of a status bar. You can use the default spinning globe for the animation progressor or specify your own animation file (.avi). Use the IStatusBar::ProgressAnimation property to get access to the animation progressor.
Members
| Name | Description | |
|---|---|---|
 |
Animation | The animation displayed by the progressor as one of the esriAnimation constants. (Not implemented). |
 |
Hide | Hides the progressor. |
|
Message | The message displayed by the progressor. |
|
OpenPath | Opens the AVI file specified in the path and displays its first frame. The AVI file specified must not contain audio. |
|
Play | Plays the animation. |
|
Seek | Moves to the specified frame of the animation. The animation starts at this frame the next time it is played. |
|
Show | Shows the progressor. |
|
Step | Animates or steps the progressor. |
|
Stop | Stops the animation. |
IAnimationProgressor.Animation Property
The animation displayed by the progressor as one of the esriAnimation constants. (Not implemented).
Public Property Animation As esriAnimations
public esriAnimations Animation {get; set;}
Description
This property is not implemented; do not try to use it.
IAnimationProgressor.OpenPath Method
Opens the AVI file specified in the path and displays its first frame. The AVI file specified must not contain audio.
Public Sub OpenPath ( _
ByVal animationPath As String _
)
public void OpenPath (
string animationPath
);
Description
Opens the specified *.avi file and displays the first frame. Use the Play method to play the other frames.
Remarks
You can use the default spinning globe for the animation progressor or specify your own animation file (.avi).
The IStatusBar::ShowProgressAnimation method provides a shortcut to the OpenPath and Show methods of the animation progressor.
IAnimationProgressor.Play Method
Plays the animation.
Public Sub Play ( _
[ByVal frameFrom As Integer], _
[ByVal frameTo As Integer], _
[ByVal repeat As Integer] _
)
public void Play (
int frameFrom,
int frameTo,
int repeat
);
Description
Plays the animation from between the specified frames. If the frameFrom, frameTo and repeat arguments are not supplied the animation will be played once from the first frame to the last frame.
Remarks
The IStatusBar::PlayProgressAnimation method provides a shortcut to the Play and Stop methods of the animation progressor.
IAnimationProgressor.Seek Method
Moves to the specified frame of the animation. The animation starts at this frame the next time it is played.
Public Sub Seek ( _
ByVal frameTo As Integer _
)
public void Seek (
int frameTo
);
Description
The Seek method moves to the specified frame in the animation. The first frame in the animation has an index of 0. The next time the Play method is used the animation will start from this frame.
IAnimationProgressor.Stop Method
Stops the animation.
Public Sub Stop ( _
)
public void Stop (
);
Description
Stops the animation at the current frame. The next time the Play method is used the animation will start from this frame.
Remarks
The IStatusBar::PlayProgressAnimation method provides a shortcut to the Play and Stop methods of the animation progressor.
Inherited Interfaces
| Interfaces | Description |
|---|---|
| IProgressor | Provides access to members that report progress. |
Classes that implement IAnimationProgressor
| Classes | Description |
|---|