Aspose::Words::Layout::LayoutEnumerator class
Contents
[
Hide
]LayoutEnumerator class
Enumerates page layout entities of a document. You can use this class to walk over the page layout model. Available properties are type, geometry, text and page index where entity is rendered, as well as overall structure and relationships. Use combination of GetEntity() and Current move to the entity which corresponds to a document node. To learn more, visit the Converting to Fixed-page Format documentation article.
class LayoutEnumerator : public System::Object,
public System::Details::EnumeratorBasedIterator<System::SharedPtr<System::Object>>,
private System::Details::IteratorPointerUpdater<System::SharedPtr<System::Object>, false>
Methods
| Method | Description |
|---|---|
| CloneIterator() const override | |
| get_Current() const | Gets or sets current position in the page layout model. This property returns an opaque object which corresponds to the current layout entity. |
| get_Document() const | Gets document this instance enumerates. |
| get_Kind() | Gets the kind of the current entity. This can be an empty string but never null. |
| get_PageIndex() | Gets the 1-based index of a page which contains the current entity. |
| get_Rectangle() | Returns the bounding rectangle of the current entity relative to the page top left corner (in points). |
| get_Text() | Gets text of the current span entity. Throws for other entity types. |
| get_Type() | Gets the type of the current entity. |
| GetType() const override | |
| idx_get(const System::String&) | Gets a named property of the entity. |
| IncrementIterator() override | |
| InitializeIterator() override | |
| Is(const System::TypeInfo&) const override | |
| LayoutEnumerator(const System::SharedPtr<Aspose::Words::Document>&) | Initializes new instance of this class. |
| MoveFirstChild() | Moves to the first child entity. |
| MoveLastChild() | Moves to the last child entity. |
| MoveNext() | Moves to the next sibling entity in visual order. When iterating lines of a paragraph broken across pages this method will not move to the next page but rather move to the next entity on the same page. |
| MoveNextLogical() | Moves to the next sibling entity in a logical order. When iterating lines of a paragraph broken across pages this method will move to the next line even if it resides on another page. |
| MoveParent() | Moves to the parent entity. |
| MoveParent(Aspose::Words::Layout::LayoutEntityType) | Moves to the parent entity of the specified type. |
| MovePrevious() | Moves to the previous sibling entity. |
| MovePreviousLogical() | Moves to the previous sibling entity in a logical order. When iterating lines of a paragraph broken across pages this method will move to the previous line even if it resides on another page. |
| Reset() | Moves the enumerator to the first page of the document. |
| set_Current(const System::SharedPtr<System::Object>&) | Setter for Aspose::Words::Layout::LayoutEnumerator::get_Current. |
| static Type() |
See Also
- Namespace Aspose::Words::Layout
- Library Aspose.Words for C++