IsSurrogate Method (String, Int32)
Collapse the table of content
Expand the table of content

Char.IsSurrogate Method (String, Int32)

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

Indicates whether the character at the specified position in a specified string has a surrogate code unit.

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

public static bool IsSurrogate(
	string s,
	int index
)

Parameters

s
Type: System.String
A string.
index
Type: System.Int32
The character position in s.

Return Value

Type: System.Boolean
true if the character at position index in s is a either a high surrogate or a low surrogate; otherwise, false.

ExceptionCondition
ArgumentNullException

s is null.

ArgumentOutOfRangeException

index is less than zero or greater than the last position in s.

Character positions in a string are indexed starting from zero.

A surrogate is a Char object with a Unicode code unit in the range from U+D800 to U+DFFF. Each character with a code unit in this range belongs to the UnicodeCategory.Surrogate category. The individual surrogate code unit has no interpretation of its own, but has meaning only when used as part of a surrogate pair. For more information about surrogate pairs, see the Unicode Standard at the Unicode home page.

The following example demonstrates IsSurrogate.


using System;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      string str = "\U00010F00"; // Unicode values between 0x10000 and 0x10FFF are represented by two 16-bit "surrogate" characters

      outputBlock.Text += Char.IsSurrogate('a') + "\n";		// Output: "False"
      outputBlock.Text += Char.IsSurrogate(str, 0) + "\n";	// Output: "True"
   }
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft