How to: Access the Scheduler Control in Code

• Oct 25, 2023
• 3 minutes to read

To access the control in code, create a View Controller and override its OnActivated method. Set the Controller’s ViewController.TargetViewType property to ListView. This way the Controller is activated for List Views only.

ASP.NET Core Blazor

File:
YourApplicationName.Blazor.Server\Controllers\SchedulerController.cs.

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Scheduler.Blazor;
using DevExpress.ExpressApp.Scheduler.Blazor.Editors;
using DevExpress.Persistent.Base.General;

namespace YourApplicationName.Module.Controllers {
    public partial class SchedulerController : ObjectViewController<ListView, IEvent> {
        protected override void OnViewControlsCreated() {
            base.OnViewControlsCreated();
            if(View.Editor is SchedulerListEditor schedulerListEditor) {
                // Obtain an instance of the DxSchedulerModel type.
                schedulerListEditor.SchedulerModel.ActiveViewType = DevExpress.Blazor.SchedulerViewType.WorkWeek;
            }
        }
    }
}

For more information on how to access the Scheduler control in code, refer to the following examples:

• XAF - Create Custom Event and Resource Classes for XAF Scheduler.
• XAF - How to Display an Event with Custom Fields in a Scheduler List View.

Windows Forms

File:
YourApplicationName.Win\Controllers\SchedulerController.cs in solutions without the WinForms-specific module project. YourApplicationName.Module.Win\Controllers\SchedulerController.cs(.vb) in solutions with the WinForms-specific module project.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Scheduler.Win;
using DevExpress.Persistent.Base.General;
using DevExpress.XtraScheduler;
namespace YourApplicationName.Module.Controllers {
    public partial class SchedulerController : ObjectViewController<ListView, IEvent> {
        protected override void OnViewControlsCreated() {
            base.OnViewControlsCreated();
            if(View.Editor is SchedulerListEditor schedulerListEditor) {
                SchedulerControl scheduler = schedulerListEditor.SchedulerControl;
            }
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp.Scheduler.Win
Imports DevExpress.Persistent.Base.General
Imports DevExpress.XtraScheduler
'...
Partial Public Class SchedulerController
    Inherits ViewController

   '...
   Protected Overrides Sub OnActivated()
       MyBase.OnActivated()
       If View.ObjectTypeInfo.Implements(Of IEvent)() Then
          AddHandler View.ControlsCreated, AddressOf View_ControlsCreated
       End If
   End Sub
   Private Sub View_ControlsCreated(ByVal sender As Object, ByVal e As EventArgs)
      Dim view As ListView = CType(View, ListView)
      Dim listEditor As SchedulerListEditor = CType(view.Editor, SchedulerListEditor)
      Dim scheduler As SchedulerControl = listEditor.SchedulerControl
      ' Do what you want with the scheduler
   End Sub
  Protected Overrides Sub OnDeactivated()
      If View.ObjectTypeInfo.Implements(Of IEvent)() Then
          RemoveHandler View.ControlsCreated, AddressOf View_ControlsCreated
      End If
  End Sub
End Class

Note

If the CrossThreadFailure error occurs when you handle SchedulerControl events, set the control’s SchedulerOptionsBehavior.UseAsyncMode option to false.

For more information on how to access the Scheduler control in code, refer to the following examples:

• XAF - Create Custom Event and Resource Classes for XAF Scheduler.
• XAF - How to Display an Event with Custom Fields in a Scheduler List View.

ASP.NET Web Forms

File:
MySolution.Module.Web\Controllers\SchedulerController.cs(.vb).

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Scheduler.Web;
using DevExpress.Persistent.Base.General;
using DevExpress.Web.ASPxScheduler;

namespace YourApplicationName.Module.Controllers {
    public partial class SchedulerController : ObjectViewController<ListView, IEvent> {
        //...
        protected override void OnViewControlsCreated() {
            base.OnViewControlsCreated();
            if(View.Editor is ASPxSchedulerListEditor schedulerListEditor) {
                ASPxScheduler scheduler = schedulerListEditor.SchedulerControl;
            }
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp.Scheduler.Web
Imports DevExpress.Persistent.Base.General
Imports DevExpress.Web.ASPxScheduler
'... 
Partial Public Class SchedulerController
    Inherits ViewController
   '... 
   Protected Overrides Sub OnActivated()
       MyBase.OnActivated()
       If View.ObjectTypeInfo.Implements(Of IEvent)() Then
          AddHandler View.ControlsCreated, AddressOf View_ControlsCreated
       End If
   End Sub
   Private Sub View_ControlsCreated(ByVal sender As Object, ByVal e As EventArgs)
      Dim view As ListView = CType(View, ListView)
      Dim listEditor As ASPxSchedulerListEditor = CType(view.Editor, ASPxSchedulerListEditor)
      Dim scheduler As ASPxScheduler = listEditor.SchedulerControl
      ' Do what you want with the scheduler 
   End Sub
   Protected Overrides Sub OnDeactivated()
      If View.ObjectTypeInfo.Implements(Of IEvent)() Then
         RemoveHandler View.ControlsCreated, AddressOf View_ControlsCreated
      End If
      MyBase.OnDeactivated()
   End Sub
End Class