DXOutlook365Sync.ExportSchedulerToOutlookAsync(Boolean) Method

Exports the Scheduler’s appointments to Outlook 365 calendars with synchronization enabled.

Namespace: DevExpress.XtraScheduler.Microsoft365Calendar

Assembly: DevExpress.XtraScheduler.v25.2.Microsoft365Calendar.dll

NuGet Package: DevExpress.Scheduler.Core.Desktop.Microsoft365Calendar

Declaration

C#

public Task ExportSchedulerToOutlookAsync(
    bool canRemoveOutlookEvents
)

VB.NET

Public Function ExportSchedulerToOutlookAsync(
    canRemoveOutlookEvents As Boolean
) As Task

Parameters

Name	Type	Description
canRemoveOutlookEvents	Boolean	true to clear Outlook 365 calendars before export; otherwise, false.

Returns

Type	Description
Task	The asynchronous operation.

Remarks

Important

You must initialize the DXOutlook365Sync component before using the ExportSchedulerToOutlookAsync method. Otherwise, the DXOutlook365Sync component throws an exception.

The ExportSchedulerToOutlookAsync method exports the appointments from the Scheduler control to the Office365 calendars with synchronization enabled (EnableSynchronization). Appointments that do not have corresponding events in Outlook 365 are exported to the default calendar in Office365.

Read the following topic for detailed information and examples: Synchronization with Microsoft 365 Calendars.

Example: Export Appointments to Outlook365

C#

using DevExpress.XtraScheduler.Microsoft365Calendar;

DXOutlook365Sync dxOutlook365Sync1;
public Form1() {
    InitializeComponent();
    dxOutlook365Sync1 = new DXOutlook365Sync(schedulerDataStorage1);
    dxOutlook365Sync1.InitComplete += DxOutlook365Sync1_InitComplete;
}
private async Task<bool> InitOutlook365Sync(DXOutlook365Sync outlook365sync) {
    // Initializes the 'dxOutlook365Sync1' component.
    string tenantId = "..."; // Enter your tenant (directory) ID.
    string clientId = "..."; // Enter your client (application) ID.
    InitStatus status = await outlook365sync.InitAsync(tenantId, clientId);
    // Returns false if the initialization of 'dxOutlook365Sync1' failed.
    return status != InitStatus.Error;
}
private async void exportAppointmentsButton_Click(object sender, EventArgs e) {
    // Checks whether the initialization of 'dxOutlook365Sync1' failed.
    if(!await InitOutlook365Sync(dxOutlook365Sync1)) return;
    splashScreenManager1.ShowWaitForm();
    // Exports the Scheduler control's appointments to Outlook365.
    await dxOutlook365Sync1.ExportSchedulerToOutlookAsync(false);
    splashScreenManager1.CloseWaitForm();
}
private void DxOutlook365Sync1_InitComplete(object sender, InitCompleteEventArgs e) {
    if(e.InitStatus == InitStatus.Error)
        XtraMessageBox.Show(String.Format("Initialization of DXOutlook365Sync failed. {0}", e.Exception.Message), "Error", MessageBoxButtons.OK);
}

VB.NET

Imports DevExpress.XtraScheduler.Microsoft365Calendar

Private dxOutlook365Sync1 As DXOutlook365Sync
Public Sub New()
    InitializeComponent()
    dxOutlook365Sync1 = New DXOutlook365Sync(schedulerDataStorage1)
    AddHandler dxOutlook365Sync1.InitComplete, AddressOf DxOutlook365Sync1_InitComplete
End Sub
Private Async Function InitOutlook365Sync(ByVal outlook365sync As DXOutlook365Sync) As Task(Of Boolean)
    ' Initializes the 'dxOutlook365Sync1' component.
    Dim tenantId As String = "..." ' Enter your tenant (directory) ID.
    Dim clientId As String = "..." ' Enter your client (application) ID.
    Dim status As InitStatus = Await outlook365sync.InitAsync(tenantId, clientId)
    ' Returns false if the initialization of 'dxOutlook365Sync1' failed.
    Return status IsNot InitStatus.Error
End Function
Private Async Sub exportAppointmentsButton_Click(ByVal sender As Object, ByVal e As EventArgs)
    ' Checks whether the initialization of 'dxOutlook365Sync1' failed.
    If (Not Await) InitOutlook365Sync(dxOutlook365Sync1) Then
        Return
    End If
    splashScreenManager1.ShowWaitForm()
    ' Exports the Scheduler control's appointments to Outlook365.
    Await dxOutlook365Sync1.ExportSchedulerToOutlookAsync(False)
    splashScreenManager1.CloseWaitForm()
End Sub
Private Sub DxOutlook365Sync1_InitComplete(ByVal sender As Object, ByVal e As InitCompleteEventArgs)
    If e.InitStatus = InitStatus.Error Then
        XtraMessageBox.Show(String.Format("Initialization of DXOutlook365Sync failed. {0}", e.Exception.Message), "Error", MessageBoxButtons.OK)
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportSchedulerToOutlookAsync(Boolean) 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#

winforms-scheduler-synchronize-appointments-with-outlook-365/CS/DXOutlook365Sync/Form1.cs#L116

// Exports the Scheduler control's appointments to the Outlook365 calendar.
await dxOutlook365Sync1.ExportSchedulerToOutlookAsync(false);
// Hides the wait form.

wpf-scheduler-synchronize-appointments-with-outlook-365/CS/Outlook365Sync/MainWindow.xaml.cs#L46

case Actions.Scheduler2Outlook:
    await dXOutlook365Sync.ExportSchedulerToOutlookAsync(viewModel.AllowRemoveMS365Events);
    break;

VB.NET

winforms-scheduler-synchronize-appointments-with-outlook-365/VB/DXOutlook365Sync/Form1.vb#L108

' Exports the Scheduler control's appointments to the Outlook365 calendar.
Await dxOutlook365Sync1.ExportSchedulerToOutlookAsync(False)
' Hides the wait form.