StringInfo.GetNextTextElement Method

Definition

Namespace:

System.Globalization

Assembly:

System.Runtime.dll

Gets the first text element in a specified string.

Overloads

GetNextTextElement(String)	Gets the first text element in a specified string.
GetNextTextElement(String, Int32)	Gets the text element at the specified index of the specified string.

GetNextTextElement(String)

Source:

StringInfo.cs

Gets the first text element in a specified string.

public:
 static System::String ^ GetNextTextElement(System::String ^ str);

public static string GetNextTextElement (string str);

static member GetNextTextElement : string -> string

Public Shared Function GetNextTextElement (str As String) As String

Parameters

str

String

The string from which to get the text element.

Returns

String

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

Exceptions

ArgumentNullException

str is null.

Remarks

.NET 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.

See also

• GetTextElementEnumerator(String)
• ParseCombiningCharacters(String)

GetNextTextElement(String, Int32)

Source:

StringInfo.cs

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

public:
 static System::String ^ GetNextTextElement(System::String ^ str, int index);

public static string GetNextTextElement (string str, int index);

static member GetNextTextElement : string * int -> string

Public Shared Function GetNextTextElement (str As String, index As Integer) As String

Parameters

str

String

The string from which to get the text element.

index

Int32

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

Returns

String

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

Exceptions

ArgumentNullException

str is null.

ArgumentOutOfRangeException

index is outside the range of valid indexes for str.

Remarks

.NET 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.

See also

• GetTextElementEnumerator(String)
• ParseCombiningCharacters(String)