Navigation bar
  Home Print document Start Previous page
 18 of 234 
Next page End  

Gravitybox Schedule Primer
Page 16 
1998-2004 Gravitybox Software LLC
Room
When the schedule is setup to display Rooms, only
appointments with a valid Room property will be displayed.
When the schedule is not displaying Rooms, this property is
not used.
StartDate
This property is the date on which the appointment will be
displayed. The valid date range is the MinDate property to
the MaxDate property.
StartTime
This property defines the time an appointment is to start.
Used in conjunction with the StartDate property, it determines
the position of the appointment on the schedule. If the
appointment is an event, this property has no genuine value.
Subject
This is text that may be used to identify an appointment.
Either the DisplayText or Subject may be used as the text
displayed on the schedule.
Tag
This is an extra string value that may be used to save some
additional information associated with this appointment
object. It is not used by the schedule for any purpose.
ToolTipText
This text is used to display a tooltip over an appointment
when the mouse is at rest over it. This is the default value for
the appointment’s tooltip. If this property is not specified, it’s
DisplayText or Subject property is used, depending on the
schedule’s ToolTipDisplay property.
UniqueKey
This read-only property is a unique 32-bit integer that
identifies this appointment from all the rest in the
ScheduleItems collection. When an appointment is added, a
unique key is generated and assigned to this property. It may
not be changed and will be different on every load. However,
the most important thing is that it never changes as long as
the schedule is loaded. Even if dragged to another window,
the appointment’s UniqueKey will not change. It is provided
to give the developer a way to uniquely identify an
appointment in a schedule session.
A change in many of these properties will result in a display change of the appointment
or the schedule. Some other properties of an appointment, though still important, are
not display related. A change in non-display properties will not result in a repaint of the
appointment or screen. They represent associated data that may be saved with an
appointment. An example of this is the Id or ItemData property.
Some of the more interesting properties include Alarm, BlackOut, MinLength, and
MaxLength. The Alarm property allows for the creation of applications that raise an
event, at the start of an appointment. The ScheduleItemStart event is raised to inform of
this happening. The index of the object in the ScheduleItems collection is returned, as a
parameter to this event. The following code display a message box at each
appointment’s starting time.
http://www.purepage.com