.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Box

DocumentLayout Members

Provides access to the Layout API.

Properties

Name Description
IsDocumentFormattingCompleted Indicates whether the document layout is ready and up-to-date.

Methods

Name Description
BeginUpdateDocument(RangedLayoutElement) Starts modifying the document obtained via a layout element.
Dispose() Disposes of the DocumentLayout object.
EndUpdateDocument(SubDocument) Finalizes modifications of the document obtained via the layout element.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetElement(DocumentPosition, LayoutType) Gets the layout element of the specified type which relates to the specified position in the document model.
GetElement<T>(DocumentPosition) Returns the layout element of the type designated by the specified generic type parameter which relates to the specified position in the document model.
GetFormattedPageCount() Obtains a number of pages for which layout has been already calculated.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetPage(Int32) Gets the page of the document layout by the specified index.
GetPageAsync(Int32, Action<LayoutPage>) Calculates page layout asynchronously for the specified page.
GetPageAsync(Int32, Action<LayoutPage>, CancellationToken) Calculates the page layout asynchronously for the specified page and allows task cancellation through the use of a cancellation token.
GetPageCount() Get a number of pages in the document.
GetPageIndex(LayoutElement) Obtains the index of the page containing the specified layout element.
GetText(LayoutElement) static Gets the plain text contained in the range to which the layout element relates.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Split(PlainTextBox) Splits the PlainTextBox object into CharacterBox elements contained in the CharacterBoxCollection object instance.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
DocumentFormatted Fires after the document layout is calculated.
DocumentLayoutInvalidated Fires after any document modification which makes the current layout outdated.
PageFormatted Fires after a page layout is recalculated.
See Also