Storyboard.GetCurrentState Method

Definition

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

Overloads

GetCurrentState(FrameworkElement)

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

GetCurrentState(FrameworkContentElement)

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

GetCurrentState()

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

GetCurrentState(FrameworkElement)

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

public:
 System::Windows::Media::Animation::ClockState GetCurrentState(System::Windows::FrameworkElement ^ containingObject);
public System.Windows.Media.Animation.ClockState GetCurrentState (System.Windows.FrameworkElement containingObject);
member this.GetCurrentState : System.Windows.FrameworkElement -> System.Windows.Media.Animation.ClockState
Public Function GetCurrentState (containingObject As FrameworkElement) As ClockState

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

ClockState

The current state of the clock created for this storyboard: Active, Filling, or Stopped.

Remarks

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.

Applies to

GetCurrentState(FrameworkContentElement)

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

public:
 System::Windows::Media::Animation::ClockState GetCurrentState(System::Windows::FrameworkContentElement ^ containingObject);
public System.Windows.Media.Animation.ClockState GetCurrentState (System.Windows.FrameworkContentElement containingObject);
member this.GetCurrentState : System.Windows.FrameworkContentElement -> System.Windows.Media.Animation.ClockState
Public Function GetCurrentState (containingObject As FrameworkContentElement) As ClockState

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

ClockState

The current state of the clock created for this storyboard: Active, Filling, or Stopped.

Remarks

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.

Applies to

GetCurrentState()

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

public:
 System::Windows::Media::Animation::ClockState GetCurrentState();
public System.Windows.Media.Animation.ClockState GetCurrentState ();
member this.GetCurrentState : unit -> System.Windows.Media.Animation.ClockState
Public Function GetCurrentState () As ClockState

Returns

ClockState

The current state of the clock created for this storyboard: Active, Filling, or Stopped.

Remarks

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.

Applies to