HolidaysHelper.GenerateHolidayAppointments(ISchedulerStorageBase, WorkDaysCollection) Method

Creates all-day appointments for the collection of holidays added to the specified SchedulerControl.WorkDays collection of the scheduler.

Namespace: DevExpress.XtraScheduler.Native

Assembly: DevExpress.XtraScheduler.v19.1.Core.dll

Declaration

C#

public static AppointmentBaseCollection GenerateHolidayAppointments(
    ISchedulerStorageBase storage,
    WorkDaysCollection workDays
)

VB.NET

Public Shared Function GenerateHolidayAppointments(
    storage As ISchedulerStorageBase,
    workDays As WorkDaysCollection
) As AppointmentBaseCollection

Parameters

Name	Type	Description
storage	ISchedulerStorageBase	A ISchedulerStorageBase object.
workDays	WorkDaysCollection	A WorkDaysCollection object containing information about holidays for which appointments should be generated.

Returns

Type	Description
AppointmentBaseCollection	An AppointmentBaseCollection collection of generated appointments.

Remarks

The GenerateHolidayAppointments method creates a collection of all-day appointments of the AppointmentType.Normal type scheduled for holidays contained in the SchedulerControl.WorkDays collection. Each appointment has a subject that is equal to KnownDateDay.DisplayName of the corresponding holiday.

Add appointments to SchedulerStorage to persist and display them in the scheduler.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GenerateHolidayAppointments(ISchedulerStorageBase, WorkDaysCollection) 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#

how-to-load-holidays-from-the-outlookhol-file-e4129/CS/WindowsFormsApplication1/Form1.cs#L73

private void GenerateAppointments() {
    AppointmentBaseCollection apts = DevExpress.XtraScheduler.Native.HolidaysHelper.GenerateHolidayAppointments(
        schedulerStorage1, schedulerControl1.WorkDays);

VB.NET

how-to-load-holidays-from-the-outlookhol-file-e4129/VB/WindowsFormsApplication1/Form1.vb#L70

Private Sub GenerateAppointments()
    Dim apts As AppointmentBaseCollection = DevExpress.XtraScheduler.Native.HolidaysHelper.GenerateHolidayAppointments(schedulerStorage1, schedulerControl1.WorkDays)