DXSchedulerPrintAdapter.SchedulerAdapter Property

Provides access to the scheduler print adapter.

Namespace: DevExpress.Xpf.Scheduler.Reporting

Assembly: DevExpress.Xpf.Scheduler.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Scheduler, DevExpress.Wpf.Scheduler

Declaration

C#

[Browsable(false)]
public SchedulerPrintAdapter SchedulerAdapter { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property SchedulerAdapter As SchedulerPrintAdapter

Property Value

Type	Description
SchedulerPrintAdapter	A SchedulerPrintAdapter object specifying a print adapter for the report.

Remarks

Important

You are viewing documentation for the legacy WPF Scheduler control. If you’re starting a new project, we strongly recommend that you use a new control declared in the DevExpress.Xpf.Scheduling namespace. If you decide to upgrade an existing project in order to switch to the updated scheduler control, see the Migration Guidelines document.

Example

If all you need to do is to print a schedule based on the data obtained from a data source, and a visible form containing a SchedulerControl and editing capabilities are unnecessary, follow the steps below.

1. Drop the DocumentPreview control onto the form from the DX.20.2: Reporting toolbox tab.
2. Create a stand-alone SchedulerStorage, bind it to appointment data and specify standard mappings for appointment properties. This storage will play the role of the data source for a report’s print adapter.
3. Create a new XtraSchedulerReport object and load the WeeklyStyle template from the gallery of ready-made scheduler report layout templates. To get step-by-step instructions, see the How to: Add XtraSchedulerReport to a WPF Application (legacy) topic.
4. Drop the DXSchedulerStoragePrintAdapter print adapter onto the form from the DX.20.2: Scheduling toolbox tab. Set its DXSchedulerStoragePrintAdapter.SchedulerStorage property to the previously created SchedulerStorage as the data source for the print adapter.
5. Use the DXSchedulerPrintAdapter.TimeInterval, DXSchedulerPrintAdapter.FirstDayOfWeek and other options to customize the print adapter.
6. For advanced customization, a set of Validate* events, such as the DXSchedulerPrintAdapter.ValidateAppointments, DXSchedulerPrintAdapter.ValidateResources, DXSchedulerPrintAdapter.ValidateTimeIntervals, or DXSchedulerPrintAdapter.ValidateWorkTime can be helpful. In this example, handle the ValidateAppointments event to filter appointments and display only recurring ones.
7. Specify the scheduler print adapter for the report via the XtraSchedulerReport.SchedulerAdapter and DXSchedulerPrintAdapter.SchedulerAdapter properties.
8. Call the XtraReport.CreateDocument method to create a report document, so it can be displayed or printed.
9. Finally, create an instance of the XtraReportPreviewModel class with the passed report that has been previously created. Set this preview model to the DocumentPreview.Model property of the DocumentPreview control located on the form.

The following code illustrates the technique described above.

View Example

MainWindow.xaml

<Window x:Class="WpfApplication1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxsch="http://schemas.devexpress.com/winfx/2008/xaml/scheduler" 
        xmlns:dxp="http://schemas.devexpress.com/winfx/2008/xaml/printing" 
        Title="MainWindow" Height="350" Width="525">
    <Grid>
        <dxsch:SchedulerStorage x:Name="storage">
            <dxsch:SchedulerStorage.AppointmentStorage>
                <dxsch:AppointmentStorage>
                    <dxsch:AppointmentStorage.Mappings>
                        <dxsch:AppointmentMapping 
                                    Start="StartTime" 
                                    End="EndTime" 
                                    AllDay="AllDay"
                                    Description="Description"
                                    Label="Label"
                                    Location="Location"
                                    Subject="Subject" 
                                    RecurrenceInfo="RecurrenceInfo"
                                    ReminderInfo="ReminderInfo"
                                    Status="Status"
                                    Type="EventType"/>
                    </dxsch:AppointmentStorage.Mappings>
                </dxsch:AppointmentStorage>
            </dxsch:SchedulerStorage.AppointmentStorage>
        </dxsch:SchedulerStorage>
        <dxsch:DXSchedulerStoragePrintAdapter x:Name="printAdapter"/>
        <dxp:DocumentPreview x:Name="documentPreview" 
                             VerticalAlignment="Stretch" HorizontalAlignment="Stretch">
        </dxp:DocumentPreview>
    </Grid>
</Window>

MainWindow.xaml.cs

using System;
using System.Windows;
using DevExpress.Xpf.Printing;
using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Reporting;

namespace WpfApplication1 {
    public partial class MainWindow : Window {

        CarsDBDataSet dataSet;
        CarsDBDataSetTableAdapters.CarSchedulingTableAdapter tableAdapter;

        public MainWindow() {
            InitializeComponent();

            this.dataSet = new CarsDBDataSet();

            // Bind the scheduler storage to appointment data.
            storage.AppointmentStorage.DataSource = dataSet.CarScheduling;

            // Load data into the 'CarsDBDataSet.CarScheduling' table. 
            this.tableAdapter = new CarsDBDataSetTableAdapters.CarSchedulingTableAdapter();
            this.tableAdapter.Fill(dataSet.CarScheduling);

            // Create a new report instance.
            XtraSchedulerReport report = new XtraSchedulerReport();

            // Specify the scheduler storage for the print adapter.
            printAdapter.SchedulerStorage = storage;

            // Specify the time inteval and start day of week used by the print adapter to create a report.
            printAdapter.TimeInterval =
                                new TimeInterval(new DateTime(2010, 7, 15), new DateTime(2010, 7, 30));
            printAdapter.FirstDayOfWeek = FirstDayOfWeek.Tuesday;

            // Implement appointment filtering.
            printAdapter.ValidateAppointments +=
                            new AppointmentsValidationEventHandler(printAdapter_ValidateAppointments);

            // Specify the print adapter which provides data for the report.
            report.SchedulerAdapter = printAdapter.SchedulerAdapter;

            // Create a document from the report, so the report can be displayed or printed.
            report.CreateDocument();

            // Create a preview model with the specified report.
            XtraReportPreviewModel previewModel = new XtraReportPreviewModel(report);

            // Specify the model for the DocumentPreview control.
            documentPreview.Model = previewModel;
        }

        private void printAdapter_ValidateAppointments(object sender, AppointmentsValidationEventArgs e) {
            int count = e.Appointments.Count;
            AppointmentBaseCollection result = new AppointmentBaseCollection();
            for (int i = 0; i < count; i++) {
                Appointment apt = e.Appointments[i];
                if (apt.IsRecurring)
                    result.Add(apt);
            }
            e.Appointments.Clear();
            e.Appointments.AddRange(result);
        }
    }
}

MainWindow.xaml.vb

Imports System
Imports System.Windows
Imports DevExpress.Xpf.Printing
Imports DevExpress.Xpf.Scheduler
Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Reporting

Namespace WpfApplication1
    Class MainWindow
        Private dataSet As CarsDBDataSet
        Private tableAdapter As CarsDBDataSetTableAdapters.CarSchedulingTableAdapter

        Public Sub New()
            InitializeComponent()

            Me.dataSet = New CarsDBDataSet()

            ' Bind the scheduler storage to appointment data.
            Me.storage.AppointmentStorage.DataSource = dataSet.CarScheduling

            ' Load data into the 'CarsDBDataSet.CarScheduling' table. 
            Me.tableAdapter = New CarsDBDataSetTableAdapters.CarSchedulingTableAdapter()
            Me.tableAdapter.Fill(dataSet.CarScheduling)

            ' Create a new report instance.
            Dim report As New XtraSchedulerReport()

            ' Specify the scheduler storage for the print adapter.
            printAdapter.SchedulerStorage = storage

            ' Specify the time inteval and start day of week used by the print adapter to create a report.
            printAdapter.TimeInterval = New TimeInterval(New DateTime(2010, 7, 15), _
                                                         New DateTime(2010, 7, 30))
            printAdapter.FirstDayOfWeek = DevExpress.XtraScheduler.FirstDayOfWeek.Tuesday

            ' Implement appointment filtering.
            AddHandler printAdapter.ValidateAppointments, AddressOf printAdapter_ValidateAppointments

            ' Specify the print adapter which provides data for the report.
            report.SchedulerAdapter = printAdapter.SchedulerAdapter

            ' Create a document from the report, so the report can be displayed or printed.
            report.CreateDocument()

            ' Create a preview model with the specified report.
            Dim previewModel As New XtraReportPreviewModel(report)

            ' Specify the model for the DocumentPreview control.
            DocumentPreview.Model = previewModel

        End Sub

        Private Sub printAdapter_ValidateAppointments(ByVal sender As Object, _
                                                  ByVal e As AppointmentsValidationEventArgs)
            Dim count As Integer = e.Appointments.Count
            Dim result As New AppointmentBaseCollection()
            For i As Integer = 0 To count - 1
                Dim apt As Appointment = e.Appointments(i)
                If apt.IsRecurring Then
                    result.Add(apt)
                End If
            Next i
            e.Appointments.Clear()
            e.Appointments.AddRange(result)
        End Sub
    End Class
End Namespace