DXSchedulerPrintAdapter Class

A base class for print adapters of the SchedulerControl reports.

Namespace: DevExpress.Xpf.Scheduler.Reporting

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

Declaration

public abstract class DXSchedulerPrintAdapter :
    DXDesignTimeControl,
    ISchedulerPrintAdapterPropertiesBase,
    ISchedulerPropertiesBase,
    INotifyPropertyChanging,
    INotifyPropertyChanged,
    ISupportInitialize,
    IDisposable
Public MustInherit Class DXSchedulerPrintAdapter
    Inherits DXDesignTimeControl
    Implements ISchedulerPrintAdapterPropertiesBase,
               ISchedulerPropertiesBase,
               INotifyPropertyChanging,
               INotifyPropertyChanged,
               ISupportInitialize,
               IDisposable

Related API Members

The following members accept/return DXSchedulerPrintAdapter objects:

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.

Scheduler print adapter serves as the data source of the scheduling data for the report, and for all report controls.

Examples

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.1: 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.1: 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.

<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>
See Also