Export (0) Print
Expand All

StringInfo.GetNextTextElement Method (String)

Gets the first text element in a specified string.

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

static member GetNextTextElement : 
        str:string -> string 

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.

ExceptionCondition
ArgumentNullException

str is a null reference (Nothing in Visual Basic).

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft