System.Globalization.StringInfo.GetNextTextElement Method

Gets the first text element in a specified string.

Syntax

public static string GetNextTextElement (string str)

Parameters

str
The string from which to get the text element.

Returns

A string containing the first text element in the specified string.

Remarks

The .NET Framework defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The tp://go.microsoft.com/fwlink/?linkid=37123 defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high surrogate and the second is a low surrogate. The tp://go.microsoft.com/fwlink/?linkid=37123 defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character.

This method only returns the first text element. To iterate through the text elements of the string, the application should use the System.Globalization.TextElementEnumerator object generated by the StringInfo.GetTextElementEnumerator(string) method.

Requirements

Namespace: System.Globalization
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0