Share via

  • Article

TimeSpan

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a time interval.

<object property="timeSpanString"  .../>

object.property="timeSpanString"

timeSpanString Grammar

Type

Grammar

Example

Example result

Time span

[days.]hours:minutes:seconds[.fractionalSeconds]

"0:0:15"

When set as a BeginTime value, starts the timeline 15 seconds into its timeline duration.

  • In the grammar above, square brackets ([]) indicate optional values; the brackets are not literals. The colon (:) and period (.) characters are both literals.

  • Values for hours can be any integer value from 0 through 23. Values for minutes and seconds can be any integer value from 0 through 59. The value for days can be very large, but it does have an unspecified upper bound. The decimal value for fractionalSeconds (with the decimal point included) must be between 0 and 1.

Managed Equivalent

TimeSpan

Remarks

You can create a Duration, KeyTime, RepeatBehavior, or TimeSpan object in XAML or in script only through a type conversion syntax when you set a property (such as BeginTime) that takes one of these types, with the value specified as a string. The string format for specifying a time span in each of these types is identical.

The main scenario for working with a TimeSpan as an object in script is to get or set its Seconds property to query or change an existing animation value.

The typical time span of an animation is in seconds. Therefore, the TimeSpan string would include preceding 0 values for hours and minutes, along with the appropriate literal characters—colons (:) and periods (.)—as separators between hours, minutes, seconds, and fractions of seconds. For example, to specify a TimeSpan of 5 seconds, you would set the TimeSpan string to "0:0:5" ("0:0:05" is equivalent).

Important noteImportant Note:

If you specify a TimeSpan by an integer without any time span literal characters—colons (:) or periods (.)—the integer will be interpreted only as a number of days. This is seldom the intended result and will typically cause the TimeSpan to be unexpectedly large.

For more information on basic concepts, see Animation Overview. Note that the Animation Overview topic is written primarily for users of the managed API, and may not have code examples or specific information that address the JavaScript API scenarios.