RenderEvents Method (CalendarView Object)

The RenderEvents method renders the events in the Messages collection.

Syntax

strHTML = objCalendarView.RenderEvents( [varStartDate] [, varResponseObject] )

strHTML

On successful return, contains a string with the HTML hypertext representing the events. However, if the varResponseObject parameter is supplied, RenderEvents returns a value of Empty.

objCalendarView

Required. This CalendarView object.

varStartDate

Optional. Variant (vbDate format). The date/time used to determine the starting date from which to render events. The time portion of varStartDate is ignored. The default value is the current date.

varResponseObject

Optional. Object. An Active Server response object used to accumulate HTML output to send to the browser. This parameter is used primarily in ASP applications. If varResponseObject is not supplied, the output is written to strHTML.

Remarks

The RenderEvents method renders events starting with a date calculated from the varStartDate parameter, but not necessarily equal to its value. The rendering starts at the beginning of the time unit containing the varStartDate value. For example, if the calendar view's Mode property is set to CdoModeCalendarWeekly, the ContainerRenderer object's FirstDayOfWeek property is set to CdoSunday, and the value of varStartDate indicates a Friday, events are rendered starting with the preceding Sunday.

The RenderEvents method generates an HTML table containing one or more cells. If the Mode property is CdoModeCalendarDaily, the table contains the date being rendered in the first row and events for that day, if any, in subsequent rows.

If Mode is CdoModeCalendarWeekly, the table contains a single row with the starting and ending dates for the week being rendered. The starting date is calculated using the FirstDayOfWeek property. No events are rendered because there are no weekly events.

Events are rendered for the number of time units indicated by the NumberOfUnits property, beginning with the starting date calculated from the varStartDate parameter. If NumberOfUnits is greater than 1, each events table appears as a cell within an outer table. The outer table is a single row with NumberOfUnits columns.