This document is archived and information here might be outdated.  Recommended version.


IAnimationProgressor.Play Method (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > System > ESRI.ArcGIS.esriSystem > Interfaces > IA > IAnimationProgressor Interface > IAnimationProgressor.Play Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (System)  

IAnimationProgressor.Play Method

Plays the animation.

[Visual Basic .NET]
Public Sub Play ( _
    [ByVal frameFrom As Integer], _
    [ByVal frameTo As Integer], _
    [ByVal repeat As Integer] _
)

[C#]
public void Play (
    int frameFrom,
    int frameTo,
    int repeat
);
[C#]

Optional Values

frameFrom   Supply 0 as a default value.
frameTo   Supply -1 as a default value.
repeat   Supply -1 as a default value. 
[C++]
HRESULT Play(
  long frameFrom,
  long frameTo,
  long repeat
);

[C++]

Parameters
frameFrom [in, optional, defaultvalue(0)]
  frameFrom is a parameter of type long
frameTo [in, optional, defaultvalue(-1)]
  frameTo is a parameter of type long
repeat [in, optional, defaultvalue(-1)]
  repeat is a parameter of type long

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

See Also

IAnimationProgressor Interface | IStatusBar.PlayProgressAnimation Method

.NET Snippets

Animation Progressor