CalendarView Object

Article
08/21/2009

CalendarView Object

Important The Collaboration Data Objects (CDO) 1.2.1 Rendering objects are not installed by or supported for use with Exchange Server 2003 or later.

The CalendarView object represents a view of a schedule calendar.

At a Glance

Specified in type library:	CDOHTML.DLL
First available in:	CDO Rendering Library version 1.2
Parent objects:	Views collection
Child objects:	Columns collection
Default property:	(none)

Properties

Name	Available since version	Type	Access
BusyCell	1.2	String	Read/write
BusyIndicator	1.2	String	Read/write
Categories	1.2	Long	Read/write
Class	1.2	Long	Read-only
Columns	1.2	Column object or Columns collection object	Read-only
DailyEventCell	1.2	String	Read/write
DailyTimeCell	1.2	String	Read/write
FreeBusinessCell	1.2	String	Read/write
FreeIndicator	1.2	String	Read/write
FreeNonBusinessCell	1.2	String	Read/write
Index	1.2	Long	Read-only
Interval	1.2	Long	Read/write
Mode	1.2	Long	Read/write
Name	1.2	String	Read-only
NumberOfUnits	1.2	Long	Read/write
OOFIndicator	1.2	String	Read/write
Parent	1.2	Views collection object	Read-only
Source	1.2	Long	Read-only
TentativeIndicator	1.2	String	Read/write
WeeklyAppointmentCell	1.2	String	Read/write
WeeklyHeadingCell	1.2	String	Read/write

Methods

Name	Available since version	Parameters
IsSameAs	1.2	varView as Object
RenderAppointments	1.2	(optional) varStartDate as Variant, (optional) varResponseObject as Object
RenderDateNavigator	1.2	(optional) varStartDate as Variant, (optional) varMonths as Variant, (optional) varResponseObject as Object
RenderEvents	1.2	(optional) varStartDate as Variant, (optional) varResponseObject as Object

Remarks

A calendar view is a specification of a calendar rendering for a Messages collection in a calendar folder. It is applied to AppointmentItem objects in a Messages collection obtained from a Folder object reserved for calendar data:

    Dim objSession As Session
    Dim objCalendarFolder As Folder
    Dim objAppointments As Messages

    Set objCalendarFolder = objSession.GetDefaultFolder _
                                       (CdoDefaultFolderCalendar)
    Set objAppointments = objCalendarFolder.Messages

The Messages collection obtained in this manner should contain AppointmentItem objects exclusively. If presented with objects of other classes, the calendar view's rendering methods attempt to render them as if they were appointments, but unexpected results are likely. In any case, objects not exposing the StartTime and EndTime properties are not rendered.

The calendar view is applied to the collection in the context of a ContainerRenderer. The container renderer specifies the Messages collection in its DataSource property and the calendar view to be applied in its CurrentView property.

The calendar view inherits all the functionality of the TableView object, and has additional capability specific to rendering a calendar as a table.

The HTML output of a calendar view is constructed on a principal unit of display, or time unit, which is specified by the view's Mode property. The time unit can be a day or a week. The view's time span, determined by its NumberOfUnits property, represents the total amount of calendar time displayed in a single HTML page. Each column of the view covers exactly one day, no matter what the overall time unit and time span have been set to. A column is subdivided into individual cells or time slots. The size of these subdivisions is controlled by the view's Interval property.

A calendar view is normally generated externally to a CDO application, although a nonpersistent calendar view can be created with the Add method of the Views collection. A calendar view created in this way ceases to exist when the collection is released.

CalendarView Object