Difference between revisions of "CalendarView"

From Jeremie Leroy - XOJO Controls Wiki
Jump to: navigation, search
m (1 revision)
Line 14: Line 14:
 
|class=titleClass colspan=3|Properties
 
|class=titleClass colspan=3|Properties
 
|-
 
|-
−
|width=33%|{{Property | name=AdaptWeeksPerMonth | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=AdaptWeeksPerMonth | type=Boolean | description=If True, in ViewType Month and Picker, the CalendarView will automatically calculate how many weeks are needed to display the whole month.If False, 6 weeks will always be displayed. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=FirstDate | type=Date | description= | readonly=yes | newinversion=}}
+
|width=33%|{{Property | name=FirstDate | type=Date | description=The first date displayed in the CalendarView. | readonly=yes | newinversion=}}
−
|width=33%|{{Property | name=MyStyle | type=Styles | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=ScrollPosition | type=Double | description=Vertical ScrollPosition used in Week and Day view. | readonly=no | newinversion=}}
 
|-
 
|-
−
|width=33%|{{Property | name=Border | type=Boolean | description=If true a Border is displayed around the CalendarView | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Border | type=Boolean | description=If true a Border is displayed around the CalendarView.The default value is False. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=FirstDayOfWeek | type=Byte | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=FirstDayOfWeek | type=Byte | description=The first day of week displayed in the CalendarView.1 = Sunday7 = Saturday | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=ScrollPosition | type=Double | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=SelEnd | type=Date | description=Selection end date. | readonly=no | newinversion=}}
 
|-
 
|-
 
|width=33%|{{Property | name=ColorWeekend | type=Boolean | description=If True, the Weekend will be colored with MyColors.Weekend color. | readonly=no | newinversion=}}
 
|width=33%|{{Property | name=ColorWeekend | type=Boolean | description=If True, the Weekend will be colored with MyColors.Weekend color. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=ForceAM_PM | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=ForceAM_PM | type=Boolean | description=If True, Hours in Week view and Day view will always be displayed with AM and PM.If False, the Calendarview tries to get the system default's hour format. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=SelEnd | type=Date | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=SelStart | type=Date | description=Selection start Date. | readonly=no | newinversion=}}
 
|-
 
|-
 
|width=33%|{{Property | name=CreateWithDrag | type=Boolean | description=If True, the user can create a CalendarEvent by dragging the mouse. | readonly=no | newinversion=}}
 
|width=33%|{{Property | name=CreateWithDrag | type=Boolean | description=If True, the user can create a CalendarEvent by dragging the mouse. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=Freeze | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=LastDate | type=Date | description=The first date displayed in the CalendarView. | readonly=yes | newinversion=}}
−
|width=33%|{{Property | name=SelStart | type=Date | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Style | type=Integer | description=Style currently used in the CalendarView.See the Style constants of [[CalendarView]]. | readonly=yes | newinversion=}}
 
|-
 
|-
−
|width=33%|{{Property | name=DayEndHour | type=Single | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DayEndHour | type=Single | description=If this property is different than 0.0, the remaining hours from DayEndHour to midnight will be darkened.The default value is 18.0==Example==This example sets the DayEndHour to 18:45.<rbcode>me.DayEndHour=18.75</rbcode> | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=FullRefresh | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=minHGap | type=Integer | description=The minimum horizontal Gap in pixels between months in Year view. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=Style | type=Integer | description= | readonly=yes | newinversion=}}
+
|width=33%|{{Property | name=ViewDays | type=Integer | description=Amount of days to display for ViewType = TypeOther. | readonly=no | newinversion=}}
 
|-
 
|-
−
|width=33%|{{Property | name=DayNames(7) | type=String | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DayNames | type=String | description=The n | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=LastDate | type=Date | description= | readonly=yes | newinversion=}}
+
|width=33%|{{Property | name=minHourHeight | type=Integer | description=The minimum hour height in pixels for Week and Day view. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=ViewDays | type=Integer | description= | readonly=no | newinversion=}}
+
−
|-
+
−
|width=33%|{{Property | name=DayStartHour | type=Single | description= | readonly=no | newinversion=}}
+
−
|width=33%|{{Property | name=minHGap | type=Integer | description= | readonly=no | newinversion=}}
+
 
|width=33%|{{Property | name=ViewType | type=Integer | description= | readonly=no | newinversion=}}
 
|width=33%|{{Property | name=ViewType | type=Integer | description= | readonly=no | newinversion=}}
 
|-
 
|-
−
|width=33%|{{Property | name=DisplayDate | type=Date | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DayStartHour | type=Single | description=If this property is different than 0.0, the hours from midnight to DayStartHour will be darkened.The default value is 6.0==Example==This example sets the DayStartHour to 8 AM.<rbcode>me.DayStartHour=8.0</rbcode> | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=minHourHeight | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=minVGap | type=Integer | description=The minimum vertical Gap in pixels between months in Year view. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=WeekHeaderTextFormat | type=String | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=WeekHeaderTextFormat | type=String | description=Date format to display over each day in Week and Day view.This string property takes the same format parameters as the PHP Date function:http://php.net/manual/en/function.date.phpIf a character needs to be escaped, a backslash "\" can be used.==Examples==<rbcode>//Tuesday 08, Februaryme.WeekHeaderTextFormat = "l d, F"//Feb. 8me.WeekHeaderTextFormat = "M. j"</rbcode> | readonly=no | newinversion=}}
 
|-
 
|-
−
|width=33%|{{Property | name=DisplayWeeknumber | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DisplayDate | type=Date | description=The currently displayed Date.Change the DisplayDate to change the current view.==Notes==If you assign a date using<rbcode>me.DisplayDate = aDate</rbcode>There is no need to refresh the CalendarView to show the selected date.However if you alter DisplayDate without assigning it a value, the CalendarView needs to be refreshed:<rbcode>//Change the month to Decemberme.DisplayDate.Month = 12me.Redisplay() //This refreshes the CalendarView</rbcode> | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=minVGap | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=MonthNames | type=String | description=Month names from MonthNames(1)=January to MonthNames(12)=December.On Windows, the MonthNames are automatically retrieved.On Macintosh and Linux, the CalendarView will try to retrieve the MonthNames using Date.LongDate. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=YearHeatMap | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=YearHeatMap | type=Boolean | description=If True, the Year view will display a "heat map" from yellow to red depending on how many [[CalendarEvent|CalendarEvents]] are on each day.  | readonly=no | newinversion=}}
 
|-
 
|-
−
|width=33%|{{Property | name=DragEvents | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DisplayWeeknumber | type=Boolean | description=If True, the week numbers are displayed in Month view, Week view and Day view. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=MonthNames(12) | type=String | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=MyColors | type=Colors | description=Set of Colors used in the CalendarView.By using SetStyle method, the colors are changed. | readonly=no | newinversion=}}
  
 
|-
 
|-
−
|width=33%|{{Property | name=DragOffset | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DragEvents | type=Boolean | description=If True, CalendarEvent items can be dragged with the mouse to alter the date or start time. | readonly=no | newinversion=}}
−
|width=33%|{{Property | name=MyColors | type=Colors | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=MyStyle | type=Styles | description=Set of Styles used in the CalendarView.By using SetStyle method, the style is changed. | readonly=no | newinversion=}}
  
 
|-
 
|-
Line 92: Line 88:
  
 
ToDo list
 
ToDo list
 +
#Ignore in LR
 +
 
Month view
 
Month view
 
-Setting for Month title position in Month view
 
-Setting for Month title position in Month view
Line 176: Line 174:
  
 
***Version 1.0.0 - Released 2012-03-30***
 
***Version 1.0.0 - Released 2012-03-30***
 +
==See Also==
 +
 +
See Also
 +
CalendarEvent, CalendarDrawPosition

Revision as of 21:59, 29 April 2012


Description

Displays a Calendar in several formats (Year, Month, Week, Day, ...) that presents CalendarEvents. This custom control based on a Canvas is similar to iCal on Mac OS and Google Calendar.



Properties
AdaptWeeksPerMonth FirstDate ScrollPosition
Border FirstDayOfWeek SelEnd
ColorWeekend ForceAM_PM SelStart
CreateWithDrag LastDate Style]]
<span title="(Single) If this property is different than 0.0, the remaining hours from DayEndHour to midnight will be darkened.The default value is 18.0==Example==This example sets the DayEndHour to 18:45.<rbcode>me.DayEndHour=18.75</rbcode>">DayEndHour</span> minHGap ViewDays
DayNames minHourHeight ViewType
<span title="(Single) If this property is different than 0.0, the hours from midnight to DayStartHour will be darkened.The default value is 6.0==Example==This example sets the DayStartHour to 8 AM.<rbcode>me.DayStartHour=8.0</rbcode>">DayStartHour</span> minVGap <span title="(String) Date format to display over each day in Week and Day view.This string property takes the same format parameters as the PHP Date function:http://php.net/manual/en/function.date.phpIf a character needs to be escaped, a backslash "\" can be used.==Examples==<rbcode>//Tuesday 08, Februaryme.WeekHeaderTextFormat = "l d, F"//Feb. 8me.WeekHeaderTextFormat = "M. j"</rbcode>">WeekHeaderTextFormat</span>
<span title="(Date) The currently displayed Date.Change the DisplayDate to change the current view.==Notes==If you assign a date using<rbcode>me.DisplayDate = aDate</rbcode>There is no need to refresh the CalendarView to show the selected date.However if you alter DisplayDate without assigning it a value, the CalendarView needs to be refreshed:<rbcode>//Change the month to Decemberme.DisplayDate.Month = 12me.Redisplay() //This refreshes the CalendarView</rbcode>">DisplayDate</span> MonthNames YearHeatMap
DisplayWeeknumber MyColors
DragEvents MyStyle


Methods
AddEvent ImportICS
DeleteAllEvents Redisplay
ExportICS Register
ExportToDB RemoveEvent
GetEvents Scroll
ImportFromDB SetStyle
ImportICS


ToDo list

ToDo list

  1. Ignore in LR

Month view -Setting for Month title position in Month view -Select element and delete it with Backspace or Delete ??

Week view -limit amount of day events -Force AM/PM -DayStart time -DayEnd time -> NightColor -minHourHeight <-> DisplayXXHours

Year view -Double click on month to display it in month view -Color days with amount of events per day (Yellow to red)

History

History

      • Version 1.1 - Not yet released***

New: -TypePicker -SelStart, SelEnd to set the selected dates in the CalendarPicker -DayStartHour, DayEndHour -ForceAM_PM -Style Property -StyleOutlook2010 constant -WeekHeaderTextFormat -

Fix: -Several graphic enhancements -Colors in StyleDark -Day names on Mac OS


      • Version 1.0.3 - Released 2012-04-11***

New: -StyleDefault, StyleICal, StyleGoogle, StyleDark class constants -ImportFromDB function -ExportToDB function -RemoveEvent now has a RemoveFromDB property.

Fix: -CalendarView not updating after AddEvent


      • Version 1.0.2 - Released 2012-04-03***

New: -StyleDark -DisableDrag is replaced with DragEvents and CreateWithDrag

Fix: -Day background color not filling the box in TypeMonth -Time background color not displaying in TypeWeek -Resizing event to make a 15 minute event in TypeWeek -TypeYear not displaying non-day events -OutOfBoundsException in DrawTime on Mac OS -Drawing long event in TypeMonth that finishes on last day of week


      • Version 1.0.1 - Released 2012-04-02***

New: -DisplayWeeknumber As Boolean -MyColors.WeekNumber -MyColors.WeekNumberBackground -Day name is displayed inside the month grid for iCal style. -Drag events in Month and Week view to change start date/time -Resize event in TypeWeek -HeatMap in TypeYear -SetLength Function in CalendarEvent -VerticalGap and HorizontalGap properties for TypeYear -New Event "DragEvent". Fires when a CalendarEvent is dragged or resized

Fix: -Selected background color in month view if MyStyle.MDayNumberPos=1 -Day events in TypeWeek not aligned properly



      • Version 1.0.0 - Released 2012-03-30***

See Also

See Also CalendarEvent, CalendarDrawPosition

Retrieved from "https://www.jeremieleroy.com/wiki/index.php?title=CalendarView&oldid=2554"