DocumentLayout.GetPageAsync(Int32, Action<LayoutPage>, CancellationToken) Method

Calculates the page layout asynchronously for the specified page and allows task cancellation through the use of a cancellation token.

Namespace: DevExpress.XtraRichEdit.API.Layout

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

public Task GetPageAsync(
    int pageIndex,
    Action<LayoutPage> callback,
    CancellationToken cancellationToken
)

VB.NET

Public Function GetPageAsync(
    pageIndex As Integer,
    callback As Action(Of LayoutPage),
    cancellationToken As CancellationToken
) As Task

Parameters

Name	Type	Description
pageIndex	Int32	An integer that is the index of the page for which to calculate layout.
callback	Action<LayoutPage>	A Action that is the action to run when page formatting completes.
cancellationToken	CancellationToken	A cancellation token that should be used to cancel formatting.

Returns

Type	Description
Task	A Task that is an asynchronous operation being performed.