IXRTimeline::GetDuration (Compact 2013)

3/28/2014

This method retrieves the total length of time that this timeline will play.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetDuration(
    XRDuration* pDuration
) = 0;

Parameters

• pDuration
  [out] Pointer to an XRDuration structure that indicates the total length of time that this timeline will play.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

The simple duration of a timeline is the time for a single forward iteration, whereas the total play time includes all repetitions.

If the duration value for an animation is not explicitly set either in C++ code or in the source XAML for your application, it will be null. Leaving this default value has the same effect on an animation as setting the pDuration value to XRDuration::DurationType_Automatic.

If IXRTimeline::GetAutoReverse retrieves a value of true, the timeline plays for double the length specified by pDuration.

This method applies both to specific animations and to the parent storyboard. For an animation in a storyboard, make sure that you do not unintentionally clip the durations of child animations when you call IXRTimeline::SetDuration.

For information about how to make a timeline repeat itself, see IXRTimeline::SetRepeatBehavior.

NET Framework Equivalent

System.Windows.Media.Animation.Timeline.Duration

Requirements

See Also

Reference

IXRTimeline
IXRTimeline::SetDuration