SMath Studio Core documentation
PagesEnumerator<T> Class
Enumerator to iterate through available Document Pages.
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 sealed class PagesEnumerator<T> : IEnumerator<DocumentPage>,
IDisposable, IEnumerator
where T : IDocumentObject
VB
Public NotInheritable Class PagesEnumerator(Of T As IDocumentObject)
Implements IEnumerator(Of DocumentPage), IDisposable,
IEnumeratorC++
generic<typename T>
where T : IDocumentObject
public ref class PagesEnumerator sealed : IEnumerator<DocumentPage^>,
IDisposable, IEnumeratorF#
[<SealedAttribute>]
type PagesEnumerator<'T when 'T : IDocumentObject> =
class
interface IEnumerator<DocumentPage>
interface IDisposable
interface IEnumerator
end- Inheritance
- Object PagesEnumerator<T>
- Implements
- IEnumerator<DocumentPage>, IEnumerator, IDisposable
Type Parameters
- T
Constructors
| PagesEnumerator<T>(IDocument<T>) | Constructor of the object. |
| PagesEnumerator<T>(IDocument<T>, IGraphics) | Constructor of the object. |
| PagesEnumerator<T>(IDocument<T>, RectangleF) | Constructor of the object. |
| PagesEnumerator<T>(IDocumentLayout<T>, PageModel, PagesOptions, MetaContext) | Constructor of the object. |
| PagesEnumerator<T>(IDocumentLayout<T>, PageModel, PagesOptions, MetaContext, IGraphics) | Constructor of the object. |
Properties
| Current | Gets the current object. |
| CurrentIndex | Gets the current page index. |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetDocumentPage(Int32, Int32) | Looks up for the Document Page where cursor Y coordinate can be displayed. |
| GetDocumentPage(T, Point) | Looks up for the Document Page where Object is displayed taking in account cursor location into the Object. |
| GetDocumentPage(T, Int32) | Looks up for the Document Page where Object is displayed. |
| GetDocumentPageStrict | Looks up for the Document Page where Object is displayed taking in account cursor location into the Object. |
| GetEnumerator | Returns enumerator. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MoveNext() | Advances the enumerator to the next available element of the collection. |
| MoveNext(IGraphics) | Advances the enumerator to the next available element of the collection. |
| Reset | Drops internal counter to initial value. Filtering settings remain untouched. |
| SetCurrentContext | Updates context based on current state of the enumertor. |
| SetCurrentContextRaw | Updates context based on current state of the enumertor. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetPageObjects | Returns Objects located on current Document Page. |
Explicit Interface Implementations
| IDisposable.Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| IEnumerator.Current | Gets the element in the collection at the current position of the enumerator. |
| IEnumerator.MoveNext | Advances the enumerator to the next element of the collection. |
| IEnumerator.Reset | Sets the enumerator to its initial position, which is before the first element in the collection. |
| IEnumerator<DocumentPage>.Current | Gets the element in the collection at the current position of the enumerator. |