Class ScheduleAppointment

Implements the objects that represent appointments in the Schedule Control.

Inheritance
System.Object
ScheduleAppointment
ArrayListAppointment
Implements
System.IComparable
System.ICloneable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Schedule
Assembly: Syncfusion.Schedule.Base.dll
Syntax
public class ScheduleAppointment : IScheduleAppointment, IComparable, ICloneable
Remarks

This class implements IScheduleAppointment to provide an object to hold the concrete data associated with appointments. You can either derive this class or implement IScheduleAppointment yourself to extend or modify the information managed by the ScheduleAppointment class.

Constructors

ScheduleAppointment()

Initializes a new instance of the ScheduleAppointment class.

Declaration
public ScheduleAppointment()

Properties

AllDay

Gets or sets a value indicating whether this appointment is an all-day appointment.

Declaration
public virtual bool AllDay { get; set; }
Property Value
Type Description
System.Boolean

AllowClickable

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

Declaration
public bool AllowClickable { get; set; }
Property Value
Type Description
System.Boolean

AllowDrag

Gets or sets a value indicating whether or not an appointment is allowed to be dragged.The total hours doesn't gets changed by dragging an appointment.

Declaration
public bool AllowDrag { get; set; }
Property Value
Type Description
System.Boolean

Default is true.
Remarks

Setting this property to true enables moving an appointment by clicking on a appointment and moving it to a new place. The total duration of an Appointment is not altered by dragging.

AllowResize

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

Declaration
public bool AllowResize { get; set; }
Property Value
Type Description
System.Boolean

BackColor

Gets or sets back color of the appointment panel

Declaration
public Color BackColor { get; set; }
Property Value
Type Description
System.Drawing.Color

Blocked

Gets or sets a value indicating whether the block appointment is blocked.

Declaration
public virtual bool Blocked { get; set; }
Property Value
Type Description
System.Boolean

Content

Gets or sets a text string holding the details or comments for this appointment item.

Declaration
public virtual string Content { get; set; }
Property Value
Type Description
System.String

CustomToolTip

Gets or sets the custom tooltip text to be displayed for the item.

Declaration
public string CustomToolTip { get; set; }
Property Value
Type Description
System.String

Dirty

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

Declaration
public virtual bool Dirty { get; set; }
Property Value
Type Description
System.Boolean

EndTime

Gets or sets the end time for this item.

Declaration
public virtual DateTime EndTime { get; set; }
Property Value
Type Description
System.DateTime

ForeColor

Gets or sets fore color of the appointment panel.

Declaration
public Color ForeColor { get; set; }
Property Value
Type Description
System.Drawing.Color
Remarks

The default value of ForeColor property is Color.Black.

IgnoreChanges

Gets or sets a value indicating whether changes to this item affect the Dirty property.

Declaration
public virtual bool IgnoreChanges { get; set; }
Property Value
Type Description
System.Boolean

LabelValue

Gets or sets a integer categorizer value for this item.

Declaration
public virtual int LabelValue { get; set; }
Property Value
Type Description
System.Int32

LocationValue

Gets or sets a string associated with this item.

Declaration
public virtual string LocationValue { get; set; }
Property Value
Type Description
System.String

MarkerValue

Gets or sets a integer categorizer value for this item.

Declaration
public virtual int MarkerValue { get; set; }
Property Value
Type Description
System.Int32

NotifyOnOveride

Gets or sets a value indicating whether the block appointment is notify on overide.

Declaration
public bool NotifyOnOveride { get; set; }
Property Value
Type Description
System.Boolean

Owner

Gets or sets an integer that can be used to identify the owner (if any) of this item.

Declaration
public virtual int Owner { get; set; }
Property Value
Type Description
System.Int32

Priority

Gets or sets priority of the block appointment.

Declaration
public int Priority { get; set; }
Property Value
Type Description
System.Int32

RecurringOnOverride

Gets or sets a value indicating whether the block appointment is notify on overide.

Declaration
public bool RecurringOnOverride { get; set; }
Property Value
Type Description
System.Boolean

Reminder

Gets or sets a value indicating whether you want a reminder event raised when the StartTime of this item gets close.

Declaration
public virtual bool Reminder { get; set; }
Property Value
Type Description
System.Boolean

ReminderText

Gets or sets the type of reminder event raised when the StartTime of this item gets close.

Declaration
public virtual string ReminderText { get; set; }
Property Value
Type Description
System.String

ReminderValue

Gets or sets the type of reminder event raised when the StartTime of this item gets close.

Declaration
public virtual int ReminderValue { get; set; }
Property Value
Type Description
System.Int32

StartTime

Gets or sets the start time for this item.

Declaration
public virtual DateTime StartTime { get; set; }
Property Value
Type Description
System.DateTime

Subject

Gets or sets a text string identifying the topic of this item.

Declaration
public virtual string Subject { get; set; }
Property Value
Type Description
System.String

Tag

Gets or sets an arbitrary object associated with this item.

Declaration
public virtual object Tag { get; set; }
Property Value
Type Description
System.Object

TimeSpanColor

Gets or sets color of appointment time span element.

Declaration
public Color TimeSpanColor { get; set; }
Property Value
Type Description
System.Drawing.Color

ToolTip

Gets or sets the tooltip text to be displayed for the item.

Declaration
public ScheduleAppointmentToolTip ToolTip { get; set; }
Property Value
Type Description
ScheduleAppointmentToolTip

UniqueID

Gets or sets a unique integer associated with this item.

Declaration
public virtual int UniqueID { get; set; }
Property Value
Type Description
System.Int32

Version

Gets an integer format version number.

Declaration
public virtual int Version { get; }
Property Value
Type Description
System.Int32
Remarks

If you modify this class in a manner that changes its serialization, you should change the version number so there is a unique number that can be used to identify the serialization format.

Methods

Clone()

Creates a copy of this item; using MemberwiseClone.

Declaration
public object Clone()
Returns
Type Description
System.Object

A new instance of this item.

CompareTo(Object)

Implemented to check UniqueID property for equality.

Declaration
public int CompareTo(object obj)
Parameters
Type Name Description
System.Object obj

The object to compare this instance to.
Returns
Type Description
System.Int32

Zero if the objects have the same UniqueID. Nonzero otherwise.

ToString()

An Overridden method that returns a text representation of the appointment.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string holding the schedule appointment data.
Overrides
System.Object.ToString()

Implements

System.IComparable
System.ICloneable