Command Factory Service

• Sep 20, 2023
• 3 minutes to read

The ISchedulerCommandFactoryService service allows you to replace default Scheduler commands inside the Bar and Ribbon UI.

View Example

1. Create a custom command class inherited from the default Scheduler command you want to replace. The Default Scheduler commands are stored in the DevExpress.XtraScheduler.Commands namespace. In the sample code below, a custom command derives from the SplitAppointmentOperationCommand class.

   C#

   public class CustomSplitAppointmentOperationCommand : SplitAppointmentOperationCommand
       {
           public CustomSplitAppointmentOperationCommand(ISchedulerCommandTarget target) : base(target) { }
           public CustomSplitAppointmentOperationCommand(SchedulerControl control) : base(control) { }
   
           private TimeSpan splitInterval = TimeSpan.FromMinutes(10);
           public TimeSpan SplitAppointmentCommandStep
           {
               get
               {
                   return splitInterval;
               }
               set
               {
                   splitInterval = value;
               }
           }
           protected override IOperation CreateOperation()
           {
               //TimeScaleCollection timeScales = CreateTimeScaleCollection();
               TimeScaleCollection timeScales = new TimeScaleCollection();
               timeScales.Add(new TimeScaleFixedInterval(SplitAppointmentCommandStep));
               return new SplitAppointmentOperation(SchedulerControl, timeScales, SchedulerControl.SelectedAppointments[0]);
           }
       }
   

   VB.NET

   Public Class CustomSplitAppointmentOperationCommand
       Inherits SplitAppointmentOperationCommand
   
           Public Sub New(ByVal target As ISchedulerCommandTarget)
               MyBase.New(target)
           End Sub
           Public Sub New(ByVal control As SchedulerControl)
               MyBase.New(control)
           End Sub
   
           Private splitInterval As TimeSpan = TimeSpan.FromMinutes(10)
           Public Property SplitAppointmentCommandStep() As TimeSpan
               Get
                   Return splitInterval
               End Get
               Set(ByVal value As TimeSpan)
                   splitInterval = value
               End Set
           End Property
           Protected Overrides Function CreateOperation() As IOperation
               'TimeScaleCollection timeScales = CreateTimeScaleCollection();
               Dim timeScales As New TimeScaleCollection()
               timeScales.Add(New TimeScaleFixedInterval(SplitAppointmentCommandStep))
               Return New SplitAppointmentOperation(SchedulerControl, timeScales, SchedulerControl.SelectedAppointments(0))
           End Function
   End Class
   

2. Create a custom class that implements the ISchedulerCommandFactoryService interface. This interface exposes the ISchedulerCommandFactoryService.CreateCommand method you should implement. This method identifies commands by IDs and initializes the corresponding command instances.

   C#

   public class CustomSchedulerCommandFactoryService : ISchedulerCommandFactoryService
       {
           readonly ISchedulerCommandFactoryService service;
           readonly SchedulerControl control;
   
           public CustomSchedulerCommandFactoryService(SchedulerControl control,
               ISchedulerCommandFactoryService service)
           {
               Guard.ArgumentNotNull(control, "control");
               Guard.ArgumentNotNull(service, "service");
               this.control = control;
               this.service = service;
           }
   
           #region ISchedulerCommandFactoryService Members
           //implement this method to create custom command instances
           public SchedulerCommand CreateCommand(SchedulerCommandId id)
           {
               //check the command id to return an instance of the correct class
               if (id == SchedulerCommandId.SplitAppointment)
               {
                   CustomSplitAppointmentOperationCommand cmd = new CustomSplitAppointmentOperationCommand(control);
                   cmd.SplitAppointmentCommandStep = TimeSpan.FromHours(12);
                   return cmd;
               }
               return service.CreateCommand(id);
           }
           #endregion
       }
   

   VB.NET

   Public Class CustomSchedulerCommandFactoryService
       Implements ISchedulerCommandFactoryService
   
           Private ReadOnly service As ISchedulerCommandFactoryService
           Private ReadOnly control As SchedulerControl
   
           Public Sub New(ByVal control As SchedulerControl, ByVal service As ISchedulerCommandFactoryService)
               Guard.ArgumentNotNull(control, "control")
               Guard.ArgumentNotNull(service, "service")
               Me.control = control
               Me.service = service
           End Sub
   
           #Region "ISchedulerCommandFactoryService Members"
           'implement this method to create custom command instances
           Public Function CreateCommand(ByVal id As SchedulerCommandId) As SchedulerCommand
               'check the command id to return a class instance
               If id Is SchedulerCommandId.SplitAppointment Then
                   Dim cmd As New CustomSplitAppointmentOperationCommand(control)
                   cmd.SplitAppointmentCommandStep = TimeSpan.FromHours(12)
                   Return cmd
               End If
               Return service.CreateCommand(id)
           End Function
           #End Region
   End Class
   

3. Call the SchedulerControl.RemoveService method to remove the default service from the SchedulerControl.Services collection, and use the SchedulerControl.AddService method to add the replacement service.

   C#

   private void Form1_Load(object sender, EventArgs e) {
               //...
               CustomSchedulerCommandFactoryService commandFactory =
               new CustomSchedulerCommandFactoryService(schedulerControl1, schedulerControl1.GetService<ISchedulerCommandFactoryService>());
               schedulerControl1.RemoveService(typeof(ISchedulerCommandFactoryService));
               schedulerControl1.AddService(typeof(ISchedulerCommandFactoryService), commandFactory);
           }
   

   VB.NET

   Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
               '...
               Dim commandFactory As New CustomSchedulerCommandFactoryService(schedulerControl1, schedulerControl1.GetService(Of ISchedulerCommandFactoryService)())
               schedulerControl1.RemoveService(GetType(ISchedulerCommandFactoryService))
               schedulerControl1.AddService(GetType(ISchedulerCommandFactoryService), commandFactory)
   End Sub