StringInfo.GetNextTextElement Method (String, Int32)
Gets the text element at the specified index of the specified string.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Shared Function GetNextTextElement ( _ str As String, _ index As Integer _ ) As String
- Type: System.String
The string from which to get the text element.
- Type: System.Int32
The zero-based index at which the text element starts.
Return ValueType: System.String
A string containing the text element at the specified index of the specified string.
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 of the substring that starts at the specified index. To iterate through the text elements of the string, the application should use the TextElementEnumerator generated by the GetTextElementEnumerator method.
Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.