StringInfo.GetTextElementEnumerator Method (String, Int32)
Returns an enumerator that iterates through the text elements of the string, starting at the specified index.
Assemblies: System.Globalization (in System.Globalization.dll)
mscorlib (in mscorlib.dll)
public static TextElementEnumerator GetTextElementEnumerator( string str, int index )
- Type: System.String
The string to iterate through.
- Type: System.Int32
The zero-based index at which to start iterating.
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.
The text element enumerator is used only to read data in the string; it cannot modify the underlying string. The enumerator does not have exclusive access to 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. When 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 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.
.NET FrameworkSupported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
Portable Class LibrarySupported in: Portable Class Library
.NET for Windows Store appsSupported in: Windows 8
Supported in: Windows Phone 8.1
Supported in: Windows Phone Silverlight 8.1
Supported in: Windows Phone Silverlight 8
Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)