Aspose::Words::Layout namespace

The Aspose.Words.Layout namespace provides classes that allow to access information such as on what page and where on a page particular document elements are positioned, when the document is formatted into pages.

Classes

ClassDescription
LayoutCollectorThis class allows to compute page numbers of document nodes. To learn more, visit the Converting to Fixed-page Format documentation article.
LayoutEnumeratorEnumerates 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.
LayoutOptionsHolds the options that allow controlling the document layout process. To learn more, visit the Converting to Fixed-page Format documentation article.
PageLayoutCallbackArgsAn argument passed into Notify()To learn more, visit the Converting to Fixed-page Format documentation article.
RevisionOptionsAllows to control how document revisions are handled during layout process. To learn more, visit the Converting to Fixed-page Format documentation article.

Interfaces

InterfaceDescription
IPageLayoutCallbackImplement this interface if you want to have your own custom method called during build and rendering of page layout model.

Enums

EnumDescription
CommentDisplayModeSpecifies the rendering mode for document comments.
ContinuousSectionRestartRepresents different behaviors when computing page numbers in a continuous section that restarts page numbering.
LayoutEntityTypeTypes of the layout entities.
PageLayoutEventA code of event raised during page layout model build and rendering. Page layout model is built in two steps. First, “conversion step”, this is when page layout pulls document content and creates object graph. Second, “reflow step”, this is when structures are split, merged and arranged into pages. Depending of the operation which triggered build, page layout model may or may not be further rendered into fixed page format. For example, computing number of pages in the document or updating fields does not require rendering, whereas export to Pdf does.
RevisionColorAllows to specify color of document revisions.
RevisionTextEffectAllows to specify decoration effect for revisions of document text.
ShowInBalloonsSpecifies which revisions are rendered in balloons.