LinkBase.CreateDocument(Boolean) Method

Creates a document from the link, so it can be displayed or printed. Optionally, it can generate pages in the background.

Namespace: DevExpress.Xpf.Printing

Assembly: DevExpress.Xpf.Printing.v14.2.dll

Declaration

C#

public void CreateDocument(
    bool buildPagesInBackground
)

VB.NET

Public Sub CreateDocument(
    buildPagesInBackground As Boolean
)

Parameters

Name	Type	Description
buildPagesInBackground	Boolean	true to generate pages in the background; otherwise, false.

Remarks

Use the CreateDocument method to generate a document for the current link.

If the buildPagesInBackground parameter is set to true, the first document page is immediately created and displayed in it. The creation of all other pages is performed silently when the application is idle, and these pages are progressively rendered in the Print Preview. This behavior allows end-users to start working with the document before all its pages are ready.

NOTE

When this link is exported to a specific format (e.g. the LinkBase.ExportToHtml or any other export method is called for this link), the CreateDocument method is internally called with the false parameter, prior to the start of the exporting procedure.

Implements

CreateDocument(Boolean)