XtraSchedulerReport.CreateDocument(Boolean) Method
Creates a document so that it can be displayed or printed. Optionally, the document pages can be generated progressively and accessed as soon as they are created. Document creation is always synchronous and does not occur in a background thread.
Namespace: DevExpress.XtraScheduler.Reporting
Assembly: DevExpress.XtraScheduler.v18.2.Reporting.dll
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| buildForInstantPreview | Boolean | true to enable accessing document pages progressively as they are created; otherwise false. |
Remarks
This method calls the XtraReport.CreateDocument method of the base class.
Note
If the buildForInstantPreview parameter is set to true, document pages can be accessed progressively as they are created. In Print Preview, this enables you to start viewing the document as soon as its first page is ready. Remaining pages are progressively rendered in Print Preview.
Regardless of this parameter setting, a document will not be produced in a background thread. Document creation is not asynchronous, as parts of a document are rendered each time the Idle event is raised (in the WPF environment, a document is created using ticks from the DispatcherTimer class).
When this option is enabled, document creation can be interrupted by calling the XtraReport.StopPageBuilding method.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateDocument(Boolean) method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.