Collection of Custom Objects

• Dec 17, 2020
• 7 minutes to read

ASPxScheduler can be bound to a collection of custom objects. The following code demonstrates how to implement a custom appointment object.

Note

The collection of custom objects must implement the IBindingList interface. An object exposing a simple IList interface can also be used as a data source, although you are advised against using List objects, since this approach may cause problems. For example, the IPersistentObject.GetRow method will return the DataRowView instead of the original object.

Note

Do not implement a property in your custom object that returns a collection. You should implement a container class that has a property to get and set the collection and use this class in the corresponding custom object property instead.

This code snippet implements the object data source used for binding to the ASPxScheduler. Note that while other properties of a custom object are mapped in the application to regular appointment properties, the Price and ContactInfo fields should be mapped to appointment’s PersistentObject.CustomFields.

View Example

CustomEvents.cs

[Serializable]
public class CustomEvent {
    object id;
    DateTime start;
    DateTime end;
    string subject;
    int status;
    string description;
    long label;
    string location;
    bool allday;
    int eventType;
    string recurrenceInfo;
    string reminderInfo;
    object ownerId;
    double price;
    string contactInfo;

    public CustomEvent() {
    }

    public DateTime StartTime { get { return start; } set { start = value; } }
    public DateTime EndTime { get { return end; } set { end = value; } }
    public string Subject { get { return subject; } set { subject = value; } }
    public int Status { get { return status; } set { status = value; } }
    public string Description { get { return description; } set { description = value; } }
    public long Label { get { return label; } set { label = value; } }
    public string Location { get { return location; } set { location = value; } }
    public bool AllDay { get { return allday; } set { allday = value; } }
    public int EventType { get { return eventType; } set { eventType = value; } }
    public string RecurrenceInfo { get { return recurrenceInfo; } set { recurrenceInfo = value; } }
    public string ReminderInfo { get { return reminderInfo; } set { reminderInfo = value; } }
    public object OwnerId { get { return ownerId; } set { ownerId = value; } }
    public object Id { get { return id; } set { id = value; } }
    public double Price { get { return price; } set { price = value; } }
    public string ContactInfo { get { return contactInfo; } set { contactInfo = value; } }
}
[Serializable]
public class CustomEventList : BindingList<CustomEvent> {
    public void AddRange(CustomEventList events) {
        foreach(CustomEvent customEvent in events)
            this.Add(customEvent);
    }
    public int GetEventIndex(object eventId) {
        for(int i = 0; i < Count; i++)
            if(this[i].Id == eventId)
                return i;
        return -1;
    }
}

public class CustomEventDataSource {
    CustomEventList events;
    public CustomEventDataSource(CustomEventList events) {
        if(events == null)
            DevExpress.XtraScheduler.Native.Exceptions.ThrowArgumentNullException("events");
        this.events = events;
    }
    public CustomEventDataSource()
        : this(new CustomEventList()) {
    }
    public CustomEventList Events { get { return events; } set { events = value; } }
    public int Count { get { return Events.Count; } }

    #region ObjectDataSource methods
    public object InsertMethodHandler(CustomEvent customEvent) {
        Object id = customEvent.GetHashCode();
        customEvent.Id = id;
        Events.Add(customEvent);
        return id;
    }
    public void DeleteMethodHandler(CustomEvent customEvent) {
        int eventIndex = Events.GetEventIndex(customEvent.Id);
        if(eventIndex >= 0)
            Events.RemoveAt(eventIndex);
    }
    public void UpdateMethodHandler(CustomEvent customEvent) {
        int eventIndex = Events.GetEventIndex(customEvent.Id);
        if(eventIndex >= 0) {
            Events.RemoveAt(eventIndex);
            Events.Insert(eventIndex, customEvent);
        }
    }
    public IEnumerable SelectMethodHandler() {
        CustomEventList result = new CustomEventList();
        result.AddRange(Events);
        return result;
    }
    #endregion

    public object ObtainLastInsertedId() {
        if(Count < 1)
            return null;
        return Events[Count - 1].Id;
    }
}

CustomEvents.vb

<Serializable> _
Public Class CustomEvent
    Private _id As Object
    Private _start As DateTime
    Private _end As DateTime
    Private _subject As String
    Private _status As Integer
    Private _description As String
    Private _label As Long
    Private _location As String
    Private _allday As Boolean
    Private _eventType As Integer
    Private _recurrenceInfo As String
    Private _reminderInfo As String
    Private _ownerId As Object
    Private _price As Double
    Private _contactInfo As String

    Public Sub New()
    End Sub

    Public Property StartTime() As DateTime
        Get
            Return _start
        End Get
        Set(ByVal value As DateTime)
            _start = value
        End Set
    End Property
    Public Property EndTime() As DateTime
        Get
            Return _end
        End Get
        Set(ByVal value As DateTime)
            _end = value
        End Set
    End Property
    Public Property Subject() As String
        Get
            Return _subject
        End Get
        Set(ByVal value As String)
            _subject = value
        End Set
    End Property
    Public Property Status() As Integer
        Get
            Return _status
        End Get
        Set(ByVal value As Integer)
            _status = value
        End Set
    End Property
    Public Property Description() As String
        Get
            Return _description
        End Get
        Set(ByVal value As String)
            _description = value
        End Set
    End Property
    Public Property Label() As Long
        Get
            Return _label
        End Get
        Set(ByVal value As Long)
            _label = value
        End Set
    End Property
    Public Property Location() As String
        Get
            Return _location
        End Get
        Set(ByVal value As String)
            _location = value
        End Set
    End Property
    Public Property AllDay() As Boolean
        Get
            Return _allday
        End Get
        Set(ByVal value As Boolean)
            _allday = value
        End Set
    End Property
    Public Property EventType() As Integer
        Get
            Return _eventType
        End Get
        Set(ByVal value As Integer)
            _eventType = value
        End Set
    End Property
    Public Property RecurrenceInfo() As String
        Get
            Return _recurrenceInfo
        End Get
        Set(ByVal value As String)
            _recurrenceInfo = value
        End Set
    End Property
    Public Property ReminderInfo() As String
        Get
            Return _reminderInfo
        End Get
        Set(ByVal value As String)
            _reminderInfo = value
        End Set
    End Property
    Public Property OwnerId() As Object
        Get
            Return _ownerId
        End Get
        Set(ByVal value As Object)
            _ownerId = value
        End Set
    End Property
    Public Property Id() As Object
        Get
            Return _id
        End Get
        Set(ByVal value As Object)
            _id = value
        End Set
    End Property
    Public Property Price() As Double
        Get
            Return _price
        End Get
        Set(ByVal value As Double)
            _price = value
        End Set
    End Property
    Public Property ContactInfo() As String
        Get
            Return _contactInfo
        End Get
        Set(ByVal value As String)
            _contactInfo = value
        End Set
    End Property
End Class
<Serializable> _
Public Class CustomEventList
    Inherits BindingList(Of CustomEvent)
    Public Sub AddRange(ByVal events As CustomEventList)
        For Each customEvent As CustomEvent In events
            Me.Add(customEvent)
        Next customEvent
    End Sub
    Public Function GetEventIndex(ByVal eventId As Object) As Integer
        For i As Integer = 0 To Count - 1
            If Me(i).Id Is eventId Then
                Return i
            End If
        Next i
        Return -1
    End Function
End Class

Public Class CustomEventDataSource
    Private events_Renamed As CustomEventList
    Public Sub New(ByVal events As CustomEventList)
        If events Is Nothing Then
            DevExpress.XtraScheduler.Native.Exceptions.ThrowArgumentNullException("events")
        End If
        Me.events_Renamed = events
    End Sub
    Public Sub New()
        Me.New(New CustomEventList())
    End Sub
    Public Property Events() As CustomEventList
        Get
            Return events_Renamed
        End Get
        Set(ByVal value As CustomEventList)
            events_Renamed = value
        End Set
    End Property
    Public ReadOnly Property Count() As Integer
        Get
            Return Events.Count
        End Get
    End Property

    #Region "ObjectDataSource methods"
    Public Function InsertMethodHandler(ByVal customEvent As CustomEvent) As Object
        Dim id As Object = customEvent.GetHashCode()
        customEvent.Id = id
        Events.Add(customEvent)
        Return id
    End Function
    Public Sub DeleteMethodHandler(ByVal customEvent As CustomEvent)
        Dim eventIndex As Integer = Events.GetEventIndex(customEvent.Id)
        If eventIndex >= 0 Then
            Events.RemoveAt(eventIndex)
        End If
    End Sub
    Public Sub UpdateMethodHandler(ByVal customEvent As CustomEvent)
        Dim eventIndex As Integer = Events.GetEventIndex(customEvent.Id)
        If eventIndex >= 0 Then
            Events.RemoveAt(eventIndex)
            Events.Insert(eventIndex, customEvent)
        End If
    End Sub
    Public Function SelectMethodHandler() As IEnumerable
        Dim result As New CustomEventList()
        result.AddRange(Events)
        Return result
    End Function