Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

TextElementEnumerator.Current Property

Gets the current text element in the string.

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

public Object Current { get; }
/** @property */
public final Object get_Current ()

public final function get Current () : Object

Property Value

An object containing the current text element in the string.

Exception typeCondition

InvalidOperationException

The enumerator is positioned before the first text element of the string or after the last text element.

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.

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

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

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

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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft