Export (0) Print
Expand All

Char.IsSurrogatePair Method (Char, Char)

Note: This method is new in the .NET Framework version 2.0.

Indicates whether the two specified Char objects form a surrogate pair.

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

public static bool IsSurrogatePair (
	char highSurrogate,
	char lowSurrogate
)
public static boolean IsSurrogatePair (
	char highSurrogate, 
	char lowSurrogate
)
public static function IsSurrogatePair (
	highSurrogate : char, 
	lowSurrogate : char
) : boolean

Parameters

highSurrogate

A character.

lowSurrogate

A character.

Return Value

true if the numeric value of the highSurrogate parameter ranges from U+D800 through U+DBFF, and the numeric value of the lowSurrogate parameter ranges from U+DC00 through U+DFFF; otherwise, false.

The following code example demonstrates the IsHighSurrogate, IsLowSurrogate, and IsSurrogatePair methods.

// This example demonstrates the Char.IsLowSurrogate() method
//                                    IsHighSurrogate() method
//                                    IsSurrogatePair() method
using System;

class Sample 
{
    public static void Main() 
    {
    char cHigh = '\uD800';
    char cLow  = '\uDC00';
    string s1  = new String(new char[] {'a', '\uD800', '\uDC00', 'z'});
    string divider = String.Concat( Environment.NewLine, new String('-', 70), 
                                    Environment.NewLine);

    Console.WriteLine();
    Console.WriteLine("Hexadecimal code point of the character, cHigh: {0:X4}", (int)cHigh);
    Console.WriteLine("Hexadecimal code point of the character, cLow:  {0:X4}", (int)cLow);
    Console.WriteLine();
    Console.WriteLine("Characters in string, s1: 'a', high surrogate, low surrogate, 'z'");
    Console.WriteLine("Hexadecimal code points of the characters in string, s1: ");
    for(int i = 0; i < s1.Length; i++)
        {
        Console.WriteLine("s1[{0}] = {1:X4} ", i, (int)s1[i]);
        }
    Console.WriteLine(divider);

    Console.WriteLine("Is each of the following characters a high surrogate?");
    Console.WriteLine("A1) cLow?  - {0}", Char.IsHighSurrogate(cLow));
    Console.WriteLine("A2) cHigh? - {0}", Char.IsHighSurrogate(cHigh));
    Console.WriteLine("A3) s1[0]? - {0}", Char.IsHighSurrogate(s1, 0));
    Console.WriteLine("A4) s1[1]? - {0}", Char.IsHighSurrogate(s1, 1));
    Console.WriteLine(divider);

    Console.WriteLine("Is each of the following characters a low surrogate?");
    Console.WriteLine("B1) cLow?  - {0}", Char.IsLowSurrogate(cLow));
    Console.WriteLine("B2) cHigh? - {0}", Char.IsLowSurrogate(cHigh));
    Console.WriteLine("B3) s1[0]? - {0}", Char.IsLowSurrogate(s1, 0));
    Console.WriteLine("B4) s1[2]? - {0}", Char.IsLowSurrogate(s1, 2));
    Console.WriteLine(divider);

    Console.WriteLine("Is each of the following pairs of characters a surrogate pair?");
    Console.WriteLine("C1) cHigh and cLow?  - {0}", Char.IsSurrogatePair(cHigh, cLow));
    Console.WriteLine("C2) s1[0] and s1[1]? - {0}", Char.IsSurrogatePair(s1, 0));
    Console.WriteLine("C3) s1[1] and s1[2]? - {0}", Char.IsSurrogatePair(s1, 1));
    Console.WriteLine("C4) s1[2] and s1[3]? - {0}", Char.IsSurrogatePair(s1, 2));
    Console.WriteLine(divider);
    }
}
/*
This example produces the following results:

Hexadecimal code point of the character, cHigh: D800
Hexadecimal code point of the character, cLow:  DC00

Characters in string, s1: 'a', high surrogate, low surrogate, 'z'
Hexadecimal code points of the characters in string, s1:
s1[0] = 0061
s1[1] = D800
s1[2] = DC00
s1[3] = 007A

----------------------------------------------------------------------

Is each of the following characters a high surrogate?
A1) cLow?  - False
A2) cHigh? - True
A3) s1[0]? - False
A4) s1[1]? - True

----------------------------------------------------------------------

Is each of the following characters a low surrogate?
B1) cLow?  - True
B2) cHigh? - False
B3) s1[0]? - False
B4) s1[2]? - True

----------------------------------------------------------------------

Is each of the following pairs of characters a surrogate pair?
C1) cHigh and cLow?  - True
C2) s1[0] and s1[1]? - False
C3) s1[1] and s1[2]? - True
C4) s1[2] and s1[3]? - False

----------------------------------------------------------------------

*/

// This example demonstrates the Char.IsLowSurrogate() method
// IsHighSurrogate() method
// sIsSurrogatePair() method
import System.*;

class Sample
{
    public static void main(String[] args)
    {
        char cHigh = '\uD800';
        char cLow = '\uDC00';
        String s1 = new String(new char[] { 'a', '\uD800', '\uDC00', 'z' });
        String divider = String.Concat(Environment.get_NewLine(), 
            new String('-', 70), Environment.get_NewLine());

        Console.WriteLine();
        Console.WriteLine("Hexadecimal code point of the character,"
            + " cHigh: {0:X4}", (Int32)cHigh);
        Console.WriteLine("Hexadecimal code point of the character,"
            + " cLow:  {0:X4}", (Int32)(cLow));
        Console.WriteLine();
        Console.WriteLine("Characters in string, s1: 'a', high surrogate,"
            + " low surrogate, 'z'");
        Console.WriteLine("Hexadecimal code points of the characters in string,"
            + " s1: ");
        for (int i = 0; i < s1.get_Length(); i++) {
            Console.WriteLine("s1[{0}] = {1:X4} ", (Int32)i, (Int32)s1.
                get_Chars(i));
        }
        Console.WriteLine(divider);
        Console.WriteLine("Is each of the following characters a high surrogate?");
        Console.WriteLine("A1) cLow?  - {0}", (System.Boolean)Char.
            IsHighSurrogate(cLow));
        Console.WriteLine("A2) cHigh? - {0}", (System.Boolean)Char.
            IsHighSurrogate(cHigh));
        Console.WriteLine("A3) s1[0]? - {0}", (System.Boolean)Char.
            IsHighSurrogate(s1, 0));
        Console.WriteLine("A4) s1[1]? - {0}", (System.Boolean)Char.
            IsHighSurrogate(s1, 1));
        Console.WriteLine(divider);

        Console.WriteLine("Is each of the following characters a low surrogate?");
        Console.WriteLine("B1) cLow?  - {0}", (System.Boolean)Char.
            IsLowSurrogate(cLow));
        Console.WriteLine("B2) cHigh? - {0}", (System.Boolean)Char.
            IsLowSurrogate(cHigh));
        Console.WriteLine("B3) s1[0]? - {0}", (System.Boolean)Char.
            IsLowSurrogate(s1, 0));
        Console.WriteLine("B4) s1[2]? - {0}", (System.Boolean)Char.
            IsLowSurrogate(s1, 2));
        Console.WriteLine(divider);

        Console.WriteLine("Is each of the following pairs of characters a"
            + " surrogate pair?");
        Console.WriteLine("C1) cHigh and cLow?  - {0}", (System.Boolean)Char.
            IsSurrogatePair(cHigh, cLow));
        Console.WriteLine("C2) s1[0] and s1[1]? - {0}", (System.Boolean)Char.
            IsSurrogatePair(s1, 0));
        Console.WriteLine("C3) s1[1] and s1[2]? - {0}", (System.Boolean)Char.
            IsSurrogatePair(s1, 1));
        Console.WriteLine("C4) s1[2] and s1[3]? - {0}", (System.Boolean)Char.
            IsSurrogatePair(s1, 2));
        Console.WriteLine(divider);
    } //main
} //Sample

/*
This example produces the following results:

Hexadecimal code point of the character, cHigh: D800
Hexadecimal code point of the character, cLow:  DC00

Characters in string, s1: 'a', high surrogate, low surrogate, 'z'
Hexadecimal code points of the characters in string, s1:
s1[0] = 0061
s1[1] = D800
s1[2] = DC00
s1[3] = 007A

----------------------------------------------------------------------

Is each of the following characters a high surrogate?
A1) cLow?  - False
A2) cHigh? - True
A3) s1[0]? - False
A4) s1[1]? - True

----------------------------------------------------------------------

Is each of the following characters a low surrogate?
B1) cLow?  - True
B2) cHigh? - False
B3) s1[0]? - False
B4) s1[2]? - True

----------------------------------------------------------------------

Is each of the following pairs of characters a surrogate pair?
C1) cHigh and cLow?  - True
C2) s1[0] and s1[1]? - False
C3) s1[1] and s1[2]? - True
C4) s1[2] and s1[3]? - False

----------------------------------------------------------------------

*/

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft