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 ObjectsEnumeratorRegionBase RegionsEnumerator

Implements: IObjectsEnumeratorInternalRegionBase, IRegionsEnumeratorInternal, IEnumeratorRegionBase, 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 ObjectsEnumeratorT)
CollapsedHeight	Gets an invisible distance hidden by collapsed Area Objects above the current Object. (Inherited from ObjectsEnumeratorT)
Current	Gets the current Object. (Inherited from ObjectsEnumeratorT)
CurrentIndex	Gets the current Object index. (Inherited from ObjectsEnumeratorT)
Depth	Gets depth of the Object inside nested Areas. (Inherited from ObjectsEnumeratorT)
Evaluable	Gets evaluation status of the Object. (Inherited from ObjectsEnumeratorT)
FilterAllAfter	Gets or sets an index of the last Object to retrieve. (Inherited from ObjectsEnumeratorT)
FilterAllBefore	Gets or sets an index of the first Object to retrieve. (Inherited from ObjectsEnumeratorT)
FilterDeactivated	Defines if the enumerator should hide all deactivated (not added to the Document) Objects. (Inherited from ObjectsEnumeratorT)
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 ObjectsEnumeratorT)
FilterNonEvaluable	Gets or sets a value that determines if Enumerator will filter out not evaluable Objects. (Inherited from ObjectsEnumeratorT)
FilterNonSelected	Gets or sets a value that determines if Enumerator will filter out not selected Objects or not. (Inherited from ObjectsEnumeratorT)
LastIndex	Gets the last Object index. It doesn't check availability of the Object. (Inherited from ObjectsEnumeratorT)
Placement	Placement of the content elements. (Inherited from ObjectsEnumeratorT)
Protected	Gets protection status of the Object (Object is protected if it is included to the locked Area Object). (Inherited from ObjectsEnumeratorT)
Selected	Gets selection status of the Object. (Inherited from ObjectsEnumeratorT)
Visible	Gets visibility of the current Object on the Document (visible means that Object is not hidden by collapsed Area Objects). (Inherited from ObjectsEnumeratorT)

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 ObjectsEnumeratorT)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetSubEnumerator	Creates a separate instance of the ObjectsEnumeratorT with a given index of the last document element. (Overrides ObjectsEnumeratorTGetSubEnumerator(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 ObjectsEnumeratorT)
Reset	Resets the internal counter values to the initial ones. At the same time, the filter settings remain with the set values. (Overrides ObjectsEnumeratorTReset)
RestartState	Restarts current enumerator instance state from scratch. (Inherited from ObjectsEnumeratorT)
SaveState	Saves the current enumerator instance state. (Inherited from ObjectsEnumeratorT)
SetFakeCollapsedArea	Sets virtual vertical delta to use similar to the collapsed Area space. (Inherited from ObjectsEnumeratorT)
ToString	Returns a string that represents the current object. (Inherited from Object)

Events

ProgressChanged

Occurs when the enumerator progress changed.

Explicit Interface Implementations

IRegionsEnumeratorInternalCreateStore

Creates a Store instance for evaluation.