AppointmentSynchronizer.ForeignIdFieldName Property

Gets or sets the field name that contains the Foreign ID in the third-party scheduling application (MS Outook) database with which appointment data is exchanged.

Namespace: DevExpress.XtraScheduler.Exchange

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

Declaration

C#

public string ForeignIdFieldName { get; set; }

VB.NET

Public Property ForeignIdFieldName As String

Property Value

Type	Description
String	A String representing the name of the field containing the Foreign Id.

Remarks

MS Outlook synchronization uses the OutlookImportSynchronizer and OutlookExportSynchronizer classes, derived from the AppointmentSynchronizer class. Before calling the AppointmentSynchronizer.Synchronize method, you can specify the location of the calendar folder and the name of the database field to store the MS Outlook identifier of an imported event.

The calendar folder name is accessible via the CalendarFolderName property, and can be left empty. In this situation, the default Outlook calendar is used. You can get a list of calendar folders via the DevExpress.XtraScheduler.Outlook.OutlookExchangeHelper.GetOutlookCalendarFolders method.

The ForeignIdFieldName property enables you to specify the data field name intended to hold a foreign (MS Outlook) appointment identifier. This is important, because during synchronization an appointment in the Scheduler storage is matched with the corresponding MS Outlook event using this identifier. The database field can have any name (e.g. “OutlookEntryID”) and should be able to hold a long sequence of characters (e.g. nvarchar(256) in MS Access).

To get the foreign ID of an appointment for your purposes, you can utilize the IGetAppointmentForeignId interface in the AppointmentSynchronizer.AppointmentSynchronized event handler:

C#

void synchronizer_AppointmentSynchronized(object sender, 
    DevExpress.XtraScheduler.AppointmentSynchronizedEventArgs e)
    {                                                         
        object outlookID = ((IGetAppointmentForeignId)sender).GetForeignId(e.Appointment);
    }

VB.NET

Private Sub synchronizer_AppointmentSynchronized(ByVal sender As Object, _ 
ByVal e As DevExpress.XtraScheduler.AppointmentSynchronizedEventArgs)
    Dim outlookID As Object = (CType(sender, IGetAppointmentForeignId)).GetForeignId(e.Appointment)
End Sub

Another way to obtain the foreign appointment ID is to handle the AppointmentExchanger.GetAppointmentForeignId event.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ForeignIdFieldName property.

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-implement-two-way-synchronization-between-scheduler-and-outlook-calendars-t423510/CS/SyncWithOutlook/OutlookSynchronizerHelper.cs#L42

_outlookEntryIDFieldName = value;
if(importSynchronizer != null) importSynchronizer.ForeignIdFieldName = _outlookEntryIDFieldName;
if(exportSynchronizer != null) exportSynchronizer.ForeignIdFieldName = _outlookEntryIDFieldName;

how-to-implement-multi-user-synchronization-with-microsoft-outlook-e39/CS/MainForm.cs#L68

synchronizer.AppointmentSynchronized +=new AppointmentSynchronizedEventHandler(synchronizer_AppointmentImportSynchronized);
synchronizer.ForeignIdFieldName = OutlookEntryIDFieldName;

how-to-synchronize-custom-field-values-between-outlook-and-schedulercontrol-e4000/CS/Form1.cs#L38

importSynchronizer.ForeignIdFieldName = "ForeignOutlookId";
((ISupportCalendarFolders)importSynchronizer).CalendarFolderName = cbOutlookCalendars.Text;

how-to-synchronize-appointments-with-outlook-in-a-multi-user-application-e699/CS/MainForm.cs#L68

synchronizer.AppointmentSynchronized +=new AppointmentSynchronizedEventHandler(synchronizer_AppointmentImportSynchronized);
synchronizer.ForeignIdFieldName = OutlookEntryIDFieldName;
synchronizer.Synchronize();

synchronization-with-ms-outlook-a-demonstration-example-t158895/CS/SyncWithOutlook/Form1.cs#L48

// Specify the field that contains appointment identifier used by a third-party application.
synchronizer.ForeignIdFieldName = OutlookEntryIDFieldName;
// The AppointmentSynchronizing event allows you to control the operation for an individual appointment.

VB.NET

how-to-implement-two-way-synchronization-between-scheduler-and-outlook-calendars-t423510/VB/SyncWithOutlook/OutlookSynchronizerHelper.vb#L60

If importSynchronizer IsNot Nothing Then
    importSynchronizer.ForeignIdFieldName = _outlookEntryIDFieldName
End If

how-to-implement-multi-user-synchronization-with-microsoft-outlook-e39/VB/MainForm.vb#L71

AddHandler synchronizer.AppointmentSynchronized, AddressOf synchronizer_AppointmentImportSynchronized
synchronizer.ForeignIdFieldName = OutlookEntryIDFieldName

how-to-synchronize-custom-field-values-between-outlook-and-schedulercontrol-e4000/VB/Form1.vb#L40

importSynchronizer.ForeignIdFieldName = "ForeignOutlookId"
DirectCast(importSynchronizer, ISupportCalendarFolders).CalendarFolderName = cbOutlookCalendars.Text

how-to-synchronize-appointments-with-outlook-in-a-multi-user-application-e699/VB/MainForm.vb#L71

AddHandler synchronizer.AppointmentSynchronized, AddressOf synchronizer_AppointmentImportSynchronized
synchronizer.ForeignIdFieldName = OutlookEntryIDFieldName
synchronizer.Synchronize()

synchronization-with-ms-outlook-a-demonstration-example-t158895/VB/SyncWithOutlook/Form1.vb#L49

' Specify the field that contains appointment identifier used by a third-party application.
synchronizer.ForeignIdFieldName = OutlookEntryIDFieldName
' The AppointmentSynchronizing event allows you to control the operation for an individual appointment.