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

Gravitybox Schedule Primer
Page 24 
1998-2004 Gravitybox Software LLC
Table 1.5
Categories Collection Definition
Add
This method takes parameters to create a new Category object
and adds it to the Categories collection. A reference to the newly
created object is returned.
Clear
This method will remove all of the Category objects from the
collection.
Count
This method will return the number of elements in the collection.
Exists
Given a Category object’s name or index, this method will return
true if a Category object exists at the specified position.
Index
This method is very similar to the Exists method only it returns a
number. Given a Category 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
Category object is modified, this property is set to true.
Item
Given a Category 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 category bar header on the
schedule. The default text is “Categories”, 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 Category object’s index or name, this method will
remove the specified object.
Rename
This method will rename a Category object. It takes a parameter of
an existing object’s index or name and the new name to give the
object. If the new name already belongs to another Category
object, an error is raised.
Providers
Another important collection of the GbSchedule is the Providers collection. This
collection represents a group of people who provide services for appointments. This is
very useful when an appointment needs to be assigned to a person. This also aids in
resource management. It allows for a provider to view a schedule and know the times of
his responsibilities. Since there are color-coded bars in the left margin, the provider may
view a schedule and know by his colored bar when he must work and when he is free.
http://www.purepage.com