ToDateTime Method (Object)
Collapse the table of content
Expand the table of content

Convert.ToDateTime Method (Object)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Converts the value of the specified Object to a DateTime.

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

'Declaration
Public Shared Function ToDateTime ( _
	value As Object _
) As DateTime

Parameters

value
Type: System.Object
An Object that implements the IConvertible interface or Nothing.

Return Value

Type: System.DateTime
A DateTime equivalent to the value of value.
-or-
A DateTime equivalent to DateTime.MinValue if value is Nothing.

ExceptionCondition
FormatException

value is not a valid DateTime value.

InvalidCastException

value does not implement IConvertible.

-or-

The conversion is not supported.

For the conversion to succeed, the runtime type of the value parameter must be either a DateTime or a String, or value must be Nothing. Otherwise, the method throws an InvalidCastException. In addition, if value is a string, it must contain a valid representation of a date and time value in the current culture or a FormatException is thrown.

The return value is the result of invoking the IConvertible.ToDateTime method of the underlying type of value.

The following example calls the ToDateTime(Object) method with a variety of Object variables.


Module Example
   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Try converting an integer.
      Dim number As Integer = 16352
      ConvertToDateTime(outputBlock, number)

      ' Convert a null.
      Dim obj As Object = Nothing
      ConvertToDateTime(outputBlock, obj)

      ' Convert a non-date string.
      Dim nonDateString As String = "monthly"
      ConvertToDateTime(outputBlock, nonDateString)

      ' Try to convert various dates.
      Dim dateString As String
      dateString = "05/01/1996"
      ConvertToDateTime(outputBlock, dateString)
      dateString = "Tue Apr 28, 2009"
      ConvertToDateTime(outputBlock, dateString)
      dateString = "06 July 2008 7:32:47 AM"
      ConvertToDateTime(outputBlock, dateString)
      dateString = "17:32:47.003"
      ConvertToDateTime(outputBlock, dateString)
   End Sub

   Private Sub ConvertToDateTime(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal value As Object)
      Dim convertedDate As Date
      Try
         convertedDate = Convert.ToDateTime(value)
         outputBlock.Text += String.Format("'{0}' converts to {1}.", value, convertedDate) & vbCrLf
      Catch e As FormatException
         outputBlock.Text += String.Format("'{0}' is not in the proper format.", value) & vbCrLf
      Catch e As InvalidCastException
         outputBlock.Text += String.Format("Conversion of the {0} '{1}' is not supported", _
                           value.GetType().Name, value) & vbCrLf
      End Try
   End Sub
End Module
' The example displays the following output:
'       Conversion of the Int32 '16352' is not supported
'       '' converts to 1/1/0001 12:00:00 AM.
'       'monthly' is not in the proper format.
'       '05/01/1996' converts to 5/1/1996 12:00:00 AM.
'       'Tue Apr 28, 2009' converts to 4/28/2009 12:00:00 AM.
'       '06 July 2008 7:32:47 AM' converts to 7/6/2008 7:32:47 AM.
'       '17:32:47.003' converts to 5/28/2008 5:32:47 PM.


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft