IOutlookCalendarProvider.PrepareItemsForExchange(_Items) Method

Override this method to create a list of items representing appointments in export/import processes.

Namespace: DevExpress.XtraScheduler.Outlook

Assembly: DevExpress.XtraScheduler.v23.2.Core.Desktop.dll

NuGet Package: DevExpress.Scheduler.CoreDesktop

Declaration

C#

List<_AppointmentItem> PrepareItemsForExchange(
    _Items items
)

VB.NET

Function PrepareItemsForExchange(
    items As _Items
) As List(Of _AppointmentItem)

Parameters

Name	Type	Description
items	DevExpress.XtraScheduler.Outlook.Interop._Items	A list of objects implementing the DevExpress.XtraScheduler.Outlook.Interop._AppointmentItem interface.

Returns

Type	Description
List<_AppointmentItem>	An object implementing the DevExpress.XtraScheduler.Outlook.Interop._Items interface.

Remarks

Override the PrepareItemsForExchange method to filter a collection of appointment items passed for import/export.

The following code illustrates the implementation of the custom outlook calendar provider, that enables you to filter outlook objects before they are imported to the Scheduler.

The filter is set to import appointments for the current week only. More specifically, the following appointments are imported:

• all simple non-recurring appointments within a specified week interval;
• all series of recurring appointments if any of these appointments occur during a specified week (note that series are imported in their entirety, including simple occurrences and exceptions).

Form1.cs

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.Native;
using DevExpress.XtraScheduler.Outlook;
using DevExpress.XtraScheduler.Outlook.Interop;
    public class ParameterizedCalendarProvider: OutlookCalendarProvider {
        TimeInterval interval;
        public ParameterizedCalendarProvider(TimeInterval interval) {
            this.interval = interval != null ? interval : TimeInterval.Empty;
        }
        public TimeInterval Interval { get { return interval; } }

        protected override List<_AppointmentItem> PrepareItemsForExchange(_Items items) {
             List<_AppointmentItem> result = new List<_AppointmentItem>();
             if (items == null)
                return result;

            string filter = FormatInterval(Interval);
            _AppointmentItem olApt = items.Find(filter) as _AppointmentItem;
            while (olApt != null) {
                result.Add(olApt);
                olApt = items.FindNext() as _AppointmentItem;
            }
            return result;
        }
        protected string FormatInterval(TimeInterval interval) {
            return String.Format("[Start] > '{0}' AND [End] < '{1}'",
                interval.Start.ToString("g"), interval.End.ToString("g"));
        }
    }

Form1.vb

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.Native
Imports DevExpress.XtraScheduler.Outlook
Imports DevExpress.XtraScheduler.Outlook.Interop
    Public Class ParameterizedCalendarProvider
        Inherits OutlookCalendarProvider
        Private interval_Renamed As TimeInterval
        Public Sub New(ByVal interval As TimeInterval)
            If interval IsNot Nothing Then
                Me.interval_Renamed = interval
            Else
                Me.interval_Renamed = TimeInterval.Empty
            End If
        End Sub
        Public ReadOnly Property Interval() As TimeInterval
            Get
                Return interval_Renamed
            End Get
        End Property

        Protected Overrides Function PrepareItemsForExchange(ByVal items As _Items)  _
            As List(Of _AppointmentItem)
             Dim result As New List(Of _AppointmentItem)()
             If items Is Nothing Then
                Return result
             End If

            Dim filter As String = FormatInterval(Interval)
            Dim olApt As _AppointmentItem = TryCast(items.Find(filter), _AppointmentItem)
            Do While olApt IsNot Nothing
                result.Add(olApt)
                olApt = TryCast(items.FindNext(), _AppointmentItem)
            Loop
            Return result
        End Function
        Protected Function FormatInterval(ByVal interval As TimeInterval) As String
            Return String.Format("[Start] > '{0}' AND [End] < '{1}'", _
            interval.Start.ToString("g"), interval.End.ToString("g"))
        End Function
    End Class