This topic has not yet been rated - Rate this topic

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
)
public Nullable<int> GetCurrentIteration (
	FrameworkContentElement containingObject
)
public function GetCurrentIteration (
	containingObject : FrameworkContentElement
) : Nullable<int>
You cannot use methods in XAML.

Parameters

containingObject

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

Return Value

This clock's current iteration within its current active period, or a null reference (Nothing in Visual Basic) 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. See How to: Control a Storyboard After It Starts for an example.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.