This documentation is archived and is not being maintained.

Storyboard.GetCurrentProgress Method (FrameworkContentElement)

Gets the CurrentProgress of the Clock that was created for this Storyboard.

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

public Nullable<double> GetCurrentProgress (
	FrameworkContentElement containingObject
)
public Nullable<double> GetCurrentProgress (
	FrameworkContentElement containingObject
)
public function GetCurrentProgress (
	containingObject : FrameworkContentElement
) : Nullable<double>
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

a null reference (Nothing in Visual Basic) if this clock is Stopped, or 0.0 if this clock is active and its Timeline has a Duration of Forever; otherwise, a value between 0.0 and 1.0 that indicates the current progress of this Clock within its current iteration. A value of 0.0 indicates no progress, and a value of 1.0 indicates that the clock is at the end of its current iteration.

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
Show: