Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
web:calendar [2019/06/14 20:21]
agcyphers [Examples]
web:calendar [2019/10/23 05:53] (current)
Line 10: Line 10:
 ==== Constants ==== ==== Constants ====
 ^ Name      ^ Type     ^ Value       ^ ^ Name      ^ Type     ^ Value       ^
-| ViewDayAgenda ​| [[http://​developer.xojo.com/​integer|Integer]] | 3 | +| ViewDayAgenda | Integer | 3 | 
-| ViewDayBasic ​| [[http://​developer.xojo.com/​integer|Integer]] | 4 | +| ViewDayBasic | Integer | 4 | 
-| ViewMonth ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | +| ViewMonth | Integer | 0 | 
-| ViewWeekAgenda ​| [[http://​developer.xojo.com/​integer|Integer]] | 1 | +| ViewWeekAgenda | Integer | 1 | 
-| ViewWeekBasic ​| [[http://​developer.xojo.com/​integer|Integer]] | 2 |+| ViewWeekBasic | Integer | 2 |
  
 ==== Events ==== ==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| DateSelected( DateStart as Date, DateEnd as Date = nil, StartTime as [[http://​developer.xojo.com/​boolean|Boolean]] = False, EndTime as [[http://​developer.xojo.com/​boolean|Boolean]] = False ) | Raised when the user clicks on a day/time on the calendar. |+| DateSelected( DateStart as Date, DateEnd as Date = nil, StartTime as Boolean = False, EndTime as Boolean = False ) | Raised when the user clicks on a day/time on the calendar. |
 | EventChanged( theEvent as GraffitiWebCalendarEvent ) | Fires when the user changes an event (such as by dragging). | | EventChanged( theEvent as GraffitiWebCalendarEvent ) | Fires when the user changes an event (such as by dragging). |
-| EventMouseEnter( theEvent as GraffitiWebCalendarEvent,​ X as [[http://​developer.xojo.com/​integer|Integer]], Y as [[http://​developer.xojo.com/​integer|Integer]] ) | Raised when the user moves their mouse in to an event. |+| EventMouseEnter( theEvent as GraffitiWebCalendarEvent,​ X as Integer, Y as Integer ) | Raised when the user moves their mouse in to an event. |
 | EventMouseLeave( theEvent as GraffitiWebCalendarEvent ) | Raised when the use moves their mouse out of an event. | | EventMouseLeave( theEvent as GraffitiWebCalendarEvent ) | Raised when the use moves their mouse out of an event. |
 | EventSelected( theEvent as GraffitiWebCalendarEvent ) | Raised when the user clicks an event. | | EventSelected( theEvent as GraffitiWebCalendarEvent ) | Raised when the user clicks an event. |
-| LanguagesLoaded( CalLanguages() as [[http://​developer.xojo.com/​string|String]] ) | This event is raised once the calendar has completely loaded the list of available languages, and facilitates dynamic locale selection. | +| LanguagesLoaded( CalLanguages() as String ) | This event is raised once the calendar has completely loaded the list of available languages, and facilitates dynamic locale selection. | 
-| ViewChanged( NewView as [[http://​developer.xojo.com/​integer|Integer]], StartDate as Date, EndDate as Date ) | Fired when the user changes the view (IE: from Month to Week to Day). |+| ViewChanged( NewView as Integer, StartDate as Date, EndDate as Date ) | Fired when the user changes the view (IE: from Month to Week to Day). |
  
 ==== Methods ==== ==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 | AddEvent( newEvent as GraffitiWebCalendarEvent ) | Add a new event to the calendar. | | AddEvent( newEvent as GraffitiWebCalendarEvent ) | Add a new event to the calendar. |
-| AddExternalSource( URL as [[http://​developer.xojo.com/​string|String]], BGColor as [[http://​developer.xojo.com/​color|Color]] = &​c3a87ad,​ BorderColor as [[http://​developer.xojo.com/​color|Color]] = &​c3a87ad,​ TextColor as [[http://​developer.xojo.com/​color|Color]] = &​cFFFFFF ) | Add an external source to the calendar, such as a Google Calendar feed. |+| AddExternalSource( URL as String, BGColor as Color = &​c3a87ad,​ BorderColor as Color = &​c3a87ad,​ TextColor as Color = &​cFFFFFF ) | Add an external source to the calendar, such as a Google Calendar feed. |
 | AddRestriction( theRestriction as [[web:​calendarrestriction|GraffitiWebCalendarRestriction]] ) | Adds a view restriction. | | AddRestriction( theRestriction as [[web:​calendarrestriction|GraffitiWebCalendarRestriction]] ) | Adds a view restriction. |
 | DayTitle(Day as Date) as String | Returns the title set for the specified date. | | DayTitle(Day as Date) as String | Returns the title set for the specified date. |
 | DayTitle(Day as Date, Title as String, Style as WebStyle = Nil) | Sets the day title with optional style for a date. | | DayTitle(Day as Date, Title as String, Style as WebStyle = Nil) | Sets the day title with optional style for a date. |
 | DeselectAll() | Deselect all selected dates and events. | | DeselectAll() | Deselect all selected dates and events. |
-| FindEvent( theID as [[http://​developer.xojo.com/​integer|Integer]] ) As GraffitiWebCalendarEvent | Used to find an event by ID, and return the event object. | +| FindEvent( theID as Integer ) As GraffitiWebCalendarEvent | Used to find an event by ID, and return the event object. | 
-| FindEventIndex( theID as [[http://​developer.xojo.com/​integer|Integer]] ) as [[http://​developer.xojo.com/​integer|Integer]] | Used to find an event by ID, and return an integer index. | +| FindEventIndex( theID as Integer ) as Integer | Used to find an event by ID, and return an integer index. | 
-| ICSExport( Domain as [[http://​developer.xojo.com/​string|string]] ​) as [[http://​developer.xojo.com/​string|String]] | Exports all current events to ICS format. | +| ICSExport( Domain as String ​) as String | Exports all current events to ICS format. | 
-| ICSImport( theICS as [[http://​developer.xojo.com/​string|string]] ​) | Imports ICS-formatted event data to GraffitiWebCalendar events. |+| ICSImport( theICS as String ​) | Imports ICS-formatted event data to GraffitiWebCalendar events. |
 | MoveNext() | Move to the next Month/​Week/​Day | | MoveNext() | Move to the next Month/​Week/​Day |
 | MoveNextYear() | Move to the next year. | | MoveNextYear() | Move to the next year. |
Line 48: Line 48:
 | RemoveAllRestrictions() | Removes all restrictions from the calendar view. | | RemoveAllRestrictions() | Removes all restrictions from the calendar view. |
 | RemoveEvent( theEvent as GraffitiWebCalendarEvent ) | Remove the supplied event object from the calendar. | | RemoveEvent( theEvent as GraffitiWebCalendarEvent ) | Remove the supplied event object from the calendar. |
-| RemoveExternalSource( URL as [[http://​developer.xojo.com/​string|String]] ) | Remove the external source signified by URL. |+| RemoveExternalSource( URL as String ) | Remove the external source signified by URL. |
 | RemoveRestriction( theID as String ) | Removes a restriction from the calendar view. | | RemoveRestriction( theID as String ) | Removes a restriction from the calendar view. |
 | RerenderEvents() | Forces the calendar to rerender all events. ​ Useful if you notice any weirdness. | | RerenderEvents() | Forces the calendar to rerender all events. ​ Useful if you notice any weirdness. |
Line 56: Line 56:
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| CalendarView ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | The current view state. | +| CalendarView | Integer | 0 | The current view state. | 
-| CustomTheme ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether the calendar is to use a custom theme. ​ This can either be in the form of the WebStyle properties, or a jQuery UI theme CSS file added to the page with a WebPageSource. | +| CustomTheme | Boolean | False | Determines whether the calendar is to use a custom theme. ​ This can either be in the form of the WebStyle properties, or a jQuery UI theme CSS file added to the page with a WebPageSource. | 
-| Editable ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines if events are editable in the display by, for example, dragging. |+| Editable | Boolean | True | Determines if events are editable in the display by, for example, dragging. |
 | Events() | GraffitiWebCalendarEventItem | Nil | The array of events that the calendar currently contains. | | Events() | GraffitiWebCalendarEventItem | Nil | The array of events that the calendar currently contains. |
-| Language ​| [[http://​developer.xojo.com/​string|String]] | "​en"​ | The short language string which determines the locale of the calendar. Currently contains: "​en",​ "​ar-ma",​ "​ar-sa",​ "​ar",​ "​bg",​ "​ca",​ "​cs",​ "​da",​ "​de-at",​ "​de",​ "​el",​ "​en-au",​ "​en-gb",​ "​es",​ "​fa",​ "​fi",​ "​fr-ca",​ "​fr",​ "​hi",​ "​hr",​ "​hu",​ "​id",​ "​is",​ "​it",​ "​ja",​ "​ko",​ "​lt",​ "​lv",​ "​nl",​ "​pl",​ "​pt-br",​ "​pt",​ "​ro",​ "​ru",​ "​sk",​ "​sl",​ "​sr-cyrl",​ "​sr",​ "​sv",​ "​th",​ "​tr",​ "​uk",​ "​vi",​ "​zh-cn",​ "​zh-tw"​ | +| Language | String | "​en"​ | The short language string which determines the locale of the calendar. Currently contains: "​en",​ "​ar-ma",​ "​ar-sa",​ "​ar",​ "​bg",​ "​ca",​ "​cs",​ "​da",​ "​de-at",​ "​de",​ "​el",​ "​en-au",​ "​en-gb",​ "​es",​ "​fa",​ "​fi",​ "​fr-ca",​ "​fr",​ "​hi",​ "​hr",​ "​hu",​ "​id",​ "​is",​ "​it",​ "​ja",​ "​ko",​ "​lt",​ "​lv",​ "​nl",​ "​pl",​ "​pt-br",​ "​pt",​ "​ro",​ "​ru",​ "​sk",​ "​sl",​ "​sr-cyrl",​ "​sr",​ "​sv",​ "​th",​ "​tr",​ "​uk",​ "​vi",​ "​zh-cn",​ "​zh-tw"​ | 
-| RestrictView ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Restricts the view to the restrictions provided via AddRestriction. | +| RestrictView | Boolean | False | Restricts the view to the restrictions provided via AddRestriction. | 
-| ShowDayButton ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines if the "​Day"​ view selector is visible. | +| ShowDayButton | Boolean | True | Determines if the "​Day"​ view selector is visible. | 
-| ShowMonthButton ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines if the "​Month"​ view selector is visible. | +| ShowMonthButton | Boolean | True | Determines if the "​Month"​ view selector is visible. | 
-| ShowNavButtons ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines if the Prev/Next navigation buttons are visible. | +| ShowNavButtons | Boolean | True | Determines if the Prev/Next navigation buttons are visible. | 
-| ShowTitle ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Whether the calendar shows the title (IE: October 2014). | +| ShowTitle | Boolean | True | Whether the calendar shows the title (IE: October 2014). | 
-| ShowTodayButton ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines if the Today button is displayed. | +| ShowTodayButton | Boolean | True | Determines if the Today button is displayed. | 
-| ShowWeekButton ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines if the Week button is displayed. | +| ShowWeekButton | Boolean | True | Determines if the Week button is displayed. | 
-| ShowYearButtons ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines if the Year navigation buttons are displayed. |+| ShowYearButtons | Boolean | True | Determines if the Year navigation buttons are displayed. |
 | StyleDayFuture | WebStyle | Nil | WebStyle for a day following Today. | | StyleDayFuture | WebStyle | Nil | WebStyle for a day following Today. |
 | StyleDayPast | WebStyle | Nil | WebStyle for a day the precedes today. | | StyleDayPast | WebStyle | Nil | WebStyle for a day the precedes today. |