This documentation is archived and is not being maintained.

TextElementEnumerator::Current Property

Gets the current text element in the string.

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

public:
virtual property Object^ Current {
	Object^ get () sealed;
}

Property Value

Type: System::Object
An object containing the current text element in the string.

Implements

IEnumerator::Current

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

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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