TimeSpan.Equals Method (Object)

July 28, 2014

Returns a value indicating whether this instance is equal to a specified object.

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

public override bool Equals(
	Object value
)

Parameters

value
Type: System.Object
An object to compare with this instance.

Return Value

Type: System.Boolean
true if value is a TimeSpan object that represents the same time interval as the current TimeSpan structure; otherwise, false.

The following code example compares several TimeSpan and other objects to a reference TimeSpan using the Equals method.


// Example of the TimeSpan.CompareTo( Object ) and 
// TimeSpan.Equals( Object ) methods.
using System;

class Example
{
   // Compare the TimeSpan to the Object parameters, 
   // and display the Object parameters with the results.
   static void CompTimeSpanToObject(System.Windows.Controls.TextBlock outputBlock, TimeSpan Left, object Right,
       string RightText)
   {
      outputBlock.Text += String.Format("{0,-33}{1}", "Object: " + RightText,
          Right) + "\n";
      outputBlock.Text += String.Format("{0,-33}{1}", "Left.Equals( Object )",
          Left.Equals(Right)) + "\n";
      outputBlock.Text += String.Format("{0,-33}", "Left.CompareTo( Object )");

      // Catch the exception if CompareTo( ) throws one.
      try
      {
         outputBlock.Text += String.Format("{0}\n", Left.CompareTo(Right)) + "\n";
      }
      catch (Exception ex)
      {
         outputBlock.Text += String.Format("Error: {0}\n", ex.Message) + "\n";
      }
   }

   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      TimeSpan Left = new TimeSpan(0, 5, 0);

      outputBlock.Text += String.Format(
          "This example of the TimeSpan.Equals( Object ) " +
          "and \nTimeSpan.CompareTo( Object ) methods generates " +
          "the \nfollowing output by creating several different " +
          "TimeSpan \nobjects and comparing them with a " +
          "5-minute TimeSpan.\n") + "\n";
      outputBlock.Text += String.Format("{0,-33}{1}\n",
          "Left: TimeSpan( 0, 5, 0 )", Left) + "\n";

      // Create objects to compare with a 5-minute TimeSpan.
      CompTimeSpanToObject(outputBlock, Left, new TimeSpan(0, 0, 300),
          "TimeSpan( 0, 0, 300 )");
      CompTimeSpanToObject(outputBlock, Left, new TimeSpan(0, 5, 1),
          "TimeSpan( 0, 5, 1 )");
      CompTimeSpanToObject(outputBlock, Left, new TimeSpan(0, 5, -1),
          "TimeSpan( 0, 5, -1 )");
      CompTimeSpanToObject(outputBlock, Left, new TimeSpan(3000000000),
          "TimeSpan( 3000000000 )");
      CompTimeSpanToObject(outputBlock, Left, 3000000000L,
          "long 3000000000L");
      CompTimeSpanToObject(outputBlock, Left, "00:05:00",
          "string \"00:05:00\"");
   }
}

/*
This example of the TimeSpan.Equals( Object ) and
TimeSpan.CompareTo( Object ) methods generates the
following output by creating several different TimeSpan
objects and comparing them with a 5-minute TimeSpan.

Left: TimeSpan( 0, 5, 0 )        00:05:00

Object: TimeSpan( 0, 0, 300 )    00:05:00
Left.Equals( Object )            True
Left.CompareTo( Object )         0

Object: TimeSpan( 0, 5, 1 )      00:05:01
Left.Equals( Object )            False
Left.CompareTo( Object )         -1

Object: TimeSpan( 0, 5, -1 )     00:04:59
Left.Equals( Object )            False
Left.CompareTo( Object )         1

Object: TimeSpan( 3000000000 )   00:05:00
Left.Equals( Object )            True
Left.CompareTo( Object )         0

Object: long 3000000000L         3000000000
Left.Equals( Object )            False
Left.CompareTo( Object )         Error: Object must be of type TimeSpan.

Object: string "00:05:00"        00:05:00
Left.Equals( Object )            False
Left.CompareTo( Object )         Error: Object must be of type TimeSpan.
*/


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft