Format(DateTime,DateTime,String,String,Boolean) Method

Formats the specified date/time range for display.

Syntax

Visual Basic

'Declaration
 
Public Overloads Shared Function Format( _
   ByVal start As Date, _
   ByVal end As Date, _
   ByVal dateFormat As String, _
   ByVal separator As String, _
   ByVal adjustEndDateTime As Boolean _
) As String

C#

public static string Format( 
   DateTime start,
   DateTime end,
   string dateFormat,
   string separator,
   bool adjustEndDateTime
)

Parameters

start

The date and time of the beginning of the range to format.

end

The date and time of the end of the range to format.

dateFormat

The format string to be applied to the start and end date/time.

separator

The character(s) to be used to separate the start and end date/time.

adjustEndDateTime

Specifies whether the end time is adjusted up to the nearest whole minute. For example, if the EndDateTime of the range is 11:59:59 PM, specifying true will result in a displayed value of "12AM".

Return Value

The string representation of the specified date range.

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