Export (0) Print
Expand All

StringInfo.GetNextTextElement Method (String, Int32)

Gets the text element at the specified index of the specified string.

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

'Declaration
Public Shared Function GetNextTextElement ( _
	str As String, _
	index As Integer _
) As String
'Usage
Dim str As String
Dim index As Integer
Dim returnValue As String

returnValue = StringInfo.GetNextTextElement(str, index)
public static String GetNextTextElement (
	String str, 
	int index
)
public static function GetNextTextElement (
	str : String, 
	index : int
) : String

Parameters

str

The string from which to get the text element.

index

The zero-based index at which the text element starts.

Return Value

A string containing the text element at the specified index of the specified string.

Exception typeCondition

ArgumentNullException

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

ArgumentOutOfRangeException

index is outside the range of valid indexes for str.

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 of the substring that starts at the specified index. To iterate through the text elements of the string, use the TextElementEnumerator generated by the GetTextElementEnumerator method.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft