See Also GraffitiCalendarEvent.
Enumerations
| Name | Values |
| Views | Month |
| MonthList |
| WeekAgenda |
| WeekBasic |
| WeekList |
| DayAgenda |
| DayBasic |
| DayList |
| YearList |
Constants
| Name | Type | Value |
| | | This class exposes no constants. |
Events
| Definition | Description |
| DayClick(theDay as Date, theView as GraffitiCalendar.Views) | Fired when the user clicks on a day in the calendar. |
| Deselected() | Fired when selected date is deselected. |
| EventChanged(theEvent as GraffitiCalendarEvent) | Fired when the user moves or resizes an event. |
| EventClick(theEvent as GraffitiCalendarEvent, theView as GraffitiCalendar.Views) | Fired when the user clicks on an existing event. |
| EventMouseOut(theEvent as GraffitiCalendarEvent, theView as GraffitiCalendar.Views) | Fired when the user's mouse exits an existing event. |
| EventMouseOver(theEvent as GraffitiCalendarEvent, theView as GraffitiCalendar.Views) | Fired when the user's mouse enters an existing event. |
| LanguagesLoaded() | Fired when the control has loaded all available languages. |
| Selected(theStart as Date, theEnd as Date, theView as GraffitiCalendar.Views) | Fired when a date or time range is selected. |
| UIReady() | Raised when loading has completed. |
| ViewChanged(View as GraffitiCalendar.Views, StartDate as Date, EndDate as Date) | Fired when the user switched the view using the toolbar. |
Methods
| Definition | Description |
| AddEvent(newEvent as GraffitiCalendarEvent) | Adds a new event to the calendar. |
| AddExternalSource(GoogleCalendarID as String, _ | Adds a Google Calendar to the display. |
| GoogleCalendarKey as String, _ |
| BGColor as Color = &c3a87ad, _ |
| BorderColor as Color = &c3a87ad, _ |
| TextColor as Color = &cFFFFFF) |
| DeselectAll() | Deselects all currently selected dates. |
| FindEvent(eventID as String) as GraffitiCalendarEvent | Returns an event object by the assigned ID. |
| FindEventIndex(theID as String) as Integer | Returns the integer index of an event object by the assigned ID. |
| ICSExport(Domain as String) as String | Returns all events in ICS format. |
| ICSImport(theICS as String) | Imports events in an ICS-formatted string. |
| LoaderHide() | Hides the loading spinner. |
| LoaderShow() | Shows a loading spinner that covers the entire component. |
| LoadTheme(themeURL as String) | Applies a jQuery UI theme to the calendar. |
| MoveNext() | Navigates to the next day/week/month in the display. |
| MoveNextYear() | Navigates to the next year. |
| MovePrev() | Navigates to the previous day/week/month in the display. |
| MovePrevYear() | Navigates to the previous year. |
| MoveToDate(theDate as Date) | Navigates to the defined date. |
| MoveToToday() | Resets the display to display the current date. |
| RefetchEvents() | Re-imports external event sources. |
| RemoveAllEvents() | Removes all events from the calendar. |
| RemoveEvent(theEvent as GraffitiCalendarEvent) | Removes the specified event from the calendar. |
| RemoveExternalSource(URL as String) | Removes an external source. |
| RerenderEvents() | Forces the display to update. |
| SelectDates(StartDate as Date, EndDate as Date = Nil) | Selects the specified date range. |
| UpdateEvent(theEvent as GraffitiCalendarEvent) | Updates an event in the calendar after changing properties of the Event object. |
Properties
| Name | Type | Default Value | Description |
| BackgroundColor | Color | &cFFFFFF | The background color of the display. |
| CalendarView | Views | MonthList | The current display style. |
| CustomTheme | Boolean | False | If True, uses the theme loaded by LoadTheme. |
| Editable | Boolean | True | If False, will not allow the user to move or resize events. |
| FirstDayOfWeek | Integer | -1 | First day of the week, -1 is the current locale default, 0-6 are Sunday through Saturday. |
| Language | String | “en” | The current view language. |
| Languages | String() | Nil | Array of supported languages. This should be, more or less, static. |
| ShowDayViewButton | Boolean | True | Shows the “Day” button on the display. |
| ShowLoaderOnEvents | Boolean | False | If true, the loading spinner will be shown to denote that the control is busy when communicating. |
| ShowMonthViewButton | Boolean | True | Shows the “Month” button on the display. |
| ShowNavButtons | Boolean | True | Shows the previous/next buttons for navigation. |
| ShowTitle | Boolean | True | Shows the title area which contains the current view's date range. |
| ShowTodayButton | Boolean | True | Shows a button allowing the user to quickly shift the view back to the current day. |
| ShowWeekViewButton | Boolean | True | Shows the “Week” button on the display. |
| ShowYearNavButtons | Boolean | True | Shows the previous/next year navigation buttons. |
| TextSize | Integer | 12 | The default base-line text size for the display. |
| UseXHR | Boolean | False | When True, will use XmlHttpRequests to return data rather than length-constrained packets. |
Examples
There are currently no examples for this class.
Changes to this Page
| Date | Edit | Editor |
| 08/04/2017 | Document Created | Anthony G. Cyphers |