Storyboard.GetCurrentIteration Method

Updated: July 2008

Retrieves the CurrentIteration of the Clock that was created for this Storyboard.

Namespace:  System.Windows.Media.Animation
Assembly:  PresentationFramework (in PresentationFramework.dll)

public int GetCurrentIteration()
You cannot use methods in XAML.

Return Value

Type: System.Int32
This clock's current iteration within its current active period, or null if this clock is stopped.

A clock's first iteration has a value of 1.

If this storyboard has a AutoReverse setting of true, a full iteration consists of a forward-reverse pair, not just one of these segments.

To use this method to retrieve information about a storyboard's clock, the storyboard must be controllable. To make a storyboard controllable in code, you must use the appropriate overload of the storyboard's Begin method and specify true to make it controllable. For an example, see How to: Control a Storyboard After It Starts.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5 SP1, 3.0 SP2

Date

History

Reason

July 2008

Added topic for new member.

SP1 feature change.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft