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

Gravitybox Schedule Primer
Page 13 
1998-2004 Gravitybox Software LLC
Chapter 1
The GbSchedule Object Model
The Gravitybox Schedule has an extensive object model. It may seem complex at first
but is actually very intuitive. There are seven main collections. Each holds some part of
the information to be displayed on the screen.
ScheduleItems
The main collection and the one that you cannot live without
is the ScheduleItems collection. This is the group of
appointments for a schedule. In its simplest form each
object in the collection needs a starting time, date, and length. These three basic
properties are used to display an appointment at its proper position. Many other
properties are also available to define customized attributes of each object, but these
three are the necessary ones for an object to exist. If a schedule is defined as the
display of dates on one axis verses time on the other, then each one of these
ScheduleItem objects has a particular position on which to be placed.
Table 1.1
ScheduleItem Object Definition
Alarm
This property determines if the appointment should raise an
event at its StartTime. If this property is set, there is an icon
displayed in the upper, left corner of the appointment and the
ScheduleItemStart event is raised when the appointment’s
starting time comes due.
AlarmReminder
This property is used to fire the event ScheduleItemReminder
event some time before an appointment comes due. This is a
positive number of minutes. If the Alarm property is true, the
AlarmReminder number minutes is subtracted from the
appointment’s start time. If the calculated time is the current
time, this event is raised. This property basically allows you
to receive an event some time prior to an appointment
starting. This is useful for builder reminders that an
appointment is due in X minutes.
BackColor
This property allows for the specification of a custom
backcolor for the appointment. This may be useful, if you
want a particular appointment to stand out. When an
appointment is created, the backcolor is defaulted to white.
BlackOut
This property allows an appointment to be into a placeholder.
The BlackOutColor will determine the appointment’s color.
No text will be displayed on the appointment and the user
may not move, copy, or perform any operation on it.
Quick Tip
Appointments are stored in the
ScheduleItems collection.
http://www.purepage.com