Class ScheduleAppointmentList

Maintains collection of IScheduleAppointments that serves as the data for the Schedule Control.

Inheritance

System.Object

ScheduleAppointmentList

ArrayListAppointmentList

Implements

IScheduleAppointmentList

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

Namespace: Syncfusion.Schedule

Assembly: Syncfusion.Schedule.Base.dll

Syntax

public class ScheduleAppointmentList : Object, IScheduleAppointmentList, IList, ICollection, IEnumerable

Remarks

This class is a wrapper class for an ArrayList and implements IComparer which orders the list by the item's StartTime. If two items start at the same time, then the EndTime is used as well to determine the order.

Constructors

ScheduleAppointmentList()

Initializes a new instance of the ScheduleAppointmentList class.

Declaration

public ScheduleAppointmentList()

Properties

Count

Gets the number of IScheduleAppointments in this list.

Declaration

public virtual int Count { get; }

Property Value

Type
System.Int32

Item[Int32]

Gets or sets the i-th IScheduleAppointment in this list.

Declaration

public virtual IScheduleAppointment this[int i] { get; set; }

Parameters

Type	Name	Description
System.Int32	i	The index to identify the desired ScheduleAppointment.

Property Value

Type
IScheduleAppointment

List

Gets or sets list can be serialized in derived classes.

Declaration

protected ArrayList List { get; set; }

Property Value

Type
System.Collections.ArrayList

Methods

Add(IScheduleAppointment)

Adds an IScheduleAppointment to this list.

Declaration

public virtual void Add(IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleAppointment	item	The IScheduleAppointment to be added.

Contains(IScheduleAppointment)

Determines whether the collection contains the specified item.

Declaration

public bool Contains(IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleAppointment	item	A IScheduleAppointment to search for in the collection.

Returns

Type	Description
System.Boolean	true if the collection contains the specified item; otherwise, false.

Find(Int32)

Finds the item of the key passed in. Not implemented.

Declaration

public virtual IScheduleAppointment Find(int nUniqueID)

Parameters

Type	Name	Description
System.Int32	nUniqueID	The unique search key.

Returns

Type	Description
IScheduleAppointment	The found item.

GetEnumerator()

Gets the enumerator of the list.

Declaration

public IEnumerator GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	The iterator.

IndexOf(IScheduleAppointment)

Returns the position of the specified item within this list.

Declaration

public virtual int IndexOf(IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleAppointment	item	The search item.

Returns

Type	Description
System.Int32	The index in the list of the search item.

Insert(Int32, IScheduleAppointment)

Inserts an IScheduleAppointment into this list.

Declaration

public virtual void Insert(int index, IScheduleAppointment item)

Parameters

Type	Name	Description
System.Int32	index	The position in the list where the item is to be inserted.
IScheduleAppointment	item	The IScheduleAppointment to be inserted.

IsAreaAvailable(DateTime, DateTime)

Determine if any items of this collection overlap the schedule area.

Declaration

public virtual bool IsAreaAvailable(DateTime dtStart, DateTime dtEnd)

Parameters

Type	Name	Description
System.DateTime	dtStart	The start date
System.DateTime	dtEnd	The end date

Returns

Type	Description
System.Boolean	True, if items overlap schedule area; False otherwise.

IsAreaAvailable(DateTime, Double)

Determines if any items overlap the schedule area.

Declaration

public virtual bool IsAreaAvailable(DateTime dtStart, double nMinutes)

Parameters

Type	Name	Description
System.DateTime	dtStart	Start date
System.Double	nMinutes	Time interval

Returns

Type	Description
System.Boolean	True, if items overlap schedule area; False otherwise.

IsConflict(IScheduleAppointment)

Determines whether item has conflict with items of this collection.

Declaration

public virtual bool IsConflict(IScheduleAppointment appApp)

Parameters

Type	Name	Description
IScheduleAppointment	appApp	A IScheduleAppointment

Returns

Type	Description
System.Boolean	True, if the item is in conflict; False, otherwise.

NewScheduleAppointment()

Returns a default ScheduleAppointment.

Declaration

public virtual IScheduleAppointment NewScheduleAppointment()

Returns

Type	Description
IScheduleAppointment	New ScheduleAppointment.

NextAreaAvailable(DateTime, Int32)

Returns the next available slot after date.

Declaration

public virtual ScheduleAppointment NextAreaAvailable(DateTime dtStart, int nMinutes)

Parameters

Type	Name	Description
System.DateTime	dtStart	Start date
System.Int32	nMinutes	Time interval

Returns

Type	Description
ScheduleAppointment	Next available slot.

NextAreaAvailable(DateTime, Int32, Int32)

Returns the next available slot after date.

Declaration

public virtual ScheduleAppointment NextAreaAvailable(DateTime dtStart, int nMinutes, int nTimeStep)

Parameters

Type	Name	Description
System.DateTime	dtStart	Start date
System.Int32	nMinutes	Time interval
System.Int32	nTimeStep	Time step in minutes

Returns

Type	Description
ScheduleAppointment	Next available slot.

NextAreaAvailable(DateTime, Int32, Int32, DateTime, DateTime)

Returns the next available slot after date.

Declaration

public virtual ScheduleAppointment NextAreaAvailable(DateTime dtStart, int nMinutes, int nTimeStep, DateTime dtMinDate, DateTime dtMaxDate)

Parameters

Type	Name	Description
System.DateTime	dtStart	Start date
System.Int32	nMinutes	Time interval
System.Int32	nTimeStep	Time step in minutes
System.DateTime	dtMinDate	Schedule min date
System.DateTime	dtMaxDate	Schedule max date

Returns

Type	Description
ScheduleAppointment	Next available slot.

NextAreaAvailable(DateTime, Int32, Int32, DateTime, DateTime, Int32, Int32)

Returns the next available slot after date.

Declaration

public virtual ScheduleAppointment NextAreaAvailable(DateTime dtStart, int nMinutes, int nTimeStep, DateTime dtMinDate, DateTime dtMaxDate, int nDayStartHour, int nDayEndHour)

Parameters

Type	Name	Description
System.DateTime	dtStart	Start date
System.Int32	nMinutes	Time interval
System.Int32	nTimeStep	Time step in minutes
System.DateTime	dtMinDate	Schedule min date
System.DateTime	dtMaxDate	Schedule max date
System.Int32	nDayStartHour	Schedule day start hour
System.Int32	nDayEndHour	Schedule day end hour

Returns

Type	Description
ScheduleAppointment	Next available slot.

Remove(IScheduleAppointment)

Removes an IScheduleAppointment from this list.

Declaration

public virtual void Remove(IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleAppointment	item	The IScheduleAppointment to be removed.

RemoveAt(Int32)

Removes an IScheduleAppointment from this list.

Declaration

public virtual void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The position of the item to be removed.

SortStartTime()

Sorts this list on the IScheduleAppointment.StartTime property.

Declaration

public virtual void SortStartTime()

Implements

IScheduleAppointmentList

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable