Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Public Member Functions | Properties | List of all members
SolidFramework.Converters.Plumbing.IConversionResultsCollection.IConversionResultsCollectionEnumerator Class Reference
Inheritance diagram for SolidFramework.Converters.Plumbing.IConversionResultsCollection.IConversionResultsCollectionEnumerator:

Public Member Functions

 IConversionResultsCollectionEnumerator (IConversionResultsCollection collection)
 Creates a new instance of the IConversionResultsCollectionEnumerator.
 
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.
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Properties

SolidFramework.Converters.Plumbing.IConversionResult Current [get]
 Gets the SolidFramework.Converters.Plumbing.IConversionResult element in the collection at the current position of the enumerator. More...
 

Detailed Description

Note that the IEnumerator documentation requires an InvalidOperationException to be thrown whenever the collection is modified. This has been done for changes in the size of the collection but not when one of the elements of the collection is modified as it is a bit tricky to detect unmanaged code that modifies the collection under our feet.

Member Function Documentation

◆ Dispose()

void SolidFramework.Converters.Plumbing.IConversionResultsCollection.IConversionResultsCollectionEnumerator.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This method has to be implemented because IEnumerator is inherited from IDisposable.

◆ MoveNext()

bool SolidFramework.Converters.Plumbing.IConversionResultsCollection.IConversionResultsCollectionEnumerator.MoveNext ( )

Advances the enumerator to the next element of the collection.

Returns
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

After an enumerator is created or after the Reset method is called, an enumerator is positioned before the first element of the collection, and the first call to the MoveNext method moves the enumerator over the first element of the collection. If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. When the enumerator is at this position, subsequent calls to MoveNext also return false until Reset is called.

Property Documentation

◆ Current

SolidFramework.Converters.Plumbing.IConversionResult SolidFramework.Converters.Plumbing.IConversionResultsCollection.IConversionResultsCollectionEnumerator.Current
get

Gets the SolidFramework.Converters.Plumbing.IConversionResult element in the collection at the current position of the enumerator.

Current returns the same object until MoveNext is called. MoveNext sets Current to the next element. If a call to MoveNext returned false, which indicates the end of the collection, then Current is undefined.