SMath Studio Core documentation
Objects
Represents a class which enumerates document elements.
Definition
Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0
C#
public abstract class ObjectsEnumerator<T> : IObjectsEnumeratorInternal<T>,
IEnumerator<T>, IDisposable, IEnumerator
where T : IDocumentObject
VB
Public MustInherit Class ObjectsEnumerator(Of T As IDocumentObject)
Implements IObjectsEnumeratorInternal(Of T), IEnumerator(Of T),
IDisposable, IEnumeratorC++
generic<typename T>
where T : IDocumentObject
public ref class ObjectsEnumerator abstract : IObjectsEnumeratorInternal<T>,
IEnumerator<T>, IDisposable, IEnumeratorF#
[<AbstractClassAttribute>]
type ObjectsEnumerator<'T when 'T : IDocumentObject> =
class
interface IObjectsEnumeratorInternal<'T>
interface IEnumerator<'T>
interface IDisposable
interface IEnumerator
end- Inheritance
- Object ObjectsEnumeratorT
- Derived
- Implements
- IObjectsEnumeratorInternalT, IEnumeratorT, IEnumerator, IDisposable
Type Parameters
- T
- Document element of IDocumentObject type.
Constructors
| ObjectsEnumeratorT(ListT, ContentPlacement) | Constructor of the class which takes list of document elements objects and their placement placement as an input. |
| ObjectsEnumeratorT(ObjectsEnumeratorT, Int32) | Constructor of the class which takes list of document elements and their placement from another instance of the ObjectsEnumeratorT. |
Properties
| AbsoluteLocation | Absolute location of the Object on the Document depending on the start Object. |
| CollapsedHeight | Gets an invisible distance hidden by collapsed Area Objects above the current Object. |
| Current | Gets the current Object. |
| CurrentIndex | Gets the current Object index. |
| Depth | Gets depth of the Object inside nested Areas. |
| Evaluable | Gets evaluation status of the Object. |
| FilterAllAfter | Gets or sets an index of the last Object to retrieve. |
| FilterAllBefore | Gets or sets an index of the first Object to retrieve. |
| FilterDeactivated | Defines if the enumerator should hide all deactivated (not added to the Document) Objects. |
| 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). |
| FilterNonEvaluable | Gets or sets a value that determines if Enumerator will filter out not evaluable Objects. |
| FilterNonSelected | Gets or sets a value that determines if Enumerator will filter out not selected Objects or not. |
| LastIndex | Gets the last Object index. It doesn't check availability of the Object. |
| Placement | Placement of the content elements. |
| Protected | Gets protection status of the Object (Object is protected if it is included to the locked Area Object). |
| Selected | Gets selection status of the Object. |
| Visible | Gets visibility of the current Object on the Document (visible means that Object is not hidden by collapsed Area Objects). |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetEnumerator | Returns reference to itself in order to support the foreach loop. See The foreach statement for details. |
| 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. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MakeCurrent | Makes the given document element a current of the ObjectsEnumeratorT instance. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MoveNext | Advances the enumerator to the next available element of the collection. |
| Reset | Resets the internal counter values to the initial ones. At the same time, the filter settings remain with the set values. |
| RestartState | Restarts current enumerator instance state from scratch. |
| SaveState | Saves the current enumerator instance state. |
| SetFakeCollapsedArea | Sets virtual vertical delta to use similar to the collapsed Area space. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields
| filterProtected | Defines if the enumerator should hide all Objects protected by the locked collapsed Area Objects. |
| objects | Initial list of Objects to enumerate. |
Explicit Interface Implementations
| IDisposableDispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| IEnumeratorCurrent | Gets the element in the collection at the current position of the enumerator. |
| IEnumeratorTCurrent | Gets the element in the collection at the current position of the enumerator. |
| IObjectsEnumeratorInternalTFilterProtected | Specifies whether the enumerator should hide all Objects protected by the locked collapsed Area Objects. |
| IObjectsEnumeratorInternalTObjects | Underlying list of Objects being enumerated. |