Storyboard 类

定义

命名空间:

System.Windows.Media.Animation

程序集:

PresentationFramework.dll

一个容器时间线，该时间线为子动画提供对象和属性确定信息。

public ref class Storyboard : System::Windows::Media::Animation::ParallelTimeline

public class Storyboard : System.Windows.Media.Animation.ParallelTimeline

type Storyboard = class
    inherit ParallelTimeline

Public Class Storyboard
Inherits ParallelTimeline

继承

Object

DispatcherObject

DependencyObject

Freezable

Animatable

Timeline

TimelineGroup

ParallelTimeline

Storyboard

注解

以交互方式控制情节提要

可控制的情节提要可以暂停、恢复、查找、停止和删除。 若要使情节提要在标记中可控制，请指定 Name 创建该情节提要的 BeginStoryboard 对象的 属性;有关示例，请参阅 如何：使用事件触发器在情节提要启动后控制情节提要。 若要使情节提要在代码中可控制，必须使用情节提要 Begin 的 方法的适当重载并指定 true 以使其可控制。 有关示例，请参阅 如何：在情节提要启动后控制情节提要。

数据绑定和对时间线进行动画处理

大多数时间线属性都可以进行数据绑定或动画处理;但是，由于计时系统的工作方式，数据绑定或动画时间线的行为与其他数据绑定或动画对象的行为不一样。 若要了解其行为，有助于了解激活时间线的含义。

激活时间线时，将复制时间线及其子时间线。 系统将冻结这些副本（使它们成为只读副本），并且将根据它们来创建 Clock 对象。 这些时钟将执行对目标属性进行动画处理的实际工作。 如果时间线进行数据绑定或动画处理，则创建其时钟时，将对其当前值进行快照。 即使原始时间线可能会继续更改，但其时钟不会更改。

要使时间线反映数据绑定或动画更改，必须重新创建其时钟。 不会自动重新创建时钟。 以下是应用时间线更改的几种方法：

• 如果时间线是 Storyboard 或属于它，则可以通过使用 BeginStoryboard 或 Begin 方法重新应用其情节提要来使其反映更改。 这还会产生重新启动动画的附带影响。 在代码中，可以使用 Seek 方法将情节提要向前移回其之前的位置。

• 如果已使用 BeginAnimation 方法将动画直接应用到某个属性，则再次调用 BeginAnimation 方法并向其传递已修改的动画。

• 如果直接在时钟级别工作，请创建并应用一组新的时钟，并使用它们替换先前创建的时钟集。

有关数据绑定动画的示例，请参阅 关键样条动画示例 。

构造函数

Storyboard()

初始化 Storyboard 类的新实例。

字段

TargetNameProperty	标识 TargetName 附加属性。
TargetProperty	标识 Target 附加属性。
TargetPropertyProperty	标识 TargetProperty 附加属性。

属性

AccelerationRatio	获取或设置一个值，该值指定在将时间消逝从零加速到其最大速率的过程中所占用时间线的 Duration 的百分比。 (继承自 Timeline)
AutoReverse	获取或设置一个值，该值指示时间线在完成向前迭代后是否按相反的顺序播放。 (继承自 Timeline)
BeginTime	获取或设置此 Timeline 应开始的时间。 (继承自 Timeline)
CanFreeze	获取一个值，该值指示是否可将对象变为不可修改。 (继承自 Freezable)
Children	获取或设置 TimelineGroup 的直接子 Timeline 对象的集合。 (继承自 TimelineGroup)
DecelerationRatio	获取或设置一个值，该值指定在将时间消逝从其最大速率减速到零的过程中所占用时间线的 Duration 的百分比。 (继承自 Timeline)
DependencyObjectType	DependencyObjectType获取包装此实例的 CLR 类型的 。 (继承自 DependencyObject)
Dispatcher	获取与此 Dispatcher 关联的 DispatcherObject。 (继承自 DispatcherObject)
Duration	获取或设置此时间线播放的时间长度，而不是计数重复。 (继承自 Timeline)
FillBehavior	获取或设置一个值，该值指定 Timeline 在到达其有效期末尾后的行为。 (继承自 Timeline)
HasAnimatedProperties	获取一个值，该值指示一个或多个 AnimationClock 对象是否与此对象的任何依赖项属性相关联。 (继承自 Animatable)
IsFrozen	获取一个值，该值指示对象当前是否可修改。 (继承自 Freezable)
IsSealed	获取一个值，该值指示此实例当前是否为密封的（只读）。 (继承自 DependencyObject)
Name	获取或设置此 Timeline 的名称。 (继承自 Timeline)
RepeatBehavior	获取或设置此时间线的重复行为。 (继承自 Timeline)
SlipBehavior	获取或设置一个值，该值指定在其中一个或多个 Timeline 子级滑动时此时间线的行为方式。 (继承自 ParallelTimeline)
SpeedRatio	获取或设置此 Timeline 的时间相对于其父级的前进速率。 (继承自 Timeline)

附加属性

Target	获取或设置应进行动画处理的对象。
TargetName	获取或设置要进行动画处理的对象的名称。 该对象必须是 FrameworkElement、FrameworkContentElement 或 Freezable。
TargetProperty	一个容器时间线，该时间线为子动画提供对象和属性确定信息。

方法

AddChild(Object)	向此 TimelineGroup 添加子 Timeline。 (继承自 TimelineGroup)
AddText(String)	将文本字符串添加为此 Timeline 的子级。 (继承自 TimelineGroup)
AllocateClock()	创建此时间线的特定类型的时钟。 (继承自 TimelineGroup)
ApplyAnimationClock(DependencyProperty, AnimationClock)	将 AnimationClock 应用到指定的 DependencyProperty。 如果该属性已进行动画处理，则使用 SnapshotAndReplace 切换行为。 (继承自 Animatable)
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	将 AnimationClock 应用到指定的 DependencyProperty。 如果该属性已进行动画处理，则使用指定的 HandoffBehavior。 (继承自 Animatable)
Begin()	将与此 Storyboard 关联的动画应用到其目标并启动它们。
Begin(FrameworkContentElement)	将与此 Storyboard 关联的动画应用到其目标并启动它们。
Begin(FrameworkContentElement, Boolean)	将与此 Storyboard 关联的动画应用到其目标并启动它们。
Begin(FrameworkContentElement, HandoffBehavior)	使用指定的 Storyboard，将与此 HandoffBehavior 关联的动画应用到它们的目标并启动它们。
Begin(FrameworkContentElement, HandoffBehavior, Boolean)	使用指定的 Storyboard，将与此 HandoffBehavior 关联的动画应用到它们的目标并启动它们。
Begin(FrameworkElement)	将与此 Storyboard 关联的动画应用到其目标并启动它们。
Begin(FrameworkElement, Boolean)	将与此 Storyboard 关联的动画应用到其目标并启动它们。
Begin(FrameworkElement, FrameworkTemplate)	将与此 Storyboard 关联的动画应用到它们在指定模板内的目标并启动它们。
Begin(FrameworkElement, FrameworkTemplate, Boolean)	将与此 Storyboard 关联的动画应用到它们在指定模板内的目标并启动它们。
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior)	将与此 Storyboard 关联的动画应用到它们在指定模板内的目标并启动它们。
Begin(FrameworkElement, FrameworkTemplate, HandoffBehavior, Boolean)	将与此 Storyboard 关联的动画应用到它们在指定模板内的目标并启动它们。
Begin(FrameworkElement, HandoffBehavior)	使用指定的 Storyboard，将与此 HandoffBehavior 关联的动画应用到它们的目标并启动它们。
Begin(FrameworkElement, HandoffBehavior, Boolean)	将与此 Storyboard 关联的动画应用到其目标并启动它们。
BeginAnimation(DependencyProperty, AnimationTimeline)	将动画应用于指定 DependencyProperty。 动画会在呈现下一帧时启动。 如果指定属性已进行动画处理，则使用 SnapshotAndReplace 切换行为。 (继承自 Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	将动画应用于指定 DependencyProperty。 动画会在呈现下一帧时启动。 如果指定的属性已进行动画处理，则使用指定的 HandoffBehavior。 (继承自 Animatable)
CheckAccess()	确定调用线程是否可以访问此 DispatcherObject。 (继承自 DispatcherObject)
ClearValue(DependencyProperty)	清除属性的本地值。 要清除的属性由 DependencyProperty 标识符指定。 (继承自 DependencyObject)
ClearValue(DependencyPropertyKey)	清除只读属性的本地值。 要清除的属性由 DependencyPropertyKey 指定。 (继承自 DependencyObject)
Clone()	创建此 Storyboard 的可修改克隆，从而深度复制此对象的值。 在复制依赖项属性时，此方法会复制资源引用和数据绑定（但可能不再解析），但不复制动画或其当前值。
CloneCore(Freezable)	使用基（未经过动画处理的）属性值使该实例成为指定 Freezable 的克隆（深层复制）。 (继承自 Freezable)
CloneCurrentValue()	创建此 ParallelTimeline 对象的可修改复本，从而深度复制此对象的当前值。 不复制资源引用、数据绑定和动画，而是复制其当前值。 (继承自 ParallelTimeline)
CloneCurrentValueCore(Freezable)	使用当前属性值使该实例成为指定 Freezable 的可修改克隆（深层复制）。 (继承自 Freezable)
CoerceValue(DependencyProperty)	对指定依赖属性的值进行强制。 通过对调用方 DependencyObject 上存在的依赖属性的属性元数据中所指定的任何 CoerceValueCallback 函数进行调用来完成此操作。 (继承自 DependencyObject)
CreateClock()	使用此实例初始化新的 ClockGroup 对象。 (继承自 TimelineGroup)
CreateClock(Boolean)	从此 Clock 创建一个新的 Timeline 并指定新的 Clock 是否可以控制。 如果此 Timeline 含有子级，则创建时钟树时将此 Timeline 作为根。 (继承自 Timeline)
CreateInstance()	初始化 Freezable 类的新实例。 (继承自 Freezable)
CreateInstanceCore()	创建 Storyboard 类的新实例。
Equals(Object)	确定提供的 DependencyObject 是否等效于当前 DependencyObject。 (继承自 DependencyObject)
Freeze()	使当前对象不可修改，并且将其 IsFrozen 属性设置为 true。 (继承自 Freezable)
FreezeCore(Boolean)	使此 Timeline 成为不可修改的，或确定是否可使其成为不可修改的。 (继承自 Timeline)
GetAnimationBaseValue(DependencyProperty)	返回指定的 DependencyProperty 的未经过动画处理的值。 (继承自 Animatable)
GetAsFrozen()	使用基（未经过动画处理的）属性值创建 Freezable 的冻结副本。 由于副本已冻结，因此将通过引用复制任何冻结的子对象。 (继承自 Freezable)
GetAsFrozenCore(Freezable)	使此实例成为指定的 Timeline 对象的克隆。 (继承自 Timeline)
GetCurrentGlobalSpeed()	检索为此 CurrentGlobalSpeed 创建的 Clock 的 Storyboard。
GetCurrentGlobalSpeed(FrameworkContentElement)	检索为此 CurrentGlobalSpeed 创建的 Clock 的 Storyboard。
GetCurrentGlobalSpeed(FrameworkElement)	检索为此 CurrentGlobalSpeed 创建的 Clock 的 Storyboard。
GetCurrentIteration()	检索为此 CurrentIteration 创建的 Clock 的 Storyboard。
GetCurrentIteration(FrameworkContentElement)	检索为此 CurrentIteration 创建的 Clock 的 Storyboard。
GetCurrentIteration(FrameworkElement)	检索为此 CurrentIteration 创建的 Clock 的 Storyboard。
GetCurrentProgress()	检索为此 CurrentProgress 创建的 Clock 的 Storyboard。
GetCurrentProgress(FrameworkContentElement)	检索为此 CurrentProgress 创建的 Clock 的 Storyboard。
GetCurrentProgress(FrameworkElement)	检索为此 CurrentProgress 创建的 Clock 的 Storyboard。
GetCurrentState()	检索为此 CurrentState 创建的 Clock 的 Storyboard。
GetCurrentState(FrameworkContentElement)	检索为此 CurrentState 创建的 Clock 的 Storyboard。
GetCurrentState(FrameworkElement)	检索为此 CurrentState 创建的 Clock 的 Storyboard。
GetCurrentTime()	检索为此 CurrentTime 创建的 Clock 的 Storyboard。
GetCurrentTime(FrameworkContentElement)	检索为此 CurrentTime 创建的 Clock 的 Storyboard。
GetCurrentTime(FrameworkElement)	检索为此 CurrentTime 创建的 Clock 的 Storyboard。
GetCurrentValueAsFrozen()	使用当前属性值创建 Freezable 的冻结副本。 由于副本已冻结，因此将通过引用复制任何冻结的子对象。 (继承自 Freezable)
GetCurrentValueAsFrozenCore(Freezable)	使此实例成为指定 Timeline 的冻结复本。 不复制资源引用、数据绑定和动画，而是复制其当前值。 (继承自 Timeline)
GetHashCode()	获取此 DependencyObject 的哈希代码。 (继承自 DependencyObject)
GetIsPaused()	检索一个值，该值指示为此 Clock 创建的 Storyboard 是否已暂停。
GetIsPaused(FrameworkContentElement)	检索一个值，该值指示为此 Clock 创建的 Storyboard 是否已暂停。
GetIsPaused(FrameworkElement)	检索一个值，该值指示为此 Clock 创建的 Storyboard 是否已暂停。
GetLocalValueEnumerator()	创建一个专用的枚举数，用于确定哪些依赖项属性在此 DependencyObject 上具有以本地方式设置的值。 (继承自 DependencyObject)
GetNaturalDuration(Clock)	返回此 Timeline 单次迭代的长度。 (继承自 Timeline)
GetNaturalDurationCore(Clock)	从指定的 Clock 返回自然持续时间（单个迭代的持续时间）。 (继承自 ParallelTimeline)
GetTarget(DependencyObject)	检索指定的 Target 的 Timeline 值。
GetTargetName(DependencyObject)	检索指定的 TargetName 的 Timeline 值。
GetTargetProperty(DependencyObject)	检索指定的 TargetProperty 的 Timeline 值。
GetType()	获取当前实例的 Type。 (继承自 Object)
GetValue(DependencyProperty)	对 DependencyObject 的此实例返回依赖属性的当前有效值。 (继承自 DependencyObject)
InvalidateProperty(DependencyProperty)	重新评估指定依赖属性的有效值。 (继承自 DependencyObject)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnChanged()	修改当前 Freezable 对象时调用。 (继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	确保为刚刚设置的 DependencyObjectType 数据成员建立适当的上下文指针。 (继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	此成员支持Windows Presentation Foundation (WPF) 基础结构，不应直接从代码使用。 (继承自 Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	重写 OnPropertyChanged(DependencyPropertyChangedEventArgs) 的 DependencyObject 实现，以同时调用任何响应类型 Freezable 不断变化的依赖属性的 Changed 处理程序。 (继承自 Freezable)
Pause()	暂停为此 Clock 创建的 Storyboard。
Pause(FrameworkContentElement)	暂停与此 Storyboard 关联的指定 FrameworkContentElement 的 Clock。
Pause(FrameworkElement)	暂停与此 Storyboard 关联的指定 FrameworkElement 的 Clock。
ReadLocalValue(DependencyProperty)	如果存在，则返回依赖属性的本地值。 (继承自 DependencyObject)
ReadPreamble()	确保正在从有效的线程访问 Freezable。 Freezable 的继承者必须在任何 API 一开始读取不属于依赖项对象的数据成员时调用此方法。 (继承自 Freezable)
Remove()	删除为此 Storyboard 创建的 Clock 对象 无论其 FillBehavior 设置如何，属于此 Storyboard 的动画将不再影响曾尤其进行动画处理的属性。
Remove(FrameworkContentElement)	删除为此 Storyboard 创建的 Clock 对象 无论其 FillBehavior 设置如何，属于此 Storyboard 的动画将不再影响曾尤其进行动画处理的属性。
Remove(FrameworkElement)	删除为此 Storyboard 创建的 Clock 对象 无论其 FillBehavior 设置如何，属于此 Storyboard 的动画将不再影响曾尤其进行动画处理的属性。
Resume()	恢复为此 Storyboard 创建的 Clock。
Resume(FrameworkContentElement)	恢复为此 Storyboard 创建的 Clock。
Resume(FrameworkElement)	恢复为此 Storyboard 创建的 Clock。
Seek(FrameworkContentElement, TimeSpan, TimeSeekOrigin)	将此 Storyboard 定位到指定位置。 Storyboard 在时钟下一次走动时执行请求的定位操作。
Seek(FrameworkElement, TimeSpan, TimeSeekOrigin)	将此 Storyboard 定位到指定位置。 Storyboard 在时钟下一次走动时执行请求的定位操作。
Seek(TimeSpan)	将此 Storyboard 定位到指定位置。 Storyboard 在时钟下一次走动时执行请求的定位操作。
Seek(TimeSpan, TimeSeekOrigin)	将此 Storyboard 定位到指定位置。 Storyboard 在时钟下一次走动时执行请求的定位操作。
SeekAlignedToLastTick(FrameworkContentElement, TimeSpan, TimeSeekOrigin)	立即将此 Storyboard 指定到新位置（同步）。
SeekAlignedToLastTick(FrameworkElement, TimeSpan, TimeSeekOrigin)	立即将此 Storyboard 指定到新位置（同步）。
SeekAlignedToLastTick(TimeSpan)	立即将此 Storyboard 指定到新位置（同步）。
SeekAlignedToLastTick(TimeSpan, TimeSeekOrigin)	立即将此 Storyboard 指定到新位置（同步）。
SetCurrentValue(DependencyProperty, Object)	设置依赖属性的值而不更改其值源。 (继承自 DependencyObject)
SetSpeedRatio(Double)	设置为此 Clock 创建的 Storyboard 的交互速度比。
SetSpeedRatio(FrameworkContentElement, Double)	设置为此 Storyboard 创建的 Clock 的交互式速比。
SetSpeedRatio(FrameworkElement, Double)	设置为此 Storyboard 创建的 Clock 的交互式速比。
SetTarget(DependencyObject, DependencyObject)	使指定的 Timeline 以此依赖项对象为目标。
SetTargetName(DependencyObject, String)	使指定的 Timeline 面向具有指定名称的依赖属性。
SetTargetProperty(DependencyObject, PropertyPath)	使指定的 Timeline 目标成为指定的依赖属性。
SetValue(DependencyProperty, Object)	设置依赖属性的本地值，该值由其依赖属性标识符指定。 (继承自 DependencyObject)
SetValue(DependencyPropertyKey, Object)	设置一个只读依赖属性的本地值，该值由依赖属性的 DependencyPropertyKey 标识符指定。 (继承自 DependencyObject)
ShouldSerializeProperty(DependencyProperty)	返回一个值，该值指示序列化进程是否应序列化所提供的依赖属性的值。 (继承自 DependencyObject)
SkipToFill()	将此情节提要的 Clock 当前时间提前到其有效期的末尾。
SkipToFill(FrameworkContentElement)	将此情节提要的 Clock 当前时间提前到其有效期的末尾。
SkipToFill(FrameworkElement)	将此情节提要的 Clock 当前时间提前到其有效期的末尾。
Stop()	停止为此 Storyboard 创建的 Clock。
Stop(FrameworkContentElement)	停止为此 Storyboard 创建的 Clock。
Stop(FrameworkElement)	停止为此 Storyboard 创建的 Clock。
ToString()	返回表示当前对象的字符串。 (继承自 Object)
VerifyAccess()	强制调用线程具有此 DispatcherObject 的访问权限。 (继承自 DispatcherObject)
WritePostscript()	引发 Freezable 的 Changed 事件并调用其 OnChanged() 方法。 从 Freezable 派生的类应在修改的类成员不存储为依赖属性的任何 API 的末尾调用此方法。 (继承自 Freezable)
WritePreamble()	验证 Freezable 是否未被冻结，并且是否正在从有效的线程上下文中访问它。 Freezable 的继承项应当在任何 API 一开始写入不属于依赖项属性的数据成员时调用此方法。 (继承自 Freezable)

事件

Changed	在修改 Freezable 或其包含的对象时发生。 (继承自 Freezable)
Completed	当此时间线完全播放完毕时发生：它将不再进入其活动周期。 (继承自 Timeline)
CurrentGlobalSpeedInvalidated	在时间线时钟的时间前进速率发生变化时发生。 (继承自 Timeline)
CurrentStateInvalidated	更新时间线的 Clock 的 CurrentState 属性时发生。 (继承自 Timeline)
CurrentTimeInvalidated	更新时间线的 Clock 的 CurrentTime 属性时发生。 (继承自 Timeline)
RemoveRequested	当移除为此时间线创建的时钟或其中一个父时间线时发生。 (继承自 Timeline)

显式接口实现

IAddChild.AddChild(Object)	添加子对象。 (继承自 TimelineGroup)
IAddChild.AddText(String)	将节点的文本内容添加到对象。 (继承自 TimelineGroup)