TP2WFullCalendar

A Delphi wrapper for FullCalendar.io, the most popular JavaScript calendar.

Properties

property	description
Date	the calendar's current date
Events	one or more TP2WFullCalendarEvents that appear on your calendar
FirstDay	the day that each week begins. possible values are: Locale (default, causes locale-specific calculation to be used) or ISO (causes ISO-8601 week numbers to be used) or Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday
HeaderToolbar	defines the TP2WFullCalendarToolbarButtons and title at the top of the calendar
FooterToolbar	defines the TP2WFullCalendarToolbarButtons at the bottom of the calendar
Options	please see: TP2WFullCalendarOptions
View	the current view. defaults to DayGridMonth

Methods

method	description
IncDate	moves the calendar forward/backward an arbitrary amount of time.
Next	moves the calendar one step forward (by a month or week for example).
NextYear	moves the calendar forward one year.
Prev	moves the calendar one step back (by a month or week for example).
PrevYear	moves the calendar back one year.
Today	moves the calendar to the current date.

Events

event	description
OnDateClick	Triggered when the user clicks on a date or a time. The following arguments are included with the event:
	date	clicked day/time.
	allDay	true or false whether the click happened on an all-day cell.
	element	an HTML element that represents the whole-day that was clicked on.
	event	the native JavaScript event with low-level information such as click coordinates.
	view	the current calendar view.
OnEventClick	Triggered when the user clicks an event. The following arguments are included with the event:
	item	the associated event item.
	element	the HTML element for this event.
	event	the native JavaScript event with low-level information such as click coordinates.
	view	the current calendar view.
OnEventMouseEnter	Triggered when the user mouses over an event. Includes the same arguments as OnEventClick.
OnEventMouseLeave	Triggered when the user mouses out of an event. Includes the same arguments as OnEventClick.
OnGetLanguageCode	You can respond to this event with a (two-letter) ISO-639-1 language code, for example "en" or "nl" or "de".
OnNavLinkDayClick	Determines what happens when the user clicks on a day heading hyperlink. Includes a TDateTime argument. Note: when OnNavLinkDayClick fires, the OnDateClick event will NOT be fired.
OnNavLinkWeekClick	Determines what happens when the user clicks on a week-number hyperlink. Includes a TDateTime argument for the 1st day of the week.
OnSelect	Triggered when a date/time selection is made. The following arguments are included with the event:
	start	a date indicating the beginning of the selection.
	end	a date indicating the end of the selection.
	allDay	true or false whether the selection happened on all-day cells.
	event	the native JavaScript event with low-level information such as click coordinates.
	view	the current calendar view.
OnUnselect	Triggered when the current selection is cleared.
OnDateRangeChange	Called after the calendar’s date range has been initially set or changed in some way. The following arguments are included with the event:
	start	a date for the beginning of the range the calendar needs events for.
	end	a date for the end of the range the calendar needs events for. note: this value is exclusive.
	startStr	an ISO8601 string representation of the start date.
	endStr	just like startStr, but for the end date.
	view	the current calendar view.

TP2WFullCalendarEvent

property	description
ID	Unique identifier. See also: TP2WFullCalendarEvents.EventById
GroupID	Events that share a GroupId will be dragged and resized together automatically.
AllDay	Determines if the event is shown in the "all-day" section of relevant views. In addition, if true the time text is not displayed with the event.
Start	When an event begins.
End	When an event ends.
Title	The text that will appear on the event.
URL	A URL that will be visited when this event is clicked by the user.
Background	Determines if the event appears as background highlight.
Visible	Determines whether the event appears in the calendar.
Overlap	If false, prevents this event from being dragged/resized over other events. Also prevents other events from being dragged/resized over this event.
Color	Sets the event's background and border color.
TextColor	Sets the event’s text color.
Hint	The text that appears in a tooltip when the user moves the mouse over the event.
CssClassName	Determines what HTML className will be attached to the rendered event.

TP2WFullCalendarOptions

option	description
DayHeaders	Whether the day headers should appear. For the Month, TimeGrid, and DayGrid views.
FixedWeekCount	Determines the number of weeks displayed in a month view. If true, the calendar will always be 6 weeks tall. If false, the calendar will have either 4, 5, or 6 weeks, depending on the month.
NavLinks	Determines if day names and week names are clickable.
NowIndicator	Whether or not to display a marker indicating the current time (TimeGrid views only).
Selectable	Allows a user to highlight multiple days or timeslots by clicking and dragging.
ShowNonCurrentDates	In month view, whether dates in the previous or next month should be rendered at all.
Weekends	Whether to include Saturday/Sunday columns in any of the calendar views.
WeekNumbers	Determines if week numbers should be displayed on the calendar.

TP2WFullCalendarView

view	description
DayGridDay	displays a single day in a grid layout.
DayGridMonth	displays a month in a grid layout.
DayGridWeek	displays a week in a grid layout.
DayGridYear	displays a year in a grid layout.
ListDay	displays a list of events for a single day.
ListMonth	displays a list of events for a month.
ListWeek	displays a list of events for a week.
TimeGridDay	displays a single day with time slots (vertical layout).
TimeGridWeek	displays a week with time slots (vertical layout).

TP2WFullCalendarToolbarButton

button	description
tbTitle	text containing the current month/week/day
tbPrev	button for moving the calendar back one month/week/day
tbNext	button for moving the calendar forward one month/week/day
tbPrevYear	button for moving the calendar back one year
tbNextYear	button for moving the calendar forward one year
tbToday	button for moving the calendar to the current month/week/day
tbSpace	a small gap in between two buttons