WinForms Scheduler - Sort resources

This example shows how to create a comparer to sort Scheduler resources based on a specific condition (in this example, the Resource.Caption and the number of resource appointments).

The example also demonstrates how to prevent sorting ("ResourceNOfAppointments" mode) for an "Unassigned" resource. This resource is always displayed first.

The SchedulerStorageBase.ResourceCollectionLoaded event is handled to automaticcally sort resources when the underlying collection changes:

C#
private void schedulerStorage1_ResourceCollectionLoaded(object sender, System.EventArgs e) {  
    ApplySorting();  
}  

private void ApplySorting() {  
    IComparer<Resource> comparer = null;  
    if (CurrentSortOrder == ResourcesSortOrder.Ascending)  
        comparer = new ResourceCaptionComparer();  
    else if (CurrentSortOrder == ResourcesSortOrder.Descending)  
        comparer = new ResourceCaptionReverseComparer();  
    else if (CurrentSortOrder == ResourcesSortOrder.NOfAppointments)  
        comparer = new ResourceNOfAppointmentsComparer(schedulerStorage1);  
    else  
        return;  
    schedulerStorage1.Resources.Items.Sort(comparer);  
    schedulerControl1.ActiveView.LayoutChanged();  
}

Documentation

Resources for Appointments

Does this example address your development requirements/objectives?

(you will be redirected to DevExpress.com to submit your response)

Example Code

Comparers.cs(vb)

C#
VB.NET

C#
using System;
using System.Collections;
using System.Collections.Generic;
using DevExpress.XtraScheduler;

namespace SchedulerSortResources {
    public abstract class ResourceBaseComparer : IComparer<Resource>, IComparer {
        #region IComparer Members
        int IComparer.Compare(object x, object y) {
            return CompareCore(x, y);
        }
        public int Compare(Resource x, Resource y) {
            return CompareCore(x, y);
        }
        #endregion

        protected virtual int CompareCore(object x, object y) {
            Resource xRes = (Resource)x;
            Resource yRes = (Resource)y;
            
            if (xRes == null || yRes == null)
                return 0;
            if (ResourceEmpty.Resource.Equals(xRes) || ResourceEmpty.Resource.Equals(yRes))
                return 0;
            
            return CompareResources(xRes, yRes);
        }

        protected abstract int CompareResources(Resource xRes, Resource yRes);
    }

    public class ResourceCaptionComparer : ResourceBaseComparer {
        protected override int CompareResources(Resource xRes, Resource yRes) {
            return String.Compare(xRes.Caption, yRes.Caption);
        }
    }

    public class ResourceCaptionReverseComparer : ResourceBaseComparer {
        protected override int CompareResources(Resource xRes, Resource yRes) {
            return String.Compare(yRes.Caption, xRes.Caption);
        }
    }

    public class ResourceNOfAppointmentsComparer : ResourceBaseComparer {
        private SchedulerStorage schedulerStorage;

        public ResourceNOfAppointmentsComparer(SchedulerStorage schedulerStorage) {
            this.schedulerStorage = schedulerStorage;
        }

        protected override int CompareResources(Resource xRes, Resource yRes) {
            // "Unassigned" resource
            if (Convert.ToInt32(yRes.Id) == -1)
                return 1;
            
            // "Unassigned" resource
            if (Convert.ToInt32(xRes.Id) == -1)
                return -1;

            int order = schedulerStorage.Appointments.Items.FindAll(e => e.ResourceId.Equals(yRes.Id)).Count -
                schedulerStorage.Appointments.Items.FindAll(e => e.ResourceId.Equals(xRes.Id)).Count;

            if (order == 0)
                return schedulerStorage.Resources.Items.IndexOf(xRes) - schedulerStorage.Resources.Items.IndexOf(yRes);

            return order;
        }
    }
}

Visual Basic
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports DevExpress.XtraScheduler

Namespace SchedulerSortResources

    Public MustInherit Class ResourceBaseComparer
        Implements IComparer(Of Resource), IComparer

'#Region "IComparer Members"
        Private Function IComparer_Compare(ByVal x As Object, ByVal y As Object) As Integer Implements IComparer.Compare
            Return CompareCore(x, y)
        End Function

        Public Function Compare(ByVal x As Resource, ByVal y As Resource) As Integer Implements IComparer(Of Resource).Compare
            Return CompareCore(x, y)
        End Function

'#End Region
        Protected Overridable Function CompareCore(ByVal x As Object, ByVal y As Object) As Integer
            Dim xRes As Resource = CType(x, Resource)
            Dim yRes As Resource = CType(y, Resource)
            If xRes Is Nothing OrElse yRes Is Nothing Then Return 0
            If ResourceEmpty.Resource.Equals(xRes) OrElse ResourceEmpty.Resource.Equals(yRes) Then Return 0
            Return CompareResources(xRes, yRes)
        End Function

        Protected MustOverride Function CompareResources(ByVal xRes As Resource, ByVal yRes As Resource) As Integer
    End Class

    Public Class ResourceCaptionComparer
        Inherits ResourceBaseComparer

        Protected Overrides Function CompareResources(ByVal xRes As Resource, ByVal yRes As Resource) As Integer
            Return String.Compare(xRes.Caption, yRes.Caption)
        End Function
    End Class

    Public Class ResourceCaptionReverseComparer
        Inherits ResourceBaseComparer

        Protected Overrides Function CompareResources(ByVal xRes As Resource, ByVal yRes As Resource) As Integer
            Return String.Compare(yRes.Caption, xRes.Caption)
        End Function
    End Class

    Public Class ResourceNOfAppointmentsComparer
        Inherits ResourceBaseComparer

        Private schedulerStorage As SchedulerStorage

        Public Sub New(ByVal schedulerStorage As SchedulerStorage)
            Me.schedulerStorage = schedulerStorage
        End Sub

        Protected Overrides Function CompareResources(ByVal xRes As Resource, ByVal yRes As Resource) As Integer
            ' "Unassigned" resource
            If Convert.ToInt32(yRes.Id) = -1 Then Return 1
            ' "Unassigned" resource
            If Convert.ToInt32(xRes.Id) = -1 Then Return -1
            Dim order As Integer = schedulerStorage.Appointments.Items.FindAll(Function(e) e.ResourceId.Equals(yRes.Id)).Count - schedulerStorage.Appointments.Items.FindAll(Function(e) e.ResourceId.Equals(xRes.Id)).Count
            If order = 0 Then Return schedulerStorage.Resources.Items.IndexOf(xRes) - schedulerStorage.Resources.Items.IndexOf(yRes)
            Return order
        End Function
    End Class
End Namespace

Form1.cs(vb)

C#
VB.NET

C#
using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraScheduler;
using System.Collections.Generic;

namespace SchedulerSortResources {
    public partial class Form1 : Form {
        private DataModel dataModel = new DataModel();

        public ResourcesSortOrder CurrentSortOrder {
            get {
                return (ResourcesSortOrder)comboBox1.SelectedIndex;
            }
            set {
                comboBox1.SelectedIndex = (int)value;
            }
        }

        public Form1() {
            InitializeComponent();

            FillResources();
            CurrentSortOrder = ResourcesSortOrder.Ascending;
        }

        private void comboBox1_SelectedIndexChanged(object sender, System.EventArgs e) {
            if (CurrentSortOrder == ResourcesSortOrder.None)
                schedulerControl1.RefreshData();
            else
                ApplySorting();
        }

        private void schedulerStorage1_ResourceCollectionLoaded(object sender, System.EventArgs e) {
            ApplySorting();
        }

        private void AppointmentsModified(object sender, PersistentObjectsEventArgs e) {
            ApplySorting();
        }

        private void ApplySorting() {
            IComparer<Resource> comparer = null;

            if (CurrentSortOrder == ResourcesSortOrder.Ascending)
                comparer = new ResourceCaptionComparer();
            else if (CurrentSortOrder == ResourcesSortOrder.Descending)
                comparer = new ResourceCaptionReverseComparer();
            else if (CurrentSortOrder == ResourcesSortOrder.NOfAppointments)
                comparer = new ResourceNOfAppointmentsComparer(schedulerStorage1);
            else
                return;

            schedulerStorage1.Resources.Items.Sort(comparer);
            schedulerControl1.ActiveView.LayoutChanged();
        }

        private void FillResources() {
            string[] users = new string[] { "Peter Dolan", "Ryan Fischer", "Andrew Miller", "Tom Hamlett",
                                                        "Jerry Campbell", "Carl Lucas" };

            dataModel.Resources.AddResourcesRow("Unassigned", Color.DarkGray.ToArgb());

            for (int i = 0; i < users.Length; i++) {
                dataModel.Resources.AddResourcesRow(users[i], schedulerControl1.ResourceColorSchemas[i].Cell.ToArgb());
            }

            schedulerStorage1.Resources.ColorSaving = ColorSavingType.ArgbColor;
            schedulerStorage1.Resources.DataSource = dataModel;
        }

    }

    public enum ResourcesSortOrder {
        None = 0,
        Ascending = 1,
        Descending = 2,
        NOfAppointments = 3
    }
}

Visual Basic
Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraScheduler
Imports System.Collections.Generic

Namespace SchedulerSortResources

    Public Partial Class Form1
        Inherits Form

        Private dataModel As DataModel = New DataModel()

        Public Property CurrentSortOrder As ResourcesSortOrder
            Get
                Return CType(comboBox1.SelectedIndex, ResourcesSortOrder)
            End Get

            Set(ByVal value As ResourcesSortOrder)
                comboBox1.SelectedIndex = CInt(value)
            End Set
        End Property

        Public Sub New()
            InitializeComponent()
            FillResources()
            CurrentSortOrder = ResourcesSortOrder.Ascending
        End Sub

        Private Sub comboBox1_SelectedIndexChanged(ByVal sender As Object, ByVal e As System.EventArgs)
            If CurrentSortOrder = ResourcesSortOrder.None Then
                schedulerControl1.RefreshData()
            Else
                ApplySorting()
            End If
        End Sub

        Private Sub schedulerStorage1_ResourceCollectionLoaded(ByVal sender As Object, ByVal e As System.EventArgs)
            ApplySorting()
        End Sub

        Private Sub AppointmentsModified(ByVal sender As Object, ByVal e As PersistentObjectsEventArgs)
            ApplySorting()
        End Sub

        Private Sub ApplySorting()
            Dim comparer As IComparer(Of Resource) = Nothing
            If CurrentSortOrder = ResourcesSortOrder.Ascending Then
                comparer = New ResourceCaptionComparer()
            ElseIf CurrentSortOrder = ResourcesSortOrder.Descending Then
                comparer = New ResourceCaptionReverseComparer()
            ElseIf CurrentSortOrder = ResourcesSortOrder.NOfAppointments Then
                comparer = New ResourceNOfAppointmentsComparer(schedulerStorage1)
            Else
                Return
            End If

            schedulerStorage1.Resources.Items.Sort(comparer)
            schedulerControl1.ActiveView.LayoutChanged()
        End Sub

        Private Sub FillResources()
            Dim users As String() = New String() {"Peter Dolan", "Ryan Fischer", "Andrew Miller", "Tom Hamlett", "Jerry Campbell", "Carl Lucas"}
            dataModel.Resources.AddResourcesRow("Unassigned", Color.DarkGray.ToArgb())
            For i As Integer = 0 To users.Length - 1
                dataModel.Resources.AddResourcesRow(users(i), schedulerControl1.ResourceColorSchemas(i).Cell.ToArgb())
            Next

            schedulerStorage1.Resources.ColorSaving = ColorSavingType.ArgbColor
            schedulerStorage1.Resources.DataSource = dataModel
        End Sub
    End Class

    Public Enum ResourcesSortOrder
        None = 0
        Ascending = 1
        Descending = 2
        NOfAppointments = 3
    End Enum
End Namespace

Alessandro (DevExpress Support)

last modified 2 years ago

Modified: September 13, 2023 10:03 AM

Platform: WinForms

Product: XtraScheduler Suite

Disclaimer: The information provided on DevExpress.com and affiliated web properties (including the DevExpress Support Center) is provided "as is" without warranty of any kind. Developer Express Inc disclaims all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.

Confidential Information: Developer Express Inc does not wish to receive, will not act to procure, nor will it solicit, confidential or proprietary materials and information from you through the DevExpress Support Center or its web properties. Any and all materials or information divulged during chats, email communications, online discussions, Support Center tickets, or made available to Developer Express Inc in any manner will be deemed NOT to be confidential by Developer Express Inc. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.

WinForms Scheduler - Sort resources

Files to Review

Documentation

Does this example address your development requirements/objectives?

Example Code

Recently viewed tickets