Share via


Encoding.Equals Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Determines whether the specified Object is equal to the current instance.

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

Syntax

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

Parameters

Return Value

Type: System.Boolean
true if value is an instance of Encoding and is equal to the current instance; otherwise, false.

Examples

The following example determines whether several Encoding objects are equal.

Imports System.Text

Public Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Get a UTF-16 encoding.
      Dim e16_1 As Encoding = Encoding.GetEncoding("utf-16")

      ' Instantiate a second UTF-16 encoding.
      Dim e16_2 As Encoding = New UnicodeEncoding()

      ' Instantiate a Unicode little endian encoding.
      Dim le As Encoding = New UnicodeEncoding(False, True)

      ' Instantiate a Unicode big endian encoding.
      Dim be As Encoding = New UnicodeEncoding(True, True)

      ' Get a UTF-8 encoding by name.
      Dim e8 As Encoding = Encoding.GetEncoding("utf-8")

      ' Check equality of e16_1 and e16_2.
      outputBlock.Text &= String.Format("{0} equals {1}? {2}", _
                                        e16_1.WebName, e16_2.WebName, _ 
                                        e16_1.Equals(e16_2)) & vbCrLf

      ' Check equality of e16_1 and unicode little endian encoding.
      outputBlock.Text &= String.Format("{0} equals {1}? {2}", _
                                        e16_1.WebName, le.WebName, _
                                        e16_1.Equals(le)) & vbCrLf

      ' Check equality of e16_1 and unicode bug endian encoding.
      outputBlock.Text &= String.Format("{0} equals {1}? {2}", _
                                        e16_1.WebName, be.WebName, _ 
                                        e16_1.Equals(be)) & vbCrLf

      ' Check equality of e16_1 and e8.
      outputBlock.Text &= String.Format("{0} equals {1}? {2}", _
                                        e16_1.WebName, e8.WebName, _ 
                                        e16_1.Equals(e8)) & vbCrLf
   End Sub
End Class
' This example produces the following output.
'       utf-16 equals utf-16? True
'       utf-16 equals utf-16? True
'       utf-16 equals utf16BE? False
'       utf-16 equals utf8? False
using System;
using System.Text;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // Get a UTF-16 encoding.
      Encoding e16_1 = Encoding.GetEncoding("utf-16");

      // Instantiate a second UTF-16 encoding.
      Encoding e16_2 = new UnicodeEncoding();

      // Instantiate a Unicode little endian encoding.
      Encoding le = new UnicodeEncoding(false, true);

      // Instantiate a Unicode big endian encoding.
      Encoding be = new UnicodeEncoding(true, true);

      // Get a UTF-8 encoding by name.
      Encoding e8 = Encoding.GetEncoding("utf-8");

      // Check equality of e16_1 and e16_2.
      outputBlock.Text += String.Format("{0} equals {1}? {2}\n", 
                                        e16_1.WebName, e16_2.WebName, 
                                        e16_1.Equals(e16_2));

      // Check equality of e16_1 and unicode little endian encoding.
      outputBlock.Text += String.Format("{0} equals {1}? {2}\n", 
                                        e16_1.WebName, le.WebName, 
                                        e16_1.Equals(le));

      // Check equality of e16_1 and unicode bug endian encoding.
      outputBlock.Text += String.Format("{0} equals {1}? {2}\n", 
                                        e16_1.WebName, be.WebName, 
                                        e16_1.Equals(be));

      // Check equality of e16_1 and e8.
      outputBlock.Text += String.Format("{0} equals {1}? {2}\n", 
                                        e16_1.WebName, e8.WebName, 
                                        e16_1.Equals(e8));
   }

}


/* 
This example produces the following output:
   utf-16 equals utf-16? True
   utf-16 equals utf-16? True
   utf-16 equals utf16BE? False
   utf-16 equals utf8? False
*/

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.