Storyboard.GetCurrentProgress 方法

定义

命名空间:

System.Windows.Media.Animation

程序集:

PresentationFramework.dll

检索为此 CurrentProgress 创建的 Clock 的 Storyboard。

重载

GetCurrentProgress()	检索为此 CurrentProgress 创建的 Clock 的 Storyboard。
GetCurrentProgress(FrameworkContentElement)	检索为此 CurrentProgress 创建的 Clock 的 Storyboard。
GetCurrentProgress(FrameworkElement)	检索为此 CurrentProgress 创建的 Clock 的 Storyboard。

GetCurrentProgress()

检索为此 CurrentProgress 创建的 Clock 的 Storyboard。

public:
 double GetCurrentProgress();

public double GetCurrentProgress ();

member this.GetCurrentProgress : unit -> double

Public Function GetCurrentProgress () As Double

返回

Double

如果此时钟为 Stopped，则为 null；如果此时钟处于活动状态并且其 Timeline 的 Duration 为 Forever，则为 0.0；在其他情况下为一个介于 0.0 和 1.0 之间的值，此值指示此时钟在其当前迭代中的当前进度。 值为 0.0 时表示没有进度，值为 1.0 时表示此时钟处于其当前迭代的末尾。

注解

若要使用此方法检索有关情节提要时钟的信息，情节提要必须可控制。 若要使情节提要在代码中可控制，必须使用情节提要方法的适当 Begin 重载，并指定 true 使其可控制。 有关示例，请参阅 如何：在情节提要启动后控制情节提要。

GetCurrentProgress(FrameworkContentElement)

检索为此 CurrentProgress 创建的 Clock 的 Storyboard。

public:
 Nullable<double> GetCurrentProgress(System::Windows::FrameworkContentElement ^ containingObject);

public double? GetCurrentProgress (System.Windows.FrameworkContentElement containingObject);

member this.GetCurrentProgress : System.Windows.FrameworkContentElement -> Nullable<double>

Public Function GetCurrentProgress (containingObject As FrameworkContentElement) As Nullable(Of Double)

参数

containingObject

FrameworkContentElement

在调用 Begin(FrameworkContentElement, Boolean) 方法时指定的对象。 此对象包含为此情节提要及其子级创建的 Clock 对象。

返回

Nullable<Double>

如果此时钟为 Stopped，则为 null；如果此时钟处于活动状态并且其 Timeline 的 Duration 为 Forever，则为 0.0；在其他情况下为一个介于 0.0 和 1.0 之间的值，此值指示此时钟在其当前迭代中的当前进度。 值为 0.0 时表示没有进度，值为 1.0 时表示此时钟处于其当前迭代的末尾。

注解

若要使用此方法检索有关情节提要时钟的信息，情节提要必须可控制。 若要使情节提要在代码中可控制，必须使用情节提要方法的适当 Begin 重载，并指定 true 使其可控制。 有关示例，请参阅 如何：在情节提要启动后控制情节提要。

GetCurrentProgress(FrameworkElement)

检索为此 CurrentProgress 创建的 Clock 的 Storyboard。

public:
 Nullable<double> GetCurrentProgress(System::Windows::FrameworkElement ^ containingObject);

public double? GetCurrentProgress (System.Windows.FrameworkElement containingObject);

member this.GetCurrentProgress : System.Windows.FrameworkElement -> Nullable<double>

Public Function GetCurrentProgress (containingObject As FrameworkElement) As Nullable(Of Double)

参数

containingObject

FrameworkElement

在调用 Begin(FrameworkElement, Boolean) 方法时指定的对象。 此对象包含为此情节提要及其子级创建的 Clock 对象。

返回

Nullable<Double>

如果此时钟为 Stopped，则为 null；如果此时钟处于活动状态并且其 Timeline 的 Duration 为 Forever，则为 0.0；在其他情况下为一个介于 0.0 和 1.0 之间的值，此值指示此时钟在其当前迭代中的当前进度。 值为 0.0 时表示没有进度，值为 1.0 时表示此时钟处于其当前迭代的末尾。

注解

若要使用此方法检索有关情节提要时钟的信息，情节提要必须可控制。 若要使情节提要在代码中可控制，必须使用情节提要方法的适当 Begin 重载，并指定 true 使其可控制。 有关示例，请参阅 如何：在情节提要启动后控制情节提要。