Methods of the CALENDAR Object (Adelia Web Context)

GET_DATE_CLASS

Retrieves the name of the CSS class assigned to the rectangular box in which the "days" part of a date is displayed.

Syntax
CALL_METHOD CalendarObjectName GET_DATE_CLASS DateValue ClassName ReturnCode
Parameters
	DATE DateValue	Date for which the assigned CSS class is being retrieved (input parameter).
	ALPHA(128) ClassName	CSS class name (output parameter).
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 2 : Selected date not associated with a CSS class (no SET_DATE_CLASS call assigned a CSS class to the selected date).

GET_DATE_SELECTION

Retrieves the selectability of a particular date.

Syntax
CALL_METHOD CalendarObjectName GET_DATE_SELECTION DateValue isSelectable ReturnCode
Parameters
	DATE DateValue	Date for which the selectability is being retrieved (input parameter).
	BOOL isSelectable	Date selectability (output parameter).
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 2 : Selectability not specified for selected date (no SET_DATE_SELECTION call specified the selectability of the selected date).

GET_DATE_TOOLTIP

Retrieves the name of the CSS class and the tooltip text assigned to a particular date.

Syntax
CALL_METHOD CalendarObjectName GET_DATE_TOOLTIP DateValue TooltipClassName TooltipText ReturnCode
Parameters
	DATE DateValue	Date for which the tooltip information is being retrieved (input parameter).
	ALPHA(128) TooltipClassName	Name of the CSS class associated with the tooltip (output parameter).
	ALPHA(256) TooltipText	Tooltip text (output parameter).
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 2 : Selected date not associated with a tooltip (no SET_DATE_TOOLTIP call assigned a CSS class to the selected date).

SET_DATE_CLASS (for an individual date) (for an individual date)

Sets a CSS class for the rectangular box in which the "days" part of a date is displayed. This method can be used to customize a date, by changing its background color or font style, for example.

If the class defines a value for the color CSS attribute and a value has been assigned (whether during layout design or upon execution) to the DAYS_COLOR_CLASS, the definition of the color attribute MUST be followed by its !important.

Example:

.setClassDateToday {color : red !important ; }

Syntax
CALL_METHOD CalendarObjectName SET_DATE_CLASS DateValue ClassName ReturnCode
Parameters
	DATE DateValue	Date for which a CSS class is set (input parameter).
	ALPHA(128) ClassName	CSS class name (input parameter). Setting an empty string as the value cancels the effect of any previous calls for a particular date.
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred.

SET_DATE_CLASS (for an interval) (for an interval)

Sets a CSS class for the rectangular boxes in which the days in a date interval are displayed. This method can be used to customize dates, by changing their background color or font style, for example.

If the class defines a value for the color CSS attribute and a value has been assigned (whether during layout design or upon execution) to the DAYS_COLOR_CLASS, the definition of the color attribute MUST be followed by its !important.

Example:

.setClassDateToday {color : red !important ; }

Syntax
CALL_METHOD CalendarObjectName SET_DATE_CLASS StartDateValue EndDateValue ClassName ReturnCode
Parameters
	DATE StartDateValue	Start date of the interval for which a CSS class is being set (input parameter).
	DATE EndDateValue	End date of the interval for which a CSS class is being set (input parameter).
	ALPHA(128) ClassName	CSS class name (input parameter). Setting an empty string as the value cancels the effect of any previous calls for a particular date.
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 3 : The start date is later than the end date.

SET_DATE_CLASS (for an expression) (for an expression)

Sets a CSS class for the rectangular box in which the "days" part of a date or a set of dates determined by an expression is displayed. This method can be used to customize dates, by changing their background color or font style, for example.

If the class defines a value for the color CSS attribute and a value has been assigned (whether during layout design or upon execution) to the DAYS_COLOR_CLASS, the definition of the color attribute MUST be followed by its !important.

Example:

.setClassDateToday {color : red !important ; }

Syntax
CALL_METHOD CalendarObjectName SET_DATE_CLASS DateExpression ClassName ReturnCode
Parameters
	ALPHA(128) DateExpression	Specifies a date or a set of dates determined by an expression (input parameter). The expression uses the syntax YYYY-MM-DD, where YYYY represents a year, MM a month and DD a day. The possible values for YYYY are: a four-digit number (year), the string "A" (All years). The possible values for MM are: a one- or two-digit number (number of the month in the year, starting from 1), the string "A" (All months in the year). The possible values for DD are: a one- or two-digit number (number of the day of the month), the strings " MON", " TUE", " WED", " THU", " FRI", " SAT" or " SUN" (respectively representing all the Mondays, Tuesdays, Wednesdays, Thursdays, Fridays, Saturdays and Sundays in a month), the string "A" (All days in the month). Sample date expressions: "2018-1-05" : 5 January 2018, "2018-01-A" : period from 1 January 2018 to 31 January 2018, "2018-A-05" : 5th of every month in 2018, "2018-1-MON": every Monday in January 2018, "2018-A-A" : every day in 2018.
	ALPHA(128) ClassName	CSS class name (input parameter). Setting an empty string as the value cancels the effect of any previous calls for a particular date.
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 2 : Incorrect date expression syntax.

SET_DATE_SELECTION (for an individual date) (for an individual date)

Sets the selectability of an individual date.

By default, all dates between MIN_DATE and MAX_DATE can be selected by the user.

Syntax
CALL_METHOD CalendarObjectName SET_DATE_SELECTION DateValue isSelectable ReturnCode
Parameters
	DATE DateValue	Date for which the selectability is being set (input parameter).
	BOOL isSelectable	TRUE to authorize selection, Else FALSE. (Input parameter.)
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred.

SET_DATE_SELECTION (for an interval) (for an interval)

Sets the selectability of dates in a specified period.

By default, all dates between MIN_DATE and MAX_DATE can be selected by the user.

Syntax
CALL_METHOD CalendarObjectName SET_DATE_SELECTION StartDateValue EndDateValue isSelectable ReturnCode
Parameters
	DATE StartDateValue	Start date of the interval for which selectability is being set (input parameter).
	DATE EndDateValue	End date of the interval for which selectability is being set (input parameter).
	BOOL isSelectable	TRUE to authorize selection, Else FALSE. (Input parameter.)
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 3 : The start date is later than the end date.

SET_DATE_SELECTION (for an expression) (for an expression)

Sets the selectability of a date or set of dates determined by an expression.

By default, all dates between MIN_DATE and MAX_DATE can be selected by the user.

Syntax
CALL_METHOD CalendarObjectName SET_DATE_SELECTION DateExpression isSelectable ReturnCode
Parameters
	ALPHA(128) DateExpression	Specifies a date or a set of dates determined by an expression (input parameter). The expression uses the syntax YYYY-MM-DD, where YYYY represents a year, MM a month and DD a day. The possible values for YYYY are: a four-digit number (year), the string "A" (All years). The possible values for MM are: a one- or two-digit number (number of the month in the year, starting from 1), the string "A" (All months in the year). The possible values for DD are: a one- or two-digit number (number of the day of the month), the strings " MON", " TUE", " WED", " THU", " FRI", " SAT" or " SUN" (respectively representing all the Mondays, Tuesdays, Wednesdays, Thursdays, Fridays, Saturdays and Sundays in a month), the string "A" (All days in the month). Sample date expressions: "2018-1-05" : 5 January 2018, "2018-01-A" : period from 1 January 2018 to 31 January 2018, "2018-A-05" : 5th of every month in 2018, "2018-1-MON": every Monday in January 2018, "2018-A-A" : every day in 2018.
	BOOL isSelectable	TRUE to authorize selection, Else FALSE. (Input parameter.)
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 2 : Incorrect date expression syntax.

SET_DATE_TOOLTIP (for an individual date) (for an individual date)

Sets a tooltip for an individual date. The tooltip is displayed when the user moves the mouse pointer over the rectangular box in which the "days" part of the selected date is displayed. This method lets you enrich a date by linking text information to it.

Syntax
CALL_METHOD CalendarObjectName SET_DATE_TOOLTIP DateValue TooltipClassName TooltipText ReturnCode
Parameters
	DATE DateValue	Date for which a tooltip is being set (input parameter).
	ALPHA(128) TooltipClassName	Name of a CSS class associated with the tooltip. This class can be used to specify the border, background color, etc. (input parameter).
	ALPHA(256) TooltipText	Text used in the tooltip. The text can be in XHTML format, but without any Adelia Web Studio tags (input parameter).
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred.

SET_DATE_TOOLTIP (for an interval) (for an interval)

Sets a tooltip for the dates in a specified period. The tooltip is displayed when the user moves the mouse pointer over the rectangular box in which the "days" part of the selected dates is displayed. This method lets you enrich a date by linking text information to it.

Syntax
CALL_METHOD CalendarObjectName SET_DATE_TOOLTIP StartDateValue EndDateValue TooltipClassName TooltipText ReturnCode
Parameters
	DATE StartDateValue	Start date of the interval for which a tooltip is being set (input parameter).
	DATE EndDateValue	End date of the interval for which a tooltip is being set (input parameter).
	ALPHA(128) TooltipClassName	Name of a CSS class associated with the tooltip. This class can be used to specify the border, background color, etc. (input parameter).
	ALPHA(256) TooltipText	Text used in the tooltip. The text can be in XHTML format, but without any Adelia Web Studio tags (input parameter).
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 3 : The start date is later than the end date.

SET_DATE_TOOLTIP (for an expression) (for an expression)

Sets a tooltip for a date or set of dates determined by an expression. The tooltip is displayed when the user moves the mouse pointer over the rectangular box in which the "days" part of the selected dates is displayed. This method lets you enrich a date by linking text information to it.

Syntax
CALL_METHOD CalendarObjectName SET_DATE_TOOLTIP DateExpression TooltipClassName TooltipText ReturnCode
Parameters
	ALPHA(128) DateExpression	Specifies a date or a set of dates determined by an expression (input parameter). The expression uses the syntax YYYY-MM-DD, where YYYY represents a year, MM a month and DD a day. The possible values for YYYY are: a four-digit number (year), the string "A" (All years). The possible values for MM are: a one- or two-digit number (number of the month in the year, starting from 1), the string "A" (All months in the year). The possible values for DD are: a one- or two-digit number (number of the day of the month), the strings " MON", " TUE", " WED", " THU", " FRI", " SAT" or " SUN" (respectively representing all the Mondays, Tuesdays, Wednesdays, Thursdays, Fridays, Saturdays and Sundays in a month), the string "A" (All days in the month). Sample date expressions: "2018-1-05" : 5 January 2018, "2018-01-A" : period from 1 January 2018 to 31 January 2018, "2018-A-05" : 5th of every month in 2018, "2018-1-MON": every Monday in January 2018, "2018-A-A" : every day in 2018.
	ALPHA(128) TooltipClassName	Name of a CSS class associated with the tooltip. This class can be used to specify the border, background color, etc. (input parameter).
	ALPHA(256) TooltipText	Text used in the tooltip. The text can be in XHTML format, but without any Adelia Web Studio tags (input parameter).
	NUM_BIN_2 ReturnCode	Return code for the operation (output parameter). The possible return code values are: 0 : Operation completed successfully, 1 : An internal error occurred, 2 : Incorrect date expression syntax.

STOP_PERIODIC_EVT

Stops a periodic Adelia Web AJAX event from being triggered. This event must be an AJAX event (:AJAX parameter) with a defined timer (:TIMER parameter). If any identical processes are also pending processing (in the browser queue), they will be canceled.

Syntax
CALL_METHOD CalendarObjectName STOP_PERIODIC_EVT JSEvtName LineNo FormName
Parameters
	ALPHA(128) JSEvtName	Name of the Javascript event that triggered the Adelia event. E.g. ONCLICK, ONMOUSEOVER, ONKEYDOWN, etc.
	ALPHA(128) FormName	Name of the form that contains the object named ButtonObjectName to be taken into account. This parameter is optional. If it is not specified, the first form on the page is used. If the page is part of a page layout that also contains other forms, you must specify a form name in order to avoid any ambiguity.
Conditions for use		None.