Edit

Share via

Timeline.Duration Property

  • Reference

Definition

Namespace:
System.Windows.Media.Animation
Assembly:
PresentationCore.dll

Gets or sets the length of time for which this timeline plays, not counting repetitions.

public:
 property System::Windows::Duration Duration { System::Windows::Duration get(); void set(System::Windows::Duration value); };
public System.Windows.Duration Duration { get; set; }
member this.Duration : System.Windows.Duration with get, set
Public Property Duration As Duration

Property Value

Duration

The timeline's simple duration: the amount of time this timeline takes to complete a single forward iteration. The default value is Automatic.

Examples

ParallelTimeline and Storyboard are types of TimelineGroup objects. The duration of a TimelineGroup is determined by the duration of its child timelines. For example, the Storyboard below will run for six seconds (duration of 6 seconds) because that is when its last child Timeline (DoubleAnimation) ends.

Note

Note: code has been omitted from the following examples, which are provided for illustrative purposed only.

[xaml]

...
  <Storyboard>
    <DoubleAnimation Duration="0:0:2" …/>
    <DoubleAnimation Duration="0:0:4" BeginTime="0:0:2" …/>
  </Storyboard>
...

Examples of <Type>Animations include DoubleAnimation, PointAnimation, ColorAnimation, etc. If no Duration is specified for these types of animations, they will run for one second.

[xaml]

...
  <!-- With no Duration specified, this animation will run for
       one second -->
  <DoubleAnimation .../>
...

Examples of <Type>AnimationUsingKeyFrames include DoubleAnimationUsingKeyFrames, PointAnimationUsingKeyFrames, etc. If no Duration is specified for these types of animations they will run until all key frames are finished.

[xaml]

...
  <Storyboard>

    <!-- This key frame animation will end at 4.5 seconds
         Because that is when its last KeyFrame KeyTime ends. -->
    <DoubleAnimationUsingKeyFrames ...>
      <LinearDoubleKeyFrame ... KeyTime="0:0:3" />
      <DiscreteDoubleKeyFrame ... KeyTime="0:0:3.5" />
      <DiscreteDoubleKeyFrame ... KeyTime="0:0:4" />
      <DiscreteDoubleKeyFrame ... KeyTime="0:0:4.5" />
    </DoubleAnimationUsingKeyFrames>
  </Storyboard>
...

Remarks

A timeline's simple duration constitutes the time for a single forward iteration versus the total play time, which includes repetitions.

Default Duration Behavior

The behavior of a Duration structure with a value of Automatic depends on the type of timeline:

Timeline Behavior
Timeline Undetermined (Timeline is abstract)
ParallelTimeline,

Storyboard,

TimelineGroup		 Expands to fit child timelines
<Type>Animation (Known as a "From/To/By" or "basic" animations) 1 second
<Type>AnimationUsingKeyFrames (Known as key frame animations) Sum of all key frame KeyTime values

Dependency Property Information

Item Value
Identifier field DurationProperty
Metadata properties set to true None

Applies to

See also