Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

StringInfo.GetNextTextElement Method (String)

 

Gets the first text element in a specified string.

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

public static string GetNextTextElement(
	string str
)

Parameters

str
Type: System.String

The string from which to get the text element.

Return Value

Type: System.String

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

Exception Condition
ArgumentNullException

str is null.

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 Unicode Standard 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 Unicode Standard 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 TextElementEnumerator object generated by the GetTextElementEnumerator method.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft