RecurrenceRangeControl Class

A control used to specify an end condition for the series of recurring appointments.

Namespace: DevExpress.Xpf.Scheduler.UI

Assembly: DevExpress.Xpf.Scheduler.v24.2.dll

NuGet Package: DevExpress.Wpf.Scheduler

Declaration

C#

public class RecurrenceRangeControl :
    UserControl,
    INotifyPropertyChanged,
    IComponentConnector

VB.NET

Public Class RecurrenceRangeControl
    Inherits UserControl
    Implements INotifyPropertyChanged,
               IComponentConnector

Remarks

Important

You are viewing documentation for the legacy WPF Scheduler control. If you’re starting a new project, we strongly recommend that you use a new control declared in the DevExpress.Xpf.Scheduling namespace. If you decide to upgrade an existing project in order to switch to the updated scheduler control, see the Migration Guidelines document.

The control is used to set the RecurrenceInfo.Range value for the recurrence series.

The control looks as illustrated in the image below.

To bind the RecurrenceRangeControl control to the recurrence range setting of the pattern appointment, use its RecurrenceRangeControl.RecurrenceInfo and RecurrenceRangeControl.Pattern properties.

Refer to How to: Create a Custom Appointment Recurrence Form (legacy) for an example on how to use the RecurrenceRangeControl control on a custom appointment recurrence editing form.

Example

This example demonstrates how to use the RecurrenceRangeControl control on a custom Edit Appointment form, to modify recurrence range of the pattern appointment. To bind the RecurrenceRangeControl control to the recurrence range settings via the RecurrenceVisualController and AppointmentFormController controllers, use the RecurrenceRangeControl.RecurrenceInfo and RecurrenceRangeControl.Pattern properties.

To get an example with step-by-step instructions on how to replace a standard Edit Appointment form with a custom one, refer to the Lesson 9 - Create a Custom Edit Appointment Form (legacy) document.

C#

using System;
using System.Windows;
using System.Windows.Controls;
using DevExpress.Xpf.Scheduler;
using DevExpress.XtraScheduler;
using DevExpress.Xpf.Scheduler.UI;

namespace WpfApplication1 {

    public partial class CustomAppointmentForm : UserControl {

        SchedulerControl control;
        CustomAppointmentFormController controller;
        RecurrenceVisualController recurrenceVisualController;

        public CustomAppointmentForm(SchedulerControl control, Appointment apt) {
            InitializeComponent();

            if (control == null || apt == null)
                throw new ArgumentNullException("control");
            if (control == null || apt == null)
                throw new ArgumentNullException("apt");

            this.control = control;
            this.controller = new CustomAppointmentFormController(control, apt);
            this.recurrenceVisualController = new RecurrenceVisualController(controller);
        }

        public SchedulerControl Control { get { return control; } }
        public CustomAppointmentFormController Controller { get { return controller; } }
        public RecurrenceVisualController RecurrenceVisualController { get { return recurrenceVisualController; } }
        public TimeZoneHelper TimeZoneHelper { get { return Controller.TimeZoneHelper; } }
        public bool ShouldShowRecurrence { get { return Appointment.Type == AppointmentType.Pattern 
                                                        && Controller.ShouldShowRecurrenceButton; } }

        private void Ok_button_Click(object sender, RoutedEventArgs e) {
            if (ShouldShowRecurrence)
                RecurrenceVisualController.ApplyRecurrence();
            Controller.ApplyChanges();
            SchedulerFormBehavior.Close(this, true);
        }
    }
}

    public class CustomAppointmentFormController : AppointmentFormController {
        public CustomAppointmentFormController(SchedulerControl control, Appointment apt)
            : base(control, apt) {
        }
    }

VB.NET

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows
Imports System.Windows.Controls
Imports DevExpress.Xpf.Scheduler
Imports DevExpress.XtraScheduler
Imports DevExpress.Xpf.Scheduler.UI

Namespace WpfApplication1

    Partial Public Class CustomAppointmentForm
        Inherits UserControl
        Private control_Renamed As SchedulerControl
        Private controller_Renamed As CustomAppointmentFormController
        Private recurrenceVisualController_Renamed As RecurrenceVisualController

        Public Sub New(ByVal control As SchedulerControl, ByVal apt As Appointment)
            InitializeComponent()

            If control Is Nothing OrElse apt Is Nothing Then
                Throw New ArgumentNullException("control")
            End If
            If control Is Nothing OrElse apt Is Nothing Then
                Throw New ArgumentNullException("apt")
            End If

            Me.control_Renamed = control
            Me.controller_Renamed = New CustomAppointmentFormController(control, apt)
            Me.recurrenceVisualController_Renamed = New RecurrenceVisualController(controller_Renamed)
        End Sub

        Public ReadOnly Property Control() As SchedulerControl
            Get
                Return control_Renamed
            End Get
        End Property
        Public ReadOnly Property Controller() As CustomAppointmentFormController
            Get
                Return controller_Renamed
            End Get
        End Property
        Public ReadOnly Property RecurrenceVisualController() As RecurrenceVisualController
            Get
                Return recurrenceVisualController_Renamed
            End Get
        End Property
        Public ReadOnly Property TimeZoneHelper() As TimeZoneHelper
            Get
                Return Controller.TimeZoneHelper
            End Get
        End Property
        Public ReadOnly Property ShouldShowRecurrence() As Boolean
            Get
                Return Appointment.Type = AppointmentType.Pattern AndAlso Controller.ShouldShowRecurrenceButton
            End Get
        End Property

        Private Sub Ok_button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
            If ShouldShowRecurrence Then
                RecurrenceVisualController.ApplyRecurrence()
            End If
            Controller.ApplyChanges()
            SchedulerFormBehavior.Close(Me, True)
        End Sub
    End Class
End Namespace

Public Class CustomAppointmentFormController
    Inherits AppointmentFormController
    Public Sub New(ByVal control As SchedulerControl, ByVal apt As Appointment)
        MyBase.New(control, apt)
    End Sub
End Class

XAML

<dxsch:RecurrenceRangeControl RecurrenceInfo="{Binding RecurrenceVisualController.RecurrenceInfo}"
                              Pattern="{Binding Controller.PatternCopy}"
                              TimeZoneHelper="{Binding Path=TimeZoneHelper, Mode=OneTime}"
                              Visibility="{Binding ShouldShowRecurrence, Converter={dxschint:BoolToVisibilityConverter}}"/>

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

ContentControl

UserControl

RecurrenceRangeControl