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.

StringInfo.GetTextElementEnumerator Method (String)

Returns an enumerator that iterates through the text elements of the entire string.

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

'Declaration
Public Shared Function GetTextElementEnumerator ( _
	str As String _
) As TextElementEnumerator
'Usage
Dim str As String
Dim returnValue As TextElementEnumerator

returnValue = StringInfo.GetTextElementEnumerator(str)
public static TextElementEnumerator GetTextElementEnumerator (
	String str
)
public static function GetTextElementEnumerator (
	str : String
) : TextElementEnumerator

Parameters

str

The string to iterate through.

Return Value

A TextElementEnumerator for the entire string.

Exception typeCondition

ArgumentNullException

str is a null reference (Nothing in Visual Basic).

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.

Text element enumerators are intended to be used only to read data in the string. Enumerators cannot be used to modify the underlying string.

The enumerator does not have exclusive access to the string.

When an enumerator is created, it takes a snapshot of the current state of the string. If changes are made to the string, such as adding, modifying, or deleting text elements, the snapshot gets out of sync and the enumerator throws an InvalidOperationException. Two enumerators created from the same string at the same time can have different snapshots of the string.

The enumerator is in an invalid state if it is positioned before the first text element in the string or after the last text element in the string. Whenever the enumerator is in an invalid state, calling Current throws an exception.

Initially, the enumerator is positioned before the first text element in the string. Reset also brings the enumerator back to this position. Therefore, 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.

Current returns the same object until either MoveNext or Reset is called.

After the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. Calling Current throws an exception if the last call to MoveNext returned false.

The following code example demonstrates calling the GetTextElementEnumerator method. This code example is part of a larger example provided for the StringInfo class.

No code example is currently available or this language may not be supported.

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:
© 2015 Microsoft