Back to Devexpress

ViewPrintOptionsBase.AutoResetPrintDocument Property

windowsforms-devexpress-dot-xtragrid-dot-views-dot-base-dot-viewprintoptionsbase.md

latest4.4 KB
Original Source

ViewPrintOptionsBase.AutoResetPrintDocument Property

Gets or sets whether the grid automatically clears a generated print/export document and then generates this document each time the grid is printed/exported. In server mode, this option is not in effect.

Namespace : DevExpress.XtraGrid.Views.Base

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(true)]
[XtraSerializableProperty]
public virtual bool AutoResetPrintDocument { get; set; }
vb
<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property AutoResetPrintDocument As Boolean

Property Value

TypeDefaultDescription
Booleantrue

true if a print/export document is automatically cleared and regenerated before it is sent to the output; otherwise, false.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to AutoResetPrintDocument
BaseView

.OptionsPrint .AutoResetPrintDocument

|

Remarks

If the AutoResetPrintDocument option is set to true (default), the print/export engine regenerates a resulting document each time the grid is printed/exported. If the View displays a large amount of data, the print/export document generation may take a lot of time.

You can set the AutoResetPrintDocument option to false to prevent a print/export document from being regenerated each time the grid is printed/exported. Disabling this option makes sense when you print and/or export the same data two or more times in succession.

If no print/export document currently exists, the grid automatically generates the document when you print/export the control. You can call BaseView.CreateDocument to manually generate the print/export document beforehand. The BaseView.ClearDocument method allows you to clear (delete) the generated print/export document.

Note that if the AutoResetPrintDocument property is set to false , changes to the grid’s layout (changing filtering, sorting and grouping settings, modifying cell values, etc.) are not reflected in the already-generated print/export document. You need to forcibly regenerate the print/export document (with BaseView.CreateDocument or BaseView.ClearDocument).

Note

When handling large data sources in Server and Instant Feedback Modes, a print/export document is not regenerated each time you print/export the grid; the AutoResetPrintDocument property is ignored. To apply the grid’s layout changes after a print/export document is generated, you need to regenerate the document with the BaseView.CreateDocument method before you print/export the grid.

See Also

CreateDocument()

Print()

Printing Overview

Export Overview

ViewPrintOptionsBase Class

ViewPrintOptionsBase Members

DevExpress.XtraGrid.Views.Base Namespace