Interface IScheduleAppointment

Provides the functionality for individual schedule items.

Inherited Members

System.ICloneable.Clone()

System.IComparable.CompareTo(System.Object)

Namespace: Syncfusion.Schedule

Assembly: Syncfusion.Schedule.Base.dll

Syntax

public interface IScheduleAppointment : IComparable, ICloneable

Remarks

IScheduleAppointments must implement IComparable and ICloneable. IComparable is used to order the incidents in sorts so the items can be properly arranged in the schedule. ICloneable is also required to handle support for drag and drop in the ScheduleControl.

Properties

AllDay

Gets or sets a value indicating whether all day appointment or not.

Declaration

bool AllDay { get; set; }

Property Value

Type
System.Boolean

AllowClickable

Gets or sets a value indicating whether or not blocked appointment is allowed to click.

Declaration

bool AllowClickable { get; set; }

Property Value

Type
System.Boolean

AllowDrag

Gets or sets a value indicating whether or not an appointment is allowed to drag.

Declaration

bool AllowDrag { get; set; }

Property Value

Type
System.Boolean

AllowResize

Gets or sets a value indicating whether or not an appointment is allowed to resize and modify its duration.

Declaration

bool AllowResize { get; set; }

Property Value

Type
System.Boolean

BackColor

Gets or sets the appointment html element background color.

Declaration

Color BackColor { get; set; }

Property Value

Type
System.Drawing.Color

Content

Gets or sets a text displayed as the main content of this schedule item.

Declaration

string Content { get; set; }

Property Value

Type
System.String

CustomToolTip

Gets or sets associates ToolTip text with the appointment.

Declaration

string CustomToolTip { get; set; }

Property Value

Type
System.String

Dirty

Gets or sets a value indicating whether or not this items has been modified.

Declaration

bool Dirty { get; set; }

Property Value

Type
System.Boolean

EndTime

Gets or sets end time for this item.

Declaration

DateTime EndTime { get; set; }

Property Value

Type
System.DateTime

ForeColor

Gets or sets fore color of the appointment panel.

Declaration

Color ForeColor { get; set; }

Property Value

Type
System.Drawing.Color

IgnoreChanges

Gets or sets a value indicating whether or not changes to this item should be ignored.

Declaration

bool IgnoreChanges { get; set; }

Property Value

Type
System.Boolean

LabelValue

Gets or sets a categorizer value for this item.

Declaration

int LabelValue { get; set; }

Property Value

Type
System.Int32

LocationValue

Gets or sets some item dependent string-like the location of a meeting.

Declaration

string LocationValue { get; set; }

Property Value

Type
System.String

MarkerValue

Gets or sets categorizer value for this item.

Declaration

int MarkerValue { get; set; }

Property Value

Type
System.Int32

Owner

Gets or sets owner of this schedule item.

Declaration

int Owner { get; set; }

Property Value

Type
System.Int32

RecurringOnOverride

Gets or sets some item dependent string-like the location of a meeting.

Declaration

bool RecurringOnOverride { get; set; }

Property Value

Type
System.Boolean

Reminder

Gets or sets a value indicating whether or not some reminder action should be taken as this item becomes current.

Declaration

bool Reminder { get; set; }

Property Value

Type
System.Boolean

ReminderText

Gets or sets a remind text of this item.

Declaration

string ReminderText { get; set; }

Property Value

Type
System.String

ReminderValue

Gets or sets a remind value of this item.

Declaration

int ReminderValue { get; set; }

Property Value

Type
System.Int32

StartTime

Gets or sets a start time of this item.

Declaration

DateTime StartTime { get; set; }

Property Value

Type
System.DateTime

Subject

Gets or sets the subject or topic title for this schedule item.

Declaration

string Subject { get; set; }

Property Value

Type
System.String

Tag

Gets or sets an arbitrary object associated with this item.

Declaration

object Tag { get; set; }

Property Value

Type
System.Object

TimeSpanColor

Gets or sets a color of appointment time span element.

Declaration

Color TimeSpanColor { get; set; }

Property Value

Type
System.Drawing.Color

ToolTip

Gets or sets ToolTip text with the appointment.

Declaration

ScheduleAppointmentToolTip ToolTip { get; set; }

Property Value

Type
ScheduleAppointmentToolTip

UniqueID

Gets or sets a unique identifier for this schedule item.

Declaration

int UniqueID { get; set; }

Property Value

Type
System.Int32

Version

A read-only property that gets a version associated with the data schema for this item.

Declaration

int Version { get; }

Property Value

Type
System.Int32

Methods

IsConflict(IScheduleAppointment)

Determine whether item has conflict with other item.

Declaration

bool IsConflict(IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleAppointment	item	A IScheduleAppointment

Returns

Type	Description
System.Boolean	True if the item is in conflict.

IsConflict(DateTime, DateTime)

Determine whether item has conflict with other item.

Declaration

bool IsConflict(DateTime dtStart, DateTime dtEnd)

Parameters

Type	Name	Description
System.DateTime	dtStart	start time
System.DateTime	dtEnd	end time

Returns

Type	Description
System.Boolean	True if the item is in conflict.