GetCurrentIteration Method (FrameworkContentElement)

Storyboard.GetCurrentIteration Method (FrameworkContentElement)


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

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

public Nullable<int> GetCurrentIteration(
	FrameworkContentElement containingObject


Type: System.Windows.FrameworkContentElement

The object specified when the Begin(FrameworkContentElement, Boolean) method was called. This object contains the Clock objects that were created for this storyboard and its children.

Return Value

Type: System.Nullable<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.

.NET Framework
Available since 3.0
Return to top
© 2015 Microsoft