Export (0) Print
Expand All

Storyboard.GetCurrentIteration Method (FrameworkElement)

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(
	FrameworkElement containingObject
)

Parameters

containingObject
Type: System.Windows.FrameworkElement

The object specified when the Begin(FrameworkElement, 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 clock's timeline has an AutoReverse setting of true, a full iteration consists of a forward-reverse pair, not just one of these segments.

Regardless of its current iteration, seeking a clock returns its current iteration to 1. Restarting a clock also returns its current iteration to 1.

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

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft