Export (0) Print
Expand All

Decimal.Equals Method (Object)

Returns a value indicating whether this instance and a specified Object represent the same type and value.

Namespace:  System
Assemblies:   mscorlib (in mscorlib.dll)
  System.Runtime (in System.Runtime.dll)

'Declaration
Public Overrides Function Equals ( _
	value As Object _
) As Boolean

Parameters

value
Type: System.Object

The object to compare with this instance.

Return Value

Type: System.Boolean
true if value is a Decimal and equal to this instance; otherwise, false.

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

' Example of the Decimal.CompareTo and Decimal.Equals instance methods. 
Imports System
Imports Microsoft.VisualBasic

Module DecCompToEqualsObjDemo

    ' Get the exception type name; remove the namespace prefix. 
    Function GetExceptionType( ex As Exception ) As String 

        Dim exceptionType   As String = ex.GetType( ).ToString( )
        Return exceptionType.Substring( _
            exceptionType.LastIndexOf( "."c ) + 1 )
    End Function 

    ' Compare the Decimal to the Object parameters,  
    ' and display the Object parameters with the results. 
    Sub CompDecimalToObject( Left as Decimal, Right as Object, _
        RightText as String )

        Console.WriteLine( "{0,-46}{1}", "Object: " & RightText, _
            Right )
        Console.WriteLine( "{0,-46}{1}", "Left.Equals( Object )", _
            Left.Equals( Right ) )
        Console.Write( "{0,-46}", "Left.CompareTo( Object )" )

        ' Catch the exception if CompareTo( ) throws one. 
        Try
            Console.WriteLine( "{0}" & vbCrLf, _
                Left.CompareTo( Right ) )
        Catch ex As Exception
            Console.WriteLine( "{0}" & vbCrLf, _
                GetExceptionType( ex ) )
        End Try 
    End Sub 

    Sub Main( )
        Console.WriteLine( _
            "This example of the Decimal.Equals( Object ) " & _
            "and " & vbCrLf & "Decimal.CompareTo( Object ) " & _
            "methods generates the " & vbCrLf & _
            "following output. It creates several different " & _
            "Decimal " & vbCrLf & "values and compares them " & _
            "with the following reference value." & vbCrLf )

        ' Create a reference Decimal value. 
        Dim Left as New Decimal( 987.654 )

        Console.WriteLine( "{0,-46}{1}" & vbCrLf, _
            "Left: Decimal( 987.654 )", Left )

        ' Create objects to compare with the reference.
        CompDecimalToObject( Left, New Decimal( 9.8765400E+2 ), _
            "Decimal( 9.8765400E+2 )" )
        CompDecimalToObject( Left, 987.6541D, "987.6541D" )
        CompDecimalToObject( Left, 987.6539D, "987.6539D" )
        CompDecimalToObject( Left, _
            New Decimal( 987654000, 0, 0, false, 6 ), _
            "Decimal( 987654000, 0, 0, false, 6 )" )
        CompDecimalToObject( Left, 9.8765400E+2, _
            "Double 9.8765400E+2" )
        CompDecimalToObject( Left, "987.654", _
            "String ""987.654""" )
    End Sub 
End Module  

' This example of the Decimal.Equals( Object ) and 
' Decimal.CompareTo( Object ) methods generates the 
' following output. It creates several different Decimal 
' values and compares them with the following reference value. 
'  
' Left: Decimal( 987.654 )                      987.654 
'  
' Object: Decimal( 9.8765400E+2 )               987.654 
' Left.Equals( Object )                         True 
' Left.CompareTo( Object )                      0 
'  
' Object: 987.6541D                             987.6541 
' Left.Equals( Object )                         False 
' Left.CompareTo( Object )                      -1 
'  
' Object: 987.6539D                             987.6539 
' Left.Equals( Object )                         False 
' Left.CompareTo( Object )                      1 
'  
' Object: Decimal( 987654000, 0, 0, false, 6 )  987.654000 
' Left.Equals( Object )                         True 
' Left.CompareTo( Object )                      0 
'  
' Object: Double 9.8765400E+2                   987.654 
' Left.Equals( Object )                         False 
' Left.CompareTo( Object )                      ArgumentException 
'  
' Object: String "987.654"                      987.654 
' Left.Equals( Object )                         False 
' Left.CompareTo( Object )                      ArgumentException

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft