System.Globalization.TextElementEnumerator.Current Property

Gets the current text element in the string.


public object Current { get; }


Documentation for this section has not yet been entered.


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 tp:// 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.

After an enumerator is created or after a TextElementEnumerator.Reset is called, TextElementEnumerator.MoveNext must be called to advance the enumerator to the first text element of the string before reading the value of TextElementEnumerator.Current. Otherwise, TextElementEnumerator.Current is undefined.

TextElementEnumerator.Current also throws an exception if the last call to TextElementEnumerator.MoveNext returned false, which indicates the end of the string.

TextElementEnumerator.Current does not move the position of the enumerator, and consecutive calls to TextElementEnumerator.Current return the same object until either TextElementEnumerator.MoveNext or TextElementEnumerator.Reset is called.


Namespace: System.Globalization
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0,,