mscorlib(4.0.0.0) API with additions
System.CharEnumerator Class Reference

Supports iterating over a T:System.String object and reading its individual characters. This class cannot be inherited. More...

Inheritance diagram for System.CharEnumerator:
[legend]
Collaboration diagram for System.CharEnumerator:
[legend]

Public Member Functions

object Clone ()
 Creates a copy of the current T:System.CharEnumerator object. More...
 
bool MoveNext ()
 Increments the internal index of the current T:System.CharEnumerator object to the next character of the enumerated string. More...
 
void Dispose ()
 Releases all resources used by the current instance of the T:System.CharEnumerator class. More...
 
void Reset ()
 Initializes the index to a position logically before the first character of the enumerated string. More...
 
- Public Member Functions inherited from System.Collections.IEnumerator< char >
bool MoveNext ()
 Advances the enumerator to the next element of the collection. More...
 
void Reset ()
 Sets the enumerator to its initial position, which is before the first element in the collection. More...
 

Properties

char Current [get]
 Gets the currently referenced character in the string enumerated by this T:System.CharEnumerator object. More...
 
- Properties inherited from System.Collections.IEnumerator
object Current [get]
 Gets the element in the collection at the current position of the enumerator. More...
 
- Properties inherited from System.Collections.IEnumerator< char >
object Current [get]
 Gets the element in the collection at the current position of the enumerator. More...
 

Detailed Description

Supports iterating over a T:System.String object and reading its individual characters. This class cannot be inherited.

Definition at line 10 of file CharEnumerator.cs.

Member Function Documentation

◆ Clone()

object System.CharEnumerator.Clone ( )

Creates a copy of the current T:System.CharEnumerator object.

Returns
An T:System.Object that is a copy of the current T:System.CharEnumerator object.

Implements System.ICloneable.

Definition at line 64 of file CharEnumerator.cs.

◆ Dispose()

void System.CharEnumerator.Dispose ( )

Releases all resources used by the current instance of the T:System.CharEnumerator class.

Implements System.IDisposable.

Definition at line 85 of file CharEnumerator.cs.

◆ MoveNext()

bool System.CharEnumerator.MoveNext ( )

Increments the internal index of the current T:System.CharEnumerator object to the next character of the enumerated string.

Returns
true if the index is successfully incremented and within the enumerated string; otherwise, false.

Implements System.Collections.IEnumerator.

Definition at line 72 of file CharEnumerator.cs.

◆ Reset()

void System.CharEnumerator.Reset ( )

Initializes the index to a position logically before the first character of the enumerated string.

Implements System.Collections.IEnumerator.

Definition at line 95 of file CharEnumerator.cs.

Property Documentation

◆ Current

char System.CharEnumerator.Current
get

Gets the currently referenced character in the string enumerated by this T:System.CharEnumerator object.

Returns
The Unicode character currently referenced by this T:System.CharEnumerator object.
Exceptions
T:System.InvalidOperationExceptionThe index is invalid; that is, it is before the first or after the last character of the enumerated string.

Definition at line 41 of file CharEnumerator.cs.


The documentation for this class was generated from the following file: