SchedulerControl.ShowPrintPreview(SchedulerPrintStyle) Method

Opens the Print Preview window for the scheduler control’s print output, using the specified print style.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v19.1.dll

Declaration

C#

public void ShowPrintPreview(
    SchedulerPrintStyle printStyle
)

VB.NET

Public Sub ShowPrintPreview(
    printStyle As SchedulerPrintStyle
)

Parameters

Name	Type	Description
printStyle	SchedulerPrintStyle	A SchedulerPrintStyle object which specifies the print style to be used when printing the Scheduler’s data.

Remarks

The Print Preview window displays the scheduler as it will appear when it’s printed. The scheduler can be previewed and printed only if the XtraPrinting Library is available. To verify that printing and previewing the scheduler is possible, use the SchedulerControl.IsPrintingAvailable property.

The Print Preview dialog allows printing and saving to a file in PDF or one of the image formats.

Use this method to print the scheduler’s data using the specified print style. Note that all the available print styles are contained in the SchedulerControl.PrintStyles collection.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/printing-how-to-customize-default-print-styles-t147965

MyDailyPrintStyle.cs

class MyDailyPrintStyle : DevExpress.XtraScheduler.Printing.DailyPrintStyle
{
    public MyDailyPrintStyle()
        : base(false) {
        // Print information on appointments which do not fall in the PrintTime interval.
        base.PrintAllAppointments = true;
        // Hide the reference mini-calendar.
        base.CalendarHeaderVisible = false;
        // Do not use time slots displayed in the Day view of the SchedulerControl.
        base.UseActiveViewTimeScale = false;
        // Determine the row height (specify the time interval of a time slot).
        base.TimeSlots.Clear();
        base.TimeSlots.Add(TimeSpan.FromMinutes(15), "15Minutes");
        // Specify the time interval to print.
        base.PrintTime = new DevExpress.XtraScheduler.TimeOfDayInterval(TimeSpan.FromHours(12), TimeSpan.FromHours(14));
    }

    protected override string DefaultDisplayName
    {
        get
        {
            return "My Daily Style";
        }
    }
}

Form1.cs

schedulerControl1.ShowPrintPreview(new MyDailyPrintStyle());

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowPrintPreview(SchedulerPrintStyle) method.

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#

printing-how-to-customize-default-print-styles-t147965/CS/Printing_Built-in_Example/Form1.cs#L99

{
    schedulerControl1.ShowPrintPreview(this.myPrintStyle);
}

VB.NET

printing-how-to-customize-default-print-styles-t147965/VB/Printing_Built-in_Example/Form1.vb#L90

Private Sub btnShowPreview_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles btnShowPreview.ItemClick
    schedulerControl1.ShowPrintPreview(Me.myPrintStyle)
End Sub