AppointmentOperationEventArgs.Allow Property

Gets or sets a value indicating whether an end-user is allowed to perform a particular action.

Namespace: DevExpress.XtraScheduler

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

Declaration

C#

public bool Allow { get; set; }

VB.NET

Public Property Allow As Boolean

Property Value

Type	Description
Boolean	true if an action is allowed; otherwise, false.

Remarks

If the Allow property value will not be set in the corresponding AllowAppointment event handler, then it is considered that the action is allowed (Allow will be set to true by default).

Example

This example demonstrates how to implement custom rules for editing and deleting appointments. The code below allows an appointment to be edited only by its owner (the end-user who created it). To do this it’s necessary to set the SchedulerOptionsCustomization.AllowAppointmentEdit and SchedulerOptionsCustomization.AllowAppointmentDelete properties to UsedAppointmentType.Custom, and handle the SchedulerControl.AllowAppointmentEdit and SchedulerControl.AllowAppointmentDelete events to implement custom logic for editing appointments.

C#

using DevExpress.XtraScheduler;
// ...

private void schedulerControl1_AllowAppointmentDelete(object sender, 
    AppointmentOperationEventArgs e) {
   // Allow only the user who created this appontment to delete it.
   e.Allow = CanUserModifyThisAppointment(e.Appointment);
}
private void schedulerControl1_AllowAppointmentEdit(object sender, 
    AppointmentOperationEventArgs e) {
   // Allow only the user who created this appontment to modify it.
   e.Allow = CanUserModifyThisAppointment(e.Appointment);
}
// Determine if the current user is the same 
// as the one who created the specified appointment 
bool CanUserModifyThisAppointment(Appointment apt) {
   object obj = apt.CustomFields["Owner"];
   if (obj == null)
      return true;
   string appointmentOwner = obj.ToString();
   if (appointmentOwner == String.Empty)
      return true;
   return (String.Compare(appointmentOwner, tbUserName.Text, true) == 0);
}

VB.NET

Imports DevExpress.XtraScheduler
' ...

Private Sub schedulerControl1_AllowAppointmentDelete(ByVal sender As Object, _
ByVal e As AppointmentOperationEventArgs)
   ' Allow only the user who created this appontment to delete it.
   e.Allow = CanUserModifyThisAppointment(e.Appointment)
End Sub
Private Sub schedulerControl1_AllowAppointmentEdit(ByVal sender As Object, _
ByVal e As AppointmentOperationEventArgs)
   ' Allow only the user who created this appontment to modify it.
   e.Allow = CanUserModifyThisAppointment(e.Appointment)
End Sub
' Determine if the current user is the same 
' as the one who created the specified appointment 
Private Function CanUserModifyThisAppointment(ByVal apt As Appointment) As Boolean
   Dim obj As Object = apt.CustomFields("Owner")
   If obj Is Nothing Then
      Return True
   End If
   Dim appointmentOwner As String = obj.ToString()
   If appointmentOwner = String.Empty Then
      Return True
   End If
   Return (String.Compare(appointmentOwner, tbUserName.Text, True) = 0)
End Function

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Allow 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-set-end-user-restrictions-e2516/CS/WpfApplication1/MainWindow.xaml.cs#L23

    AppointmentOperationEventArgs e) {
    e.Allow = IsIntervalAllowed(schedulerControl1.ActiveView.SelectedInterval);
}

end-user-restrictions-how-to-define-availability-intervals-for-different-resources-e4673/CS/MainWindow.xaml.cs#L28

    e.Allow = available;
}

how-to-create-a-time-cell-area-restricted-for-appointments-e58/CS/Form1.cs#L31

private void schedulerControl1_AllowAppointmentCreate(object sender, AppointmentOperationEventArgs e) {
    e.Allow = IsIntervalAllowed(schedulerControl1.ActiveView.SelectedInterval);
}

VB.NET

how-to-set-end-user-restrictions-e2516/VB/WpfApplication1/MainWindow.xaml.vb#L25

                                                     ByVal e As AppointmentOperationEventArgs)
    e.Allow = IsIntervalAllowed(schedulerControl1.ActiveView.SelectedInterval)
End Sub

end-user-restrictions-how-to-define-availability-intervals-for-different-resources-e4673/VB/MainWindow.xaml.vb#L28

    e.Allow = available
End Sub

how-to-create-a-time-cell-area-restricted-for-appointments-e58/VB/Form1.vb#L26

Private Sub schedulerControl1_AllowAppointmentCreate(ByVal sender As Object, ByVal e As AppointmentOperationEventArgs) Handles schedulerControl1.AllowAppointmentCreate
    e.Allow = IsIntervalAllowed(schedulerControl1.ActiveView.SelectedInterval)
End Sub