This documentation is archived and is not being maintained.

TextElementEnumerator.GetTextElement Method

Gets the current text element in the string.

[Visual Basic]
Public Function GetTextElement() As String
[C#]
public string GetTextElement();
[C++]
public: String* GetTextElement();
[JScript]
public function GetTextElement() : String;

Return Value

A new string containing the current text element in the string being read.

Exceptions

Exception Type Condition
InvalidOperationException The enumerator is positioned before the first text element of the string or after the last text element.

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 returns the same text element as the Current property.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

TextElementEnumerator Class | TextElementEnumerator Members | System.Globalization Namespace | Current | ElementIndex

Show: