[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Collapse]Reporting
 [Expand]Product Information
 [Expand]Get Started with DevExpress Reporting
 [Expand]Create Popular Reports
 [Expand]Detailed Guide to DevExpress Reporting
 [Expand]Visual Studio Report Designer
 [Expand]Create End-User Reporting Applications
 [Collapse]API Reference
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraPrinting.Caching
  [Expand]DevExpress.XtraReports
  [Expand]DevExpress.XtraReports.CodeCompletion
  [Expand]DevExpress.XtraReports.CodeCompletion.Storages
  [Expand]DevExpress.XtraReports.Configuration
  [Expand]DevExpress.XtraReports.Data
  [Expand]DevExpress.XtraReports.Design
  [Expand]DevExpress.XtraReports.Expressions
  [Expand]DevExpress.XtraReports.Extensions
  [Expand]DevExpress.XtraReports.FavoriteProperties
  [Expand]DevExpress.XtraReports.Localization
  [Expand]DevExpress.XtraReports.Native
  [Expand]DevExpress.XtraReports.ReportGallery
  [Expand]DevExpress.XtraReports.ReportGeneration
  [Expand]DevExpress.XtraReports.Security
  [Expand]DevExpress.XtraReports.Serialization
  [Expand]DevExpress.XtraReports.Service
  [Expand]DevExpress.XtraReports.Service.Extensions
  [Expand]DevExpress.XtraReports.Templates
  [Collapse]DevExpress.XtraReports.UI
   [Expand]Band Class
   [Expand]BandCollection Class
   [Expand]BandEventArgs Class
    BandEventHandler Delegate
   [Expand]BandFactory Class
    BandKind Enumeration
   [Expand]BandScripts Class
   [Expand]BestSizeEstimator Class
   [Expand]BindingEventArgs Class
    BindingEventHandler Delegate
   [Expand]BottomMarginBand Class
   [Expand]CalculatedField Class
   [Expand]CalculatedFieldCollection Class
   [Expand]CalculatedFieldScripts Class
   [Expand]ChangeEventArgs Class
    ChangeEventHandler Delegate
    ChartImageType Enumeration
   [Expand]CheckBoxGlyphOptions Class
   [Expand]CheckBoxGlyphs Class
   [Expand]CheckEditOptions Class
    ColumnDirection Enumeration
    DataBindingMode Enumeration
   [Expand]DataSourceRowEventArgs Class
    DataSourceRowEventHandler Delegate
   [Expand]DesignerOptions Class
    DesignWindowType Enumeration
   [Expand]DetailBand Class
   [Expand]DetailReportBand Class
   [Expand]DetailReportBandCollection Class
    DocumentExportMode Enumeration
   [Expand]DrawEventArgs Class
    DrawEventHandler Delegate
   [Expand]EditOptions Class
   [Expand]ExpressionBinding Class
   [Expand]ExpressionBindingCollection Class
    ExternalFileAccessSecurityLevel Enumeration
   [Expand]ExternalFileAccessSecurityLevelSettings Class
   [Expand]Formatting Class
   [Expand]FormattingRule Class
   [Expand]FormattingRuleCollection Class
   [Expand]FormattingRuleSheet Class
    GaugeImageType Enumeration
   [Expand]GetValueEventArgs Class
    GetValueEventHandler Delegate
   [Expand]GroupBand Class
   [Expand]GroupBandScripts Class
   [Expand]GroupField Class
   [Expand]GroupFieldCollection Class
   [Expand]GroupFooterBand Class
    GroupFooterUnion Enumeration
   [Expand]GroupHeaderBand Class
   [Expand]GroupHeaderBandScripts Class
   [Expand]GroupSortingSummaryGetResultEventArgs Class
    GroupSortingSummaryGetResultEventHandler Delegate
   [Expand]GroupSortingSummaryRowChangedEventArgs Class
    GroupSortingSummaryRowChangedEventHandler Delegate
    GroupUnion Enumeration
   [Expand]HierarchyPrintOptions Class
   [Expand]HtmlEventArgs Class
    HtmlEventHandler Delegate
   [Expand]ImageEditOptions Class
   [Expand]IReportDesignTool Interface
   [Expand]MarginBand Class
   [Expand]MultiColumn Class
    MultiColumnMode Enumeration
   [Expand]PageBand Class
    PageBreak Enumeration
   [Expand]PageFooterBand Class
   [Expand]PageHeaderBand Class
   [Expand]ParameterBinding Class
   [Expand]ParameterBindingCollection Class
   [Expand]PdfStreamingExporter Class
   [Expand]PreviewMouseEventArgs Class
    PreviewMouseEventHandler Delegate
   [Expand]PrintableComponentContainer Class
   [Expand]PrintOnPageEventArgs Class
    PrintOnPageEventHandler Delegate
    ProcessDuplicatesMode Enumeration
    ProcessDuplicatesTarget Enumeration
    ProcessHiddenCellMode Enumeration
    PromptBoolean Enumeration
   [Expand]ReportDesignTool Class
   [Expand]ReportFooterBand Class
   [Expand]ReportHeaderBand Class
   [Expand]ReportPrintOptions Class
    ReportUnit Enumeration
   [Expand]ReportUnitExtensions Class
    RestrictionLevel Enumeration
    RightToLeft Enumeration
    RightToLeftLayout Enumeration
   [Expand]SaveComponentsEventArgs Class
   [Expand]SerializableString Class
    SerializationFormat Enumeration
    SnappingMode Enumeration
   [Expand]SortingOptions Class
    SortingSummaryFunction Enumeration
    SparklineImageType Enumeration
   [Expand]StyleFlagsBase Class
   [Expand]StylePriority Class
   [Expand]StyleUsing Class
   [Expand]SubBand Class
   [Expand]SubBandCollection Class
   [Expand]SubreportBase Class
   [Expand]SubreportBaseScripts Class
    SummaryFunc Enumeration
   [Expand]SummaryGetResultEventArgs Class
    SummaryGetResultHandler Delegate
    SummaryRunning Enumeration
   [Expand]TextEditOptions Class
    TextFitMode Enumeration
   [Expand]TextFormatEventArgs Class
    TextFormatEventHandler Delegate
   [Expand]TopMarginBand Class
   [Expand]TruncatedControlScripts Class
   [Expand]ValueBinding Class
    ValueSuppressType Enumeration
   [Expand]VerticalBand Class
    VerticalBandLayout Enumeration
   [Expand]VerticalDetailBand Class
   [Expand]VerticalHeaderBand Class
   [Expand]VerticalTotalBand Class
   [Expand]WinControlContainer Class
    WinControlDrawMethod Enumeration
    WinControlImageType Enumeration
    WinControlPrintMode Enumeration
   [Expand]WindowControlOptions Class
   [Expand]XRAppearanceObject Class
   [Expand]XRBarCode Class
    XRBarCodeOrientation Enumeration
   [Expand]XRBinding Class
   [Expand]XRBindingCollection Class
   [Expand]XRCharacterComb Class
   [Expand]XRCharacterCombScripts Class
   [Expand]XRChart Class
   [Expand]XRChartScripts Class
   [Expand]XRCheckBox Class
    XRColumnSortOrder Enumeration
   [Collapse]XRControl Class
     XRControl Members
     XRControl Constructor
    [Expand]XRControl Properties
    [Collapse]XRControl Events
      AfterPrint Event
      BeforePrint Event
      Draw Event
      EvaluateBinding Event
      HtmlItemCreated Event
      LocationChanged Event
      ParentChanged Event
      PreviewClick Event
      PreviewDoubleClick Event
      PreviewMouseDown Event
      PreviewMouseMove Event
      PreviewMouseUp Event
      PrintOnPage Event
      SizeChanged Event
      TextChanged Event
    [Expand]XRControl Methods
   [Expand]XRControlCollection Class
   [Expand]XRControlCollectionBase Class
   [Expand]XRControlEvents Class
   [Expand]XRControlScripts Class
   [Expand]XRControlStyle Class
   [Expand]XRControlStyleSheet Class
   [Expand]XRCrossBandBox Class
   [Expand]XRCrossBandControl Class
   [Expand]XRCrossBandControlCollection Class
   [Expand]XRCrossBandLine Class
    XRDockStyle Enumeration
   [Expand]XRFieldEmbeddableControl Class
   [Expand]XRGauge Class
   [Expand]XRGaugeScripts Class
   [Expand]XRGroupSortingSummary Class
   [Expand]XRLabel Class
   [Expand]XRLabelScripts Class
   [Expand]XRLine Class
   [Expand]XRLineScripts Class
   [Expand]XRPageBreak Class
   [Expand]XRPageBreakScripts Class
   [Expand]XRPageInfo Class
   [Expand]XRPanel Class
   [Expand]XRPanelScripts Class
   [Expand]XRPictureBox Class
   [Expand]XRPictureboxScripts Class
   [Expand]XRPivotGrid Class
   [Expand]XRPivotGridScripts Class
   [Expand]XRRichText Class
   [Expand]XRRichTextBase Class
   [Expand]XRRichTextBox Class
   [Expand]XRRichTextBoxBase Class
    XRRichTextStreamType Enumeration
   [Expand]XRScriptsBase Class
   [Expand]XRShape Class
   [Expand]XRShapeScripts Class
   [Expand]XRSparkline Class
   [Expand]XRSparklineScripts Class
   [Expand]XRSubreport Class
   [Expand]XRSummary Class
   [Expand]XRSummaryEvents Class
   [Expand]XRSummaryScripts Class
   [Expand]XRTable Class
   [Expand]XRTableCell Class
   [Expand]XRTableCellCollection Class
   [Expand]XRTableOfContents Class
   [Expand]XRTableOfContentsLevel Class
   [Expand]XRTableOfContentsLevelBase Class
   [Expand]XRTableOfContentsLevelCollection Class
   [Expand]XRTableOfContentsTitle Class
   [Expand]XRTableRow Class
   [Expand]XRTableRowCollection Class
   [Expand]XRTableScripts Class
   [Expand]XRWatermark Class
   [Expand]XRZipCode Class
   [Expand]XtraReport Class
   [Expand]XtraReportBase Class
   [Expand]XtraReportBaseScripts Class
   [Expand]XtraReportDesignerExtensions Class
   [Expand]XtraReportScripts Class
  [Expand]DevExpress.XtraReports.UI.BarCode
  [Expand]DevExpress.XtraReports.UI.PivotGrid
  [Expand]DevExpress.XtraReports.UserDesigner
  [Expand]DevExpress.XtraReports.Web
  [Expand]DevExpress.XtraReports.Web.Azure.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.Azure.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.ClientControls
  [Expand]DevExpress.XtraReports.Web.ClientControls.DataContracts
  [Expand]DevExpress.XtraReports.Web.DocumentViewer
  [Expand]DevExpress.XtraReports.Web.DocumentViewer.Ribbon
  [Expand]DevExpress.XtraReports.Web.Extensions
  [Expand]DevExpress.XtraReports.Web.Localization
  [Expand]DevExpress.XtraReports.Web.QueryBuilder
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Native
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Services
  [Expand]DevExpress.XtraReports.Web.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.DataContracts
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Native
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Native.Services
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Services
  [Expand]DevExpress.XtraReports.Web.Scripts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.DataContracts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.Native
  [Expand]DevExpress.XtraReports.Wizards
  [Expand]DevExpress.XtraReports.Wizards.Builder
  [Expand]DevExpress.XtraReports.Wizards.ColorSchemes
  [Expand]DevExpress.XtraReports.Wizards.Labels
  [Expand]DevExpress.XtraReports.Wizards.Presenters
  [Expand]DevExpress.XtraReports.Wizards.Templates
  [Expand]DevExpress.XtraReports.Wizards.Views
  [Expand]DevExpress.XtraReports.Wizards3
  [Expand]DevExpress.XtraReports.Wizards3.Presenters
  [Expand]DevExpress.XtraReports.Wizards3.Views
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

XRControl.PrintOnPage Event

Occurs when the representation of a control is printed on the current page of the report.

Namespace:DevExpress.XtraReports.UI
Assembly:DevExpress.XtraReports.v19.1.dll

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type PrintOnPageEventArgs containing data related to this event.

The following PrintOnPageEventArgs properties provide information specific to this event.
Property Description
Cancel Gets or sets a value indicating whether the event should be canceled.
PageCount Gets the number of all pages presented in the created report.
PageIndex Gets the index of the current page which the control will be printed on.
PrintAction Returns System.Drawing.Printing.PrintAction.PrintToFile in all cases.

Expanded Remarks

Use this event to perform actions when a control is printed on a particular page in a report. The current page index can be accessed via the PrintOnPageEventArgs.PageIndex property. The PrintOnPageEventArgs.PageCount property is also available, since the event is raised for the current control after all the document pages are created.

When using the DevExpress.XtraPrinting.Caching.CachedReportSource component to generate a report document, the PrintOnPage event is raised each time a page with the current control is created. In this connection, the total number of pages is unknown at the moment the event fires and you cannot use the PrintOnPageEventArgs.PageCount property in the event handler.

Note

Note, however, that changing a control's contents at this event will not change a report's layout (locations and sizes of bricks in a final document), since the report document is already created at this time.

The PrintOnPage event is raised along with the other associated events which are listed below in the order that they are raised:

To learn more, see Report Events.

Expanded Example

The following example demonstrates how to use the PrintOnPage event. The event handler below checks if an xrLabel1 is being printed on the last page (in case the PrintOnPageEventArgs.PageCount property is equal to PrintOnPageEventArgs.PageIndex minus 1), and, if yes, sets its text to "The last page!". Otherwise, it checks if a label is being printed on the odd page, and, if yes, it cancels its printing.

Expanded See Also

Is this topic helpful?​​​​​​​