Format(TimeSpan,TimeSpanFormat) Method

Formats the specified TimeSpan using the default unit of time display strings.

Syntax

Visual Basic

'Declaration
 
Public Overloads Shared Function Format( _
   ByVal value As TimeSpan, _
   ByVal format As TimeSpanFormat _
) As String

C#

public static string Format( 
   TimeSpan value,
   TimeSpanFormat format
)

Parameters

value

The TimeSpan value to be formatted.

format

The format to use; specifies whether the unit of time is expressed as weeks, days, hours, or minutes.

Return Value

A human-readable string representation of the specified value.A string consisting of the TimeSpan value expressed in the units of time as specified by the value of the format parameter.

Remarks

The string returned from the Format method can be parsed back into a TimeSpan value using the Parse method.

The display strings used to represent units of time (week, day, hour, minute) are based on the English (United States) culture; to display different values, use the overload that allows explicit declaration of these values.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2