Share via

  • Article

StringInfo.GetNextTextElement Method (String)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets the first text element in a specified string.

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

Syntax

'Declaration
Public Shared Function GetNextTextElement ( _
    str As String _
) As String

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.

Exceptions

Exception Condition
ArgumentNullException

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

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 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. For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org..

This method only returns the first text element. To iterate through the text elements of the string, the application should use the TextElementEnumerator generated by the GetTextElementEnumerator method.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.