CodeCharge Studio All ASP PHP Perl ColdFusion Java C#.NET VB.NET

Calendar Reference

Design-Time Properties

Property Description
Name The name of the form.
Connection The database connection to be used for information retrieval.
Data Source Type The type of data source or the method used to retrieve the data.
Data Source The database column, SQL Query or other expression the data is to be retrieved from.
Restricted Allow access only to authenticated and authorized users.
Type Type of the calendar, such as Annual, Quarterly, 3-Months, Monthly
Date Field Database field containing the date of the calendar event.
Date DB Format The database field format used with the date field.
Time Field Database field containing the time of the calendar event, if time is stored in a different field than the date.
Time DB Format The database field format used with the time field.
Show nearby days Whether to show days of the surrounding months if the 1st or last week of the month includes days of other months.
No of Columns The number of calendar columns.
Empty Weeks Specifies if an empty 6th week row should be added to monthly snapshots for months that span only 5 weeks.

Run-Time Properties (ASP)

Property Description
CurrentDate Specify the current day.
CurrentProcessingDate Retrieves the current processing date.
PrevProcessingDate Retrieves the previous processing date.
NextProcessingDate Retrieves the next processing date.
CalendarEvents Contains the calendar events.
CalendarStyles Contains the calendar styles.
CurrentStyle Specifies the style for the current processing block.
Visible Specifies whether the calendar should be shown.

Run-Time Properties (PHP)

Property Description
ComponentType Specify the type of component. Have value "Calendar" for Calendar component.
Parent Specifies parent container of an object, for example a record form for a textbox that is included within that form.
ComponentName Specify the name of report.
FirstWeekDay Specify first weekday for calendar.
CurrentDate Specify the currently shown date.
CurrentProcessingDate Current processing date.
PrevProcessingDate Previvous processing date.
NextProcessingDate Next processing date.
CalendarStyles Contains the calendar styles.
CurrentStyle Specifies the style for the current processing block.
Events Contains the calendar events.
Visible Specifies whether the calendar should be shown.

Methods (ASP)

Method Description
SetEvent Adds new event.
GetEvents Returns events for the current date.

Methods (Servlets & JSP)

Method Description
isVisible Specifies whether this control is to be shown.
setVisible Specifies whether this control or component should be shown.
getParent Retrieves the parent component that contains this control or component.
getCurrentStyle Returns the style (not style name) that will be applied to the current Calendar section.
setCurrentStyle Specifies the style (not style name) that will be applied to the current Calendar section. The method is used identically in the events.
getDateField Returns field name that points to the event's date. This field is required if datasource is defined and allows to link calendar days with events.
setDateField Specifies the field name pointing to the Event Date. This field is required if the Data Source is defined and allows to link events to the Calendar days.
hasNextItem Indicates if the next calendar item is available. This method can be used in the View mode only.
nextItem Returns the next calendar item if it is available. This method can be used in the View mode only.
getCurrentItem Returns the current calendar item if it is available.
getMonths Retrieves the number of the displayed months
setMonths Specifies the number of the displayed months
getMonthsInRow Returns the number of months in the calendar row for the yearly and quarterly calendars. If monthsInRows == 0 all months will be shown in one row.
setMonthsInRow Specifies the number of months in the calendar row for the yearly and quarterly calendars. If monthsInRows == 0 all months will be shown in one row.
getTimeField Returns the field name pointing to the Event Time. If 'null,' the calendar will retrieve the Event Time from the dateField field.
setTimeField Specifies the field name pointing to the Event Time. If 'null,' the calendar will retrieve the Event Time from the dateField field.
getVisualStyles Returns the map containing Styles that represent days of months, weeks, etc.
setVisualStyles Specifies the map containing Styles that represent days of months, weeks, etc.
getVisualStyle Returns the style with the specified name.
setVisualStyle Specifies the style with specified name to be used.
getCurrentProcessingDate Returns the currently processed date to be used in events.
getMonth Returns the month number to be shown. If it is not defined, the current month will be used.
getYear Returns the year to be shown. If it is not defined, the current year is used.
isShowOtherMonthsDays Returns 'true' if days of the neighbouring months should be shown, otherwise - 'false'.
setShowOtherMonthsDays Specifies whether days of the neighbouring months should be shown.

Run-Time Variable (CF.CFT)

Variable Description
CurrentDate Specifies the current day.
CurrentProcessingDate Retrieves the current processing date.
PrevProcessingDate Retrieves the previous processing date.
NextProcessingDate Retrieves the next processing date.
CalendarEvents Contains the calendar events.
CalendarStyles Contains the calendar styles.
CurrentStyle Specifies the style for the current processing block.
hide<control> Specifies whether the calendar should be shown.

Run-Time Properties (.NET)

Calendar Interface object (Controls.Calendar class)

Property Description
CurrentDate Gets or sets the current date.
DataSource Gets or sets a reference to data source bound to the form.
Date Gets or sets date active date for the current calendar.
Day Gets or sets the day part of active date.
Mode Gets or sets the mode of the current calendar component.
Month Gets or sets the month part of active date.
MonthsInRow Gets or sets the number of displaing months in one row.
ShowOtherMonthsDays Gets or sets the showing of dates from other monthes for current month.
Visible Specifies whether the calendar should be shown.
WeekDayFormat Gets or sets the format for displaying name of week days.
Year Gets or sets the month part of active date.

Calendar Model Layer

Property Description
errors This property keeps a reference to the formís errors NameValueCollection. It is used to collect error messages generated during the objectís execution.
<control name> For each control that is located within the form, a member property is created with the same name as the control.
<field name>GroupField For each group of report, the member property is created.


Calendar Data Provider

Property Description
<prefix><parameter name> For each unique parameter of the Data Source command, a member property is created with the prefix (according to the parameter source type) and parameter name (according to the parameter source).

See also

Calendar Navigator Reference


On-line, printable versions and updates