Duration​Helper Duration​Helper Duration​Helper Duration​Helper Class

Definition

Provides basic utility methods for processing Duration values. C# and Microsoft Visual Basic code should use methods of Duration instead.

public : sealed class DurationHelper : IDurationHelperpublic sealed class DurationHelper : IDurationHelperPublic NotInheritable Class DurationHelper Implements IDurationHelper// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Duration is a Windows Runtime structure that represents a unit of time for an animation behavior. For example, Timeline.Duration uses a Duration value.

DurationHelper is one of several Helper classes that are intended to provide utility methods for Windows Runtime structure values. C# and Microsoft Visual Basic code can use members of Duration instead, because utility members are available directly on the structure due to .NET Framework runtime support. C++ code can only access the Timespan data value on Duration. For C++ developers, approximately the same utility features that a Microsoft Visual Basic developer could use directly on Duration are available in a static form on the DurationHelper class.

Properties

Automatic Automatic Automatic Automatic

Returns a generated Duration value that indicates an "Automatic" Duration. C# and Microsoft Visual Basic code should use Automatic instead.

public : static Duration Automatic { get; }public static Duration Automatic { get; }Public Static ReadOnly Property Automatic As Duration// This API is not available in Javascript.
Value
Duration Duration Duration Duration

A Duration value that indicates an "Automatic"**Duration.

Forever Forever Forever Forever

Returns a generated Duration value that indicates a "Forever" Duration. C# and Microsoft Visual Basic code should use Forever instead.

public : static Duration Forever { get; }public static Duration Forever { get; }Public Static ReadOnly Property Forever As Duration// This API is not available in Javascript.
Value
Duration Duration Duration Duration

A Duration value that indicates a "Forever"**Duration.

Methods

Add(Duration, Duration) Add(Duration, Duration) Add(Duration, Duration) Add(Duration, Duration)

Adds the TimeSpan component of two Duration values. C# and Microsoft Visual Basic code should use the + operator or the Add method instead.

public : static Duration Add(Duration target, Duration duration)public static Duration Add(Duration target, Duration duration)Public Static Function Add(target As Duration, duration As Duration) As Duration// This API is not available in Javascript.
Parameters
target
Duration Duration Duration Duration

The value to add to.

duration
Duration Duration Duration Duration

The value to add.

Returns

The resulting Duration after TimeSpan component addition.

Compare(Duration, Duration) Compare(Duration, Duration) Compare(Duration, Duration) Compare(Duration, Duration)

Compares value equality of two Duration structures. C# and Microsoft Visual Basic code should use Compare instead.

public : static int Compare(Duration duration1, Duration duration2)public static int Compare(Duration duration1, Duration duration2)Public Static Function Compare(duration1 As Duration, duration2 As Duration) As int// This API is not available in Javascript.
Parameters
duration1
Duration Duration Duration Duration

The first Duration to compare.

duration2
Duration Duration Duration Duration

The second Duration to compare.

Returns
int int int int

If duration1 is less than duration2, a negative value that represents the difference. If duration1 is equal to duration2, zero. If duration1 is greater than duration2, a positive value that represents the difference.

Remarks

Duration instances with a value of Automaticare a special case with the following return values:

  • If duration1 is Automatic and duration2 is not, -1 is returned.
  • If duration1 is Automatic and duration2 is also Automatic, 0 is returned.
  • If duration1 is not Automatic and duration2 is Automatic, 1 is returned.

Equals(Duration, Duration) Equals(Duration, Duration) Equals(Duration, Duration) Equals(Duration, Duration)

Determines whether two Duration values have equivalent values. C# and Microsoft Visual Basic code should use the = operator instead.

public : static PlatForm::Boolean Equals(Duration target, Duration value)public static bool Equals(Duration target, Duration value)Public Static Function Equals(target As Duration, value As Duration) As bool// This API is not available in Javascript.
Parameters
target
Duration Duration Duration Duration

The first Duration to compare.

value
Duration Duration Duration Duration

The second Duration to compare.

Returns
PlatForm::Boolean bool bool bool

true if target and value hold equivalent values; otherwise, false.

See Also

FromTimeSpan(TimeSpan) FromTimeSpan(TimeSpan) FromTimeSpan(TimeSpan) FromTimeSpan(TimeSpan)

Creates a new Duration based on a TimeSpan value. C# and Microsoft Visual Basic code should Duration(TimeSpan) instead.

public : static Duration FromTimeSpan(TimeSpan timeSpan)public static Duration FromTimeSpan(TimeSpan timeSpan)Public Static Function FromTimeSpan(timeSpan As TimeSpan) As Duration// This API is not available in Javascript.
Parameters
timeSpan
TimeSpan TimeSpan TimeSpan TimeSpan

The initializing TimeSpan.

Returns

GetHasTimeSpan(Duration) GetHasTimeSpan(Duration) GetHasTimeSpan(Duration) GetHasTimeSpan(Duration)

Returns whether the TimeSpan component of a given Duration holds a non-null value. C# and Microsoft Visual Basic code should use HasTimeSpan instead.

public : static PlatForm::Boolean GetHasTimeSpan(Duration target)public static bool GetHasTimeSpan(Duration target)Public Static Function GetHasTimeSpan(target As Duration) As bool// This API is not available in Javascript.
Parameters
target
Duration Duration Duration Duration

The Duration value to evaluate.

Returns
PlatForm::Boolean bool bool bool

true if the TimeSpan component of the provided Duration is not null; otherwise, false.

Remarks

If this method returns false, then the Duration is either uninitialized or holds one of the special values of Automatic or Forever.

Subtract(Duration, Duration) Subtract(Duration, Duration) Subtract(Duration, Duration) Subtract(Duration, Duration)

Subtracts the TimeSpan component of one Duration value from another Duration value. C# and Microsoft Visual Basic code should use the - operator or the Subtract method instead.

public : static Duration Subtract(Duration target, Duration duration)public static Duration Subtract(Duration target, Duration duration)Public Static Function Subtract(target As Duration, duration As Duration) As Duration// This API is not available in Javascript.
Parameters
target
Duration Duration Duration Duration

The value to subtract from.

duration
Duration Duration Duration Duration

The value to subtract.

Returns

The resulting Duration after TimeSpan component subtraction.

See Also