XtraSchedulerReport Class

Represents the base class for a report in the XtraScheduler Suite.

Namespace: DevExpress.XtraScheduler.Reporting

Assembly: DevExpress.XtraScheduler.v17.2.Reporting.dll

Declaration

C#
VB.NET

[XRDesigner("DevExpress.XtraScheduler.Reporting.Design.SchedulerReportDesigner,DevExpress.XtraScheduler.v17.2.Reporting.Extensions", typeof(IRootDesigner))]
public class XtraSchedulerReport :
    CustomReportBase,
    ISchedulerReport,
    IReport,
    IDocumentSource,
    ILink,
    IComponent,
    IDisposable,
    IServiceProvider,
    IExtensionsProvider

<XRDesigner("DevExpress.XtraScheduler.Reporting.Design.SchedulerReportDesigner,DevExpress.XtraScheduler.v17.2.Reporting.Extensions", GetType(IRootDesigner))>
Public Class XtraSchedulerReport
    Inherits CustomReportBase
    Implements ISchedulerReport,
               IReport,
               IDocumentSource,
               ILink,
               IComponent,
               IDisposable,
               IServiceProvider,
               IExtensionsProvider

Remarks

The XtraSchedulerReport is a base class of any XtraScheduler report. It contains a DetailBand with XtraReports controls and XtraScheduler reporting controls on it. The XtraSchedulerReport class defines the structure of a report, and has the properties and methods which are required to create a document, and then preview, print or export it.

The Visual Studio Report Designer for the newly created XtraSchedulerReport report is illustrated in the following image.

Reporting - Empty Designer

For more information on creating an XtraSchedulerReport at design time, review the How to: Print a Scheduler Using a Report Preview (Step-by-Step Guide) document.

The following code snippets (auto-collected from DevExpress Examples) contain references to the XtraSchedulerReport class.

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.

C#
VB.NET

how-to-construct-an-xtraschedulerreport-at-runtime-e1390/CS/ReportInCode/Form1.cs#L21

#region #createreport
XtraSchedulerReport xr = new XtraSchedulerReport();
// Add a Day View to the Report.

how-to-display-resource-captions-horizontally-when-a-verticalresourceheaders-control-is-used-e1545/CS/HorizontalResourceHeaderCaption/XtraSchedulerReport1.cs#L10

namespace HorizontalResourceHeaderCaption {
    public partial class WeeklyReport : DevExpress.XtraScheduler.Reporting.XtraSchedulerReport {
        public WeeklyReport() {

how-to-load-an-xtraschedulerreport-from-template-e1389/CS/ReportLoad/Form1.cs#L26

// Create a new report
XtraSchedulerReport report = new XtraSchedulerReport();
// Load the report template

how-to-create-a-report-without-visible-schedulercontrol-e3956/CS/WpfApplication1/XtraSchedulerReport.cs#L4

namespace WpfApplication1 {
    public partial class XtraSchedulerReport : DevExpress.XtraScheduler.Reporting.XtraSchedulerReport {
        public XtraSchedulerReport() {

scheduler-how-to-implement-printing-via-reporting-mechanism-e20056/CS/DevExpressMvcApplication1/Reports/SchedulerDayReport.cs#L7

namespace DevExpressMvcApplication1.Reports {
    public partial class SchedulerDayReport : DevExpress.XtraScheduler.Reporting.XtraSchedulerReport {
        public SchedulerDayReport() {

how-to-construct-an-xtraschedulerreport-at-runtime-e1390/VB/ReportInCode/Form1.vb#L22

'            #Region "#createreport         "
            Dim xr As New XtraSchedulerReport()
            ' Add a Day View to the Report.

how-to-display-resource-captions-horizontally-when-a-verticalresourceheaders-control-is-used-e1545/VB/HorizontalResourceHeaderCaption/XtraSchedulerReport1.vb#L12

Partial Public Class WeeklyReport
    Inherits DevExpress.XtraScheduler.Reporting.XtraSchedulerReport
    Public Sub New()

how-to-load-an-xtraschedulerreport-from-template-e1389/VB/ReportLoad/Form1.vb#L28

' Create a new report
Dim report As New XtraSchedulerReport()
' Load the report template

scheduler-how-to-implement-printing-via-reporting-mechanism-e20056/VB/DevExpressMvcApplication1/Reports/SchedulerDayReport.vb#L8

Partial Public Class SchedulerDayReport
    Inherits DevExpress.XtraScheduler.Reporting.XtraSchedulerReport

how-to-create-a-scheduler-report-and-show-it-in-the-print-preview-dialog-e3964/VB/SchedulerPrintPreviewSample/MainWindow.xaml.vb#L37

' to the SchedulerPrintHelper.ShowPrintPreview method that is called on a button click.
printingSettings.ReportInstance = New XtraSchedulerReport()
printingSettings.SchedulerPrintAdapter = printAdapter