Timeline.GetNaturalDuration(Clock) Method

Definition

Returns the length of a single iteration of this Timeline.

protected public:
 System::Windows::Duration GetNaturalDuration(System::Windows::Media::Animation::Clock ^ clock);
protected internal System.Windows.Duration GetNaturalDuration (System.Windows.Media.Animation.Clock clock);
member this.GetNaturalDuration : System.Windows.Media.Animation.Clock -> System.Windows.Duration

Parameters

clock
Clock

The Clock that was created for this Timeline.

Returns

The length of a single iteration of this Timeline, or Automatic if the natural duration is unknown.

Remarks

This method should only be called when the Duration property is set to Automatic. If Duration is Automatic, the natural duration is determined by that particular class's implementation of GetNaturalDurationCore.

If GetNaturalDuration returns Automatic, it means that the natural duration is unknown, which implies a natural duration of Forever. Such is the case for streaming media.

Note that passing this method a clock other than the one that was created for this timeline is possible, but will provide unreliable results.

Applies to

See also