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

Gravitybox Schedule Primer
Page 26 
1998-2004 Gravitybox Software LLC
objects within the collection. Included are search functions for locating particular
objects. Language support may be offered here as well.
Table 1.7
Providers Collection Definition
Add
This method takes parameters to create a new Provider
object and adds it to the Providers collection. A reference to
the newly created object is returned.
CaptionAvailable
This is the text that will appear above the Provider
AvailableTimes bars, in the left margin of the schedule. This
collection holds the valid times for which an appointment may
be scheduled, for a Provider. The default text is “Available”,
but it may be changed to anything desired.
CaptionScheduled
This is the text that will appear above the times for which a
Provider is scheduled. Each appointment associated with a
Provider will cause the provider to be scheduled for the
duration of the appointment. The default text is “Providers”,
but it may be changed to anything desired.
Clear
This method will remove all Provider objects.
Count
This method will return the number of elements in the
collection.
Exists
Given a Provider object’s name or index, this method will
return true if a Provider object exists at the specified position.
Index
This method is very similar to the Exists method only it
returns a number. Given a Provider object’s name or index,
this method returns its index. Though valid syntax, it is not
very useful to give the index in order to retrieve it. This
function was designed to take the Name property as a
parameter.
IsDirty
This property will determine if any modifications have
occurred, since the last time it was set to false. If any property
of any Provider object is modified this property is set to true.
Item
Given a Provider object’s name or index, this method will
return a reference to the object. If the given parameter does
not exist in the collection, an error is raised. To avoid an error,
use the Exists method in conjunction with this method.
Name
This is the text that will appear as the header for the provider
columns on the schedule. The default text is “Providers”, but
may be changed to any desired text.
NewIndex
This read-only property is the index of the newest object
added to the collection with the Add method. After the
Remove method is called, this property is reset to zero.
Remove
Given a valid Provider object’s index or name, this method
will remove the specified object.
Rename
This method will rename a Provider object. It takes a
http://www.purepage.com