Edit

Storyboard.GetCurrentIteration Method

  • Reference

Definition

Namespace:
System.Windows.Media.Animation
Assembly:
PresentationFramework.dll

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

Overloads

GetCurrentIteration()

Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
GetCurrentIteration(FrameworkContentElement)

Retrieves the CurrentIteration of the Clock that was created for this Storyboard.
GetCurrentIteration(FrameworkElement)

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

GetCurrentIteration()

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

public:
 int GetCurrentIteration();
public int GetCurrentIteration ();
member this.GetCurrentIteration : unit -> int
Public Function GetCurrentIteration () As Integer

Returns

Int32

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

Remarks

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.

See also

Applies to

GetCurrentIteration(FrameworkContentElement)

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

public:
 Nullable<int> GetCurrentIteration(System::Windows::FrameworkContentElement ^ containingObject);
public int? GetCurrentIteration (System.Windows.FrameworkContentElement containingObject);
member this.GetCurrentIteration : System.Windows.FrameworkContentElement -> Nullable<int>
Public Function GetCurrentIteration (containingObject As FrameworkContentElement) As Nullable(Of Integer)

Parameters

containingObject
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.

Returns

Nullable<Int32>

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

Remarks

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.

See also

Applies to

GetCurrentIteration(FrameworkElement)

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

public:
 Nullable<int> GetCurrentIteration(System::Windows::FrameworkElement ^ containingObject);
public int? GetCurrentIteration (System.Windows.FrameworkElement containingObject);
member this.GetCurrentIteration : System.Windows.FrameworkElement -> Nullable<int>
Public Function GetCurrentIteration (containingObject As FrameworkElement) As Nullable(Of Integer)

Parameters

containingObject
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.

Returns

Nullable<Int32>

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

Remarks

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.

See also

Applies to