RegionsEnumerator Class

Enumerator to iterate through available Worksheet Regions.

Definition

Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0

C#
public sealed class RegionsEnumerator : ObjectsEnumerator<RegionBase>, 
	IRegionsEnumeratorInternal, IObjectsEnumeratorInternal<RegionBase>, IEnumerator<RegionBase>, 
	IDisposable, IEnumerator

VB
Public NotInheritable Class RegionsEnumerator
	Inherits ObjectsEnumerator(Of RegionBase)
	Implements IRegionsEnumeratorInternal, IObjectsEnumeratorInternal(Of RegionBase), 
	IEnumerator(Of RegionBase), IDisposable, IEnumerator

C++
public ref class RegionsEnumerator sealed : public ObjectsEnumerator<RegionBase^>, 
	IRegionsEnumeratorInternal, IObjectsEnumeratorInternal<RegionBase^>, IEnumerator<RegionBase^>, 
	IDisposable, IEnumerator

F#
[<SealedAttribute>]
type RegionsEnumerator = 
    class
        inherit ObjectsEnumerator<RegionBase>
        interface IRegionsEnumeratorInternal
        interface IObjectsEnumeratorInternal<RegionBase>
        interface IEnumerator<RegionBase>
        interface IDisposable
        interface IEnumerator
    end

Inheritance: Object ObjectsEnumerator<RegionBase> RegionsEnumerator

Implements: IObjectsEnumeratorInternal<RegionBase>, IRegionsEnumeratorInternal, IEnumerator<RegionBase>, IEnumerator, IDisposable

Constructors

RegionsEnumerator

Constructor of the object.

Properties

AbsoluteDefinitions	List of Definition objects to be used during enumeration.
AbsoluteLocation	Absolute location of the Object on the Document depending on the start Object. (Inherited from ObjectsEnumerator<T>)
CollapsedHeight	Gets an invisible distance hidden by collapsed Area Objects above the current Object. (Inherited from ObjectsEnumerator<T>)
Current	Gets the current Object. (Inherited from ObjectsEnumerator<T>)
CurrentIndex	Gets the current Object index. (Inherited from ObjectsEnumerator<T>)
Depth	Gets depth of the Object inside nested Areas. (Inherited from ObjectsEnumerator<T>)
Evaluable	Gets evaluation status of the Object. (Inherited from ObjectsEnumerator<T>)
FilterAllAfter	Gets or sets an index of the last Object to retrieve. (Inherited from ObjectsEnumerator<T>)
FilterAllBefore	Gets or sets an index of the first Object to retrieve. (Inherited from ObjectsEnumerator<T>)
FilterDeactivated	Defines if the enumerator should hide all deactivated (not added to the Document) Objects. (Inherited from ObjectsEnumerator<T>)
FilterInvisible	Gets or sets a value that determines if Enumerator will filter out Invisible Objects or not (invisible means that Object is hidden by collapsed Area Objects). (Inherited from ObjectsEnumerator<T>)
FilterNonEvaluable	Gets or sets a value that determines if Enumerator will filter out not evaluable Objects. (Inherited from ObjectsEnumerator<T>)
FilterNonSelected	Gets or sets a value that determines if Enumerator will filter out not selected Objects or not. (Inherited from ObjectsEnumerator<T>)
LastIndex	Gets the last Object index. It doesn't check availability of the Object. (Inherited from ObjectsEnumerator<T>)
Placement	Placement of the content elements. (Inherited from ObjectsEnumerator<T>)
Protected	Gets protection status of the Object (Object is protected if it is included to the locked Area Object). (Inherited from ObjectsEnumerator<T>)
Selected	Gets selection status of the Object. (Inherited from ObjectsEnumerator<T>)
Visible	Gets visibility of the current Object on the Document (visible means that Object is not hidden by collapsed Area Objects). (Inherited from ObjectsEnumerator<T>)

Methods

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator	Returns reference to itself in order to support the foreach loop. See The foreach statement for details. (Inherited from ObjectsEnumerator<T>)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetSubEnumerator	Creates a separate instance of the ObjectsEnumerator<T> with a given index of the last document element. (Overrides ObjectsEnumerator<T>.GetSubEnumerator(Int32))
GetType	Gets the Type of the current instance. (Inherited from Object)
MoveNext	Advances the enumerator to the next available element of the collection. (Inherited from ObjectsEnumerator<T>)
Reset	Resets the internal counter values to the initial ones. At the same time, the filter settings remain with the set values. (Overrides ObjectsEnumerator<T>.Reset())
RestartState	Restarts current enumerator instance state from scratch. (Inherited from ObjectsEnumerator<T>)
SaveState	Saves the current enumerator instance state. (Inherited from ObjectsEnumerator<T>)
SetFakeCollapsedArea	Sets virtual vertical delta to use similar to the collapsed Area space. (Inherited from ObjectsEnumerator<T>)
ToString	Returns a string that represents the current object. (Inherited from Object)

Events

ProgressChanged

Occurs when the enumerator progress changed.

Explicit Interface Implementations

IRegionsEnumeratorInternal.CreateStore

Creates a Store instance for evaluation.