DateTimeOffset.LessThanOrEqual Operator

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

Determines whether one specified DateTimeOffset object is less than a second specified DateTimeOffset object.

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

Syntax

Public Shared Operator <= ( _
    left As DateTimeOffset, _
    right As DateTimeOffset _
) As Boolean
public static bool operator <=(
    DateTimeOffset left,
    DateTimeOffset right
)

Parameters

Return Value

Type: System..::.Boolean
true if the UtcDateTime value of left is earlier than the UtcDateTime value of right; otherwise, false.

Remarks

The LessThanOrEqual method defines the operation of the less than or equal to operator for DateTimeOffset objects. It enables code such as the following:

Dim date1 As New DateTimeOffset(#6/3/2007 2:45:00 PM#, _
             New TimeSpan(-7, 0, 0))
Dim date2 As New DateTimeOffset(#6/3/2007 3:45:00 PM#, _
             New TimeSpan(-7, 0, 0))
Dim date3 As New DateTimeOffset(date1.DateTime, _
             New TimeSpan(-6, 0, 0))
Dim date4 As DateTimeOffset = date1
outputBlock.Text &= (date1 <= date2) & vbCrLf        ' Displays True
outputBlock.Text &= (date1 <= date3) & vbCrLf        ' Displays False
outputBlock.Text &= (date1 <= date4) & vbCrLf        ' Displays True
DateTimeOffset date1 = new DateTimeOffset(2007, 6, 3, 14, 45, 0,
             new TimeSpan(-7, 0, 0));
DateTimeOffset date2 = new DateTimeOffset(2007, 6, 3, 15, 45, 0,
             new TimeSpan(-7, 0, 0));
DateTimeOffset date3 = new DateTimeOffset(date1.DateTime,
             new TimeSpan(-6, 0, 0));
DateTimeOffset date4 = date1;
outputBlock.Text += (date1 <= date2) + "\n";        // Displays True
outputBlock.Text += (date1 <= date3) + "\n";        // Displays False 
outputBlock.Text += (date1 <= date4) + "\n";        // Displays True 

Languages that do not support custom operators can call the Compare method instead. Some languages can also call the LessThanOrEqual method directly, as the following example shows.

Dim date1 As New DateTimeOffset(#6/3/2007 2:45:00 PM#, _
             New TimeSpan(-7, 0, 0))
Dim date2 As New DateTimeOffset(#6/3/2007 3:45:00 PM#, _
             New TimeSpan(-7, 0, 0))
Dim date3 As New DateTimeOffset(date1.DateTime, _
             New TimeSpan(-6, 0, 0))
Dim date4 As DateTimeOffset = date1
outputBlock.Text += DateTimeOffset.op_LessThanOrEqual(date1, date2).ToString() & vbCrLf   ' Displays True
outputBlock.Text += DateTimeOffset.op_LessThanOrEqual(date1, date3).ToString() & vbCrLf ' Displays False
outputBlock.Text += DateTimeOffset.op_LessThanOrEqual(date1, date4).ToString() & vbCrLf ' Displays True

Before evaluating the left and right operands, the operator converts both values to Coordinated Universal Time (UTC). The operation is equivalent to the following:

Return left.UtcDateTime <= right.UtcDateTime
return left.UtcDateTime <= right.UtcDateTime;

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

DateTimeOffset Structure

System Namespace