Export (0) Print
Expand All

Storyboard.GetCurrentState Method (FrameworkContentElement)

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

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

public ClockState GetCurrentState(
	FrameworkContentElement containingObject
)

Parameters

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.Windows.Media.Animation.ClockState
The current state of the clock created for this storyboard: Active, Filling, or Stopped.

This method does not tell you whether a storyboard is paused. To determine whether a storyboard is paused, use the GetIsPaused method.

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
Show:
© 2015 Microsoft