File Name
Syntax
CalendarDlgEvent(REF thisCal: CalendarRecord)
Parameters
thisCal - calendar record information containing startDate
Returns
1 = user accepted dialog
< 1 = user canceled dialog
Side Effects
This event is not meant to be used outside of calendar.kb
Description
Parent to actual calender window. Controls Next, Previous, and Goto date buttons.
Dialog Forms Called
.dfc[gotodate]
calendar.dfc[calendar]
File Name
Syntax
GetCentury(VAL thisDate: DATE): INTEGER
Parameters
thisDate - date for evaluation
Returns
century
Side Effects
None
Description
Given a date, returns the century.
Dialog Forms Called
None
File Name
Syntax
GetDayOfWeekIndex(VAL thisDate: DATE): INTEGER
Parameters
thisDate - date for evaluation
Returns
Day of week index: (0-6) when ZERO_BASED_DATE_INDEX = TRUE;
(1-7) when ZERO_BASED_DATE_INDEX = FALSE
Side Effects
None
Description
Given a date, returns the day of the week (integer).
Dialog Forms Called
None
File Name
Syntax
GetDayOfWeekNamed(VAL thisDate: DATE): STRING
Parameters
thisDate - date for evaluation
Returns
Name of the day of the week
Side Effects
None
Description
Given a date, returns the name of the day of the week.
Dialog Forms Called
None
File Name
Syntax
GetDayOfWeekNamedWithIndex(VAL index: INTEGER, VAL isZeroBased: BOOLEAN): STRING
Parameters
thisDate - date for evaluation
Returns
index - day of the week index
isZeroBased - if TRUE then index values are 0-6; if FALSE then index values are 1-7
Side Effects
None
Description
Given a day of the week index, return the day of the week name.
Dialog Forms Called
None
File Name
Syntax
GetDayOfYear(VAL thisDate: DATE): INTEGER
Parameters
thisDate - date for evaluation
Returns
Day of the year
Side Effects
None
Description
Given a date, returns the day of the year (integer).
Dialog Forms Called
None
File Name
Syntax
GetDaysLeftInYear(VAL thisDate: DATE): INTEGER
Parameters
thisDate - date for evaluation
Returns
Number of days left in year
Side Effects
None
Description
Given a date, returns the number of days left in the year.
Dialog Forms Called
None
File Name
Syntax
GetFullYear(VAL thisDate: DATE): INTEGER
Parameters
thisDate - date for evaluation
Returns
Full year
Side Effects
None
Description
Given a date, returns the full year.
Dialog Forms Called
None
File Name
Syntax
GetMonthNamed(VAL thisDate: DATE): STRING
Parameters
thisDate - date for evaluation
Returns
Name of month
Side Effects
None
Description
Given a date, returns the name of the month.
Dialog Forms Called
None
File Name
Syntax
GetMonthNumberOfDays(VAL d: DATE): INTEGER
Parameters
d - date for evaluation
Returns
Number of days in month
Side Effects
None
Description
Given a date, computes the number of days in the month.
Dialog Forms Called
None
File Name
Syntax
GetWeekOfYear(VAL thisDate: DATE): INTEGER
Parameters
thisDate - date for evaluation
Returns
Week of the year
Side Effects
None
Description
Given a date, returns the week of the year.
Dialog Forms Called
None
File Name
Syntax
GetWeeksLeftInYear(VAL thisDate: DATE): INTEGER
Parameters
thisDate - date for evaluation
Returns
Number of weeks left in year
Side Effects
None
Description
Given a date, returns the number of weeks left in the year.
Dialog Forms Called
None
File Name
Syntax
GotoDateEvent(REF gotoDate: DATE)
Parameters
gotoDate - date from user input
Returns
1 = user accepted dialog
< 1 = user canceled dialog
Side Effects
This event is not meant to be used outside of calendar.kb
Description
Gets date to jump to.
Dialog Forms Called
None
File Name
Syntax
InquireCalendar(VAL w: WINDOW, REF sDate: DATE): BOOLEAN
Parameters
thisDate - date for evaluation
Returns
w - parent window handle for calendar
sDate - date to display (today of unknown). Selected date return here.
Side Effects
None
Description
Displays calendar based on date passed in, or today if no date is given. Returns the date selected by user.
Dialog Forms Called
None
File Name
Syntax
InquireCalendarAuto(VAL w: WINDOW, VAL fieldName: STRING)
Parameters
w - parent window handle for calendar (same window with fieldName)
fieldName - dialog box field name to get and send date
Returns
None
Side Effects
None
Description
Displays calendar with date from field passed in, or today if no date is in the field. Inserts the date selected in field.
Dialog Forms Called
None
File Name
Syntax
InquireCalendarAutoParent(VAL parentW: WINDOW, VAL w: WINDOW, VAL fieldName: STRING)
Parameters
parentW - parent window handle for calendar
w - dialog window handle with fieldName
fieldName - dialog box field name to get and send date
Returns
None
Side Effects
None
Description
Displays calendar with date from field passed in, or today if no date is passed in field. Inserts the date selected in field.
Dialog Forms Called
None
File Name
Syntax
IsDateLeapYear(VAL d: DATE): BOOLEAN
Parameters
d - date for evaluation
Returns
TRUE, if date is leap year; FALSE, if date is not leap year
Side Effects
None
Description
Given date returns leap year value (TRUE or FALSE).
Dialog Forms Called
None
File Name
Syntax
IsLeapYear(VAL y: INTEGER): BOOLEAN
Parameters
y - year for evaluation
Returns
TRUE, if year is leap year; FALSE, if year is not leap year
Side Effects
None
Description
Given year returns leap year value (TRUE or FALSE).
Dialog Forms Called
None