Class Storyboard

Controls animations with a timeline, and provides object and property targeting information for its child animations.

Inheritance
System.Object
DependencyObject
Timeline
Storyboard
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Media.Animation
Assembly: OpenSilver.dll
Syntax
public sealed class Storyboard : Timeline

Fields

| Improve this Doc View Source

TargetNameProperty

Identifies the Storyboard.TargetName XAML attached property.

Declaration
public static readonly DependencyProperty TargetNameProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

TargetProperty

Identifies the Storyboard.TargetName XAML attached property.

Declaration
public static readonly DependencyProperty TargetProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

TargetPropertyProperty

Identifies the Storyboard.TargetProperty XAML attached property.

Declaration
public static readonly DependencyProperty TargetPropertyProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

Children

Gets the collection of child Timeline objects.

Declaration
public TimelineCollection Children { get; }
Property Value
Type Description
TimelineCollection

Methods

| Improve this Doc View Source

Begin()

Initiates the set of animations associated with the storyboard.

Declaration
public void Begin()
| Improve this Doc View Source

GetCurrentState()

Declaration
[NotImplemented]
public ClockState GetCurrentState()
Returns
Type Description
ClockState
| Improve this Doc View Source

GetTarget(Timeline)

Gets the value of the Storyboard.Target XAML attached property from a target element.

Declaration
public static DependencyObject GetTarget(Timeline element)
Parameters
Type Name Description
Timeline element

The target element from which to get the value.
Returns
Type Description
DependencyObject

The Storyboard.Target value of the target element.
| Improve this Doc View Source

GetTargetName(Timeline)

Gets the value of the Storyboard.TargetName XAML attached property from a target element.

Declaration
public static string GetTargetName(Timeline element)
Parameters
Type Name Description
Timeline element

The target element from which to get the value.
Returns
Type Description
System.String

The Storyboard.TargetName value of the target element.
| Improve this Doc View Source

GetTargetProperty(Timeline)

Gets the value of the Storyboard.TargetProperty XAML attached property from a target element.

Declaration
public static PropertyPath GetTargetProperty(Timeline element)
Parameters
Type Name Description
Timeline element

The target element from which to get the value.
Returns
Type Description
PropertyPath

The Storyboard.TargetProperty value of the target element.
| Improve this Doc View Source

Pause()

Declaration
[NotImplemented]
public void Pause()
| Improve this Doc View Source

Resume()

Resumes the animation clock, or run-time state, associated with the storyboard.

Declaration
[NotImplemented]
public void Resume()
| Improve this Doc View Source

Seek(TimeSpan)

Declaration
[NotImplemented]
public void Seek(TimeSpan offset)
Parameters
Type Name Description
System.TimeSpan offset
| Improve this Doc View Source

SeekAlignedToLastTick(TimeSpan)

Moves the storyboard to the specified animation position immediately(synchronously).

Declaration
[NotImplemented]
public void SeekAlignedToLastTick(TimeSpan offset)
Parameters
Type Name Description
System.TimeSpan offset

A positive or negative time value that describes the amount by which the timeline should move forward or backward from the beginning of the animation. By using the TimeSpan Parse behavior, a TimeSpan can be specified as a string in the following format (in this syntax, the [] characters denote optional components of the string, but the quotes, colons, and periods are all a literal part of the syntax): "[days.]hours:minutes:seconds[.fractionalSeconds]"

  • or - "days"
| Improve this Doc View Source

SetTarget(Timeline, DependencyObject)

Causes the specified Timeline to target the specified object.

Declaration
public static void SetTarget(Timeline element, DependencyObject target)
Parameters
Type Name Description
Timeline element

The timeline that targets the specified dependency object.
DependencyObject target

The actual instance of the object to target.
| Improve this Doc View Source

SetTargetName(Timeline, String)

Sets the value of the Storyboard.TargetName XAML attached property for a target element.

Declaration
public static void SetTargetName(Timeline element, string name)
Parameters
Type Name Description
Timeline element

The target element to set the value for.
System.String name

The Storyboard.TargetName value of the target element to set. This should correspond to an existing Name or x:Name value on the element that the animation targets.
| Improve this Doc View Source

SetTargetProperty(Timeline, PropertyPath)

Sets the value of the Storyboard.TargetProperty XAML attached property for a target element.

Declaration
public static void SetTargetProperty(Timeline element, PropertyPath value)
Parameters
Type Name Description
Timeline element

The target element for which to set the value.
PropertyPath value
| Improve this Doc View Source

SkipToFill()

Declaration
[NotImplemented]
public void SkipToFill()
| Improve this Doc View Source

Stop()

Declaration
public void Stop()
| Improve this Doc View Source

Stop(FrameworkElement)

Stops the storyboard.

Declaration
public void Stop(FrameworkElement frameworkElement)
Parameters
Type Name Description
FrameworkElement frameworkElement

Extension Methods