ASPxAppointmentStorage.AutoRetrieveId Property

Gets or sets whether the ID of a new appointment is retrieved from the data source.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v24.2.dll

Declaration

C#

[DefaultValue(false)]
public bool AutoRetrieveId { get; set; }

VB.NET

<DefaultValue(False)>
Public Property AutoRetrieveId As Boolean

Property Value

Type	Default	Description
Boolean	false	true, to get the appointment ID for a newly created appointment from the data source; otherwise, false.

Remarks

The AutoRetrieveId option is only valid for the ObjectDataSource and the SqlDataSource data controls bound to the Scheduler.

Important

For the AutoRetrieveId property to have effect, the object data source should meet the following requirements:

• INSERT method returns the appointment ID
• a data source field, which maps to the appointment ID, is writable

When the AutoRetrieveId is set to true, a newly created appointment obtains its ID from the data source. This scenario assumes that the data source generates the primary key (identity) for inserted data rows automatically. After a new appointment record is written, its ID is fetched and assigned to the Appointment instance in the Scheduler storage. Therefore, appointment unique identifiers in the Scheduler storage are the same as for the appointments in the data source.

The AutoRetrieveId option replaces the following code that has been used previously for MS SQL Server and object data sources:

View Example

Default.aspx.cs

// The following code is unnecessary if the ASPxScheduler.Storage.Appointments.AutoRetrieveId option is TRUE.
protected void ASPxScheduler1_AppointmentInserted(object sender, DevExpress.XtraScheduler.PersistentObjectsEventArgs e)
{
    SetAppointmentId(sender, e);
}
protected void appointmentsDataSource_Inserted(object sender, ObjectDataSourceStatusEventArgs e)
{
    this.lastInsertedAppointmentId = e.ReturnValue;
}
void SetAppointmentId(object sender, DevExpress.XtraScheduler.PersistentObjectsEventArgs e)
{
    DevExpress.Web.ASPxScheduler.ASPxSchedulerStorage storage = (DevExpress.Web.ASPxScheduler.ASPxSchedulerStorage)sender;
    DevExpress.XtraScheduler.Appointment apt = (DevExpress.XtraScheduler.Appointment)e.Objects[0];
    storage.SetAppointmentId(apt, this.lastInsertedAppointmentId);
}

Default.aspx.vb

' User generated appointment id. The following code is unnecessary if the AutoRetrieveId option is TRUE.
Protected Sub ASPxScheduler1_AppointmentInserted(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.PersistentObjectsEventArgs)
    SetAppointmentId(sender, e)
End Sub
Protected Sub appointmentsDataSource_Inserted(ByVal sender As Object, ByVal e As ObjectDataSourceStatusEventArgs)
    Me.lastInsertedAppointmentId = e.ReturnValue
End Sub
Private Sub SetAppointmentId(ByVal sender As Object, ByVal e As DevExpress.XtraScheduler.PersistentObjectsEventArgs)
    Dim storage As DevExpress.Web.ASPxScheduler.ASPxSchedulerStorage = CType(sender, DevExpress.Web.ASPxScheduler.ASPxSchedulerStorage)
    Dim apt As DevExpress.XtraScheduler.Appointment = CType(e.Objects(0), DevExpress.XtraScheduler.Appointment)
    storage.SetAppointmentId(apt, Me.lastInsertedAppointmentId)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AutoRetrieveId 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-customize-the-appointment-dialog-using-view-model-api-working-with-custom-fields-t582020/CS/DevExpressMvcApplication1/Models/SchedulerDataHelper.cs#L64

MVCxAppointmentStorage appointmentStorage = new MVCxAppointmentStorage();
appointmentStorage.AutoRetrieveId = true;
appointmentStorage.Mappings.AppointmentId = "ID";

VB.NET

how-to-customize-the-appointment-dialog-using-view-model-api-working-with-custom-fields-t582020/VB/DevExpressMvcApplication1/Models/SchedulerDataHelper.vb#L68

Dim appointmentStorage As New MVCxAppointmentStorage()
appointmentStorage.AutoRetrieveId = True
appointmentStorage.Mappings.AppointmentId = "ID"