Export (0) Print
Expand All

TimeSpan.ToString Method (String)

Converts the value of the current TimeSpan object to its equivalent string representation by using the specified format.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Function ToString ( _
	format As String _
) As String

Parameters

format
Type: System.String
A standard or custom TimeSpan format string.

Return Value

Type: System.String
The string representation of the current TimeSpan value in the format specified by the format parameter.

ExceptionCondition
FormatException

The format parameter is not recognized or is not supported.

The format parameter can be any valid standard or custom format specifier for TimeSpan values. If format is equal to String.Empty or is Nothing, the return value of the current TimeSpan object is formatted with the common format specifier ("c"). If format is any other value, the method throws a FormatException.

The format of the returned string is defined by the formatting conventions of the current culture.

The .NET Framework provides extensive formatting support, which is described in greater detail in the following formatting topics:

The following example uses standard TimeSpan format strings to display the string representation of each element in an array of TimeSpan values


Module Example
   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim spans() As TimeSpan = { TimeSpan.Zero, New TimeSpan(-14, 0, 0, 0, 0), 
                                  New TimeSpan(1, 2, 3), 
                                  New TimeSpan(0, 0, 0, 0, 250), 
                                  New TimeSpan(99, 23, 59, 59, 999),
                                  New TimeSpan(3, 0, 0), 
                                  New TimeSpan(0, 0, 0, 0, 25) }
      Dim fmts() As String = {"c", "g", "G"}
      For Each span As TimeSpan In spans
         For Each fmt As String In fmts
            outputBlock.Text += String.Format("{0}: {1}", fmt, span.ToString(fmt)) & vbCrLf
         Next
         outputBlock.Text &= vbCrLf
      Next
   End Sub
End Module
' The example displays the following output:
'       c: 00:00:00
'       g: 0:00:00
'       G: 0:00:00:00.0000000
'       
'       c: -14.00:00:00
'       g: -14:0:00:00
'       G: -14:00:00:00.0000000
'       
'       c: 01:02:03
'       g: 1:02:03
'       G: 0:01:02:03.0000000
'       
'       c: 00:00:00.2500000
'       g: 0:00:00.25
'       G: 0:00:00:00.2500000
'       
'       c: 99.23:59:59.9990000
'       g: 99:23:59:59.999
'       G: 99:23:59:59.9990000
'       
'       c: 03:00:00
'       g: 3:00:00
'       G: 0:03:00:00.0000000
'       
'       c: 00:00:00.0250000
'       g: 0:00:00.025
'       G: 0:00:00:00.0250000


Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions

ADD
Show:
© 2015 Microsoft