| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| area_area_properties [2019/08/29 18:43] – cs_admin | area_area_properties [2022/03/03 18:30] (current) – cs_admin |
|---|
| ^property constant ^can read ^can write ^persi\\ stent ^type ^default^min ^max ^usage ^ | ^property constant ^can read ^can write ^persi\\ stent ^type ^default^min ^max ^usage ^ |
| |__CS_Area_Kind__| √ | | √ |text| | | |Object kind = "CS"| | |
| |__CS_Area_XML__| √ | √ | |text| | | |Full description of the area in XML| | |
| |__CS_Area_Name__| √ | √ | √ |text| | | |Name of the area\\ If empty, variable name from design| | |
| |__CS_Area_UserBLOB__| √ | √ | √ |BLOB| | | |BLOB for free use by developer| | |
| |__CS_Area_IsArea__| √ | | |bool| | | |Is this an CS area?| | |
| |__CS_Area_Visible__| √ | √ | |bool| | | |Area is visible\\ Set to false before showing another dialog over CS to hide scrollbars...| | |
| |__CS_Area_Selected__| √ | | |bool| | | |Is selected (has focus in 4D)| | |
| |__CS_Area_ScrollLeft__| √ | √ | |real| | | |Horizontal scroll position\\ In points| | |
| |__CS_Area_ScrollTop__| √ | √ | |real| | | |Vertical scroll position\\ In points| | |
| |__CS_Area_Compatibility__| √ | | √ |int|Depends on initialization|0|3|0 = only new API used\\ 1 = old CS (arrays) API used\\ 2 = Agenda (fields) API used\\ 3 = both old CS & Agenda API used\\ CS 4/Agenda compatibility mode| | |
| |__CS_Area_Self__| √ | | |pointer| | | |Pointer to the area object|C_POINTER($ptr)\\ $err:=//**CS_GetAreaPtrProperty**// ($area;__CS_Area_Self__;->$ptr) | |
| |__CS_Area_View__| √ | √ | √ |int|0|0|5|0 = old month\\ 1 = day\\ 2 = day range\\ 3 = work week\\ 4 = week\\ 5 = month| | |
| |__CS_Area_CurrentUser__| √ | √ | |int|0| | |Currently used only in Agenda compatibility| | |
| |__CS_Area_DefaultICal__| √ | √ | |int| | | |Default iCal owned by the area\\ Calendar number of the implicit default Calendar| | |
| |__CS_Area_TimeZone__| √ | √ | |text| | | |Area's time zone| | |
| |__CS_Area_VisibleDays__| √ | √ | √ |text|1111111| | |Which days should be visible\\ 0 = invisible or 1 = visible for every day starting at Sunday\\ e.g.to hide Saturday, use "1111110"| | |
| |__CS_Area_FirstDay__| √ | √ | √ |int|-1|-1|6|First day of week\\ -1 = use workstation system setting\\ 0 = Sunday\\ 1 = Monday…| | |
| |__CS_Area_StartDate__| √ | √ | |date| | | |Start date of the date range to display\\ Not necessarily the first visible day| | |
| |__CS_Area_EndDate__| √ | √ | |date| | | |End date of the date range to display\\ Used in old month view and day range view| | |
| |__CS_Area_DisplayUnused__| √ | √ | √ |int|2|0|2|What to display in used (out of date range) cells\\ 0 = nothing\\ 1 = day\\ 2 = events| | |
| |__CS_Area_DisplayMonth__| √ | √ | √ |int|1|0|2|Display month name on month change, even in Day/Week view\\ Value 2 means the month is displayed with year in OldMonth/Month views| | |
| |__CS_Area_DisplayWeek__| √ | √ | √ |bool|0|0|1|Display week number in first column| | |
| |__CS_Area_DisplayBanners__| √ | √ | √ |bool|1|0|1|Display banners (all-day events)\\ Default is 0 for Agenda API| | |
| |__CS_Area_DisplayEventTimes__| √ | √ | √ |bool|1|0|1|Display event times in month view| | |
| |__CS_Area_AllowBannerSelect__| √ | √ | √ |bool|1|0|1|Allow banners selection| | |
| |__CS_Area_AllowBannerResize__| √ | √ | √ |bool|1|0|1|Allow banners resizing| | |__CS_Area_AllowBannerResize__| √ | √ | √ |bool|1|0|1|Allow banners resizing| |
| |__CS_Area_AllowEventSelect__| √ | √ | √ |bool|1|0|1|Allow events selection| | |__CS_Area_AllowBannerSelect__| √ | √ | √ |bool|1|0|1|Allow banners selection| |
| |__CS_Area_AllowEventResize__| √ | √ | √ |bool|1|0|1|Allow events resizing| | |
| |__CS_Area_HighlightMode__| √ | √ | √ |int|1|0|2|Highlight mode of the day\\ 0 = none\\ 1 = entire cell\\ 2 = day number| | |
| |__CS_Area_DaySelectionType__| √ | √ | √ |int|0|0|2|0 = one day\\ 1 = multiple\\ 2 = discontiguous| | |
| |__CS_Area_SelectMultiple__| √ | √ | √ |bool|0|0|1|Allow multiple events/banners selection| | |
| |__CS_Area_AllowDragNewEvent__| √ | √ | √ |bool|0|0|1| | | |
| |__CS_Area_AllowDeleteEvent__| √ | √ | √ |bool|0|0|1|Allow DEL key| | |__CS_Area_AllowDeleteEvent__| √ | √ | √ |bool|0|0|1|Allow DEL key| |
| |__CS_Area_StartHour__| √ | √ | √ |int|0|0|23|Specifies if any hours at the beginning of the day should be hidden (0 - 23)| | |__CS_Area_AllowDragNewEvent__| √ | √ | √ |bool|0|0|1| | |
| |__CS_Area_EndHour__| √ | √ | √ |int|24|1|24|Specifies if any hours at the end of the day should be hidden (1 - 24)| | |__CS_Area_AllowEventResize__| √ | √ | √ |bool|1|0|1|Allow events resizing| |
| |__CS_Area_StartWorkHour__| √ | √ | √ |int|8|0|23|Specifies if any hours at the beginning of the day should be grayed out| | |__CS_Area_AllowEventSelect__| √ | √ | √ |bool|1|0|1|Allow events selection| |
| |__CS_Area_EndWorkHour__| √ | √ | √ |int|18|0|24|Specifies if any hours at the end of the day should be grayed out| | |__CS_Area_ClickedDate__| √ | | |int| | | |Last clicked cell\\ POSIX time of the clicked position| |
| |__CS_Area_TimeRounding__| √ | √ | √ |int|1|0|5|Time rounding for dragging\\ 0 = none\\ 1 = 5 minutes\\ 2 = 10 min.\\ 3 = 15 min.\\ 4 = 30 min.\\ 5 = 60 minutes| | |__CS_Area_ClickedEventID__| √ | √ | |text| | | | | |
| |__CS_Area_ScaleRows__| √ | √ | √ |real|0|0|64|Coefficient for computing the row height:\\ 0 = automatic (fit into view), > 0: multiply by 48 to get the row height in points| | |__CS_Area_ClickedEventIndex__| √ | | |int| | | |Last clicked event index| |
| |__CS_Area_ScaleColumns__| √ | √ | √ |real|0|0|64|coefficient for computing the column width:\\ 0 = automatic (fit into view), > 0: multiply by 128 to get the column width in points| | |__CS_Area_ClickedEventType__| √ | | |int| | | |Last clicked event type| |
| |__CS_Area_EventColumnation__| √ | √ | √ |int|0|-100|256|Columnation for overlapping events\\ 0 = no overlap\\ <0 = overlap as percentage of column width\\ >0 = overlap in points| | |__CS_Area_ColorTheme__| | √ | |int| |1|1|Currently only allowed value is 1\\ When set, many properties are modified to match Calendar.app look: global styles & area properties (including styles)| |
| | |__CS_Area_Compatibility__| √ | | √ |int|Depends on initialization|0|3|0 = only new API used\\ 1 = old CS (arrays) API used\\ 2 = Agenda (fields) API used\\ 3 = both old CS & Agenda API used\\ CS 4/Agenda compatibility mode| |
| | |__CS_Area_CurrentUser__| √ | √ | |int|0| | |Currently used only in Agenda compatibility| |
| |__CS_Area_DayColor0__| √ | √ | √ |color|0| | |Background color for Sunday| | |__CS_Area_DayColor0__| √ | √ | √ |color|0| | |Background color for Sunday| |
| |__CS_Area_DayColor1__| √ | √ | √ |color|0| | |Background color for Monday| | |__CS_Area_DayColor1__| √ | √ | √ |color|0| | |Background color for Monday| |
| |__CS_Area_DayColor5__| √ | √ | √ |color|0| | |Background color for Friday| | |__CS_Area_DayColor5__| √ | √ | √ |color|0| | |Background color for Friday| |
| |__CS_Area_DayColor6__| √ | √ | √ |color|0| | |Background color for Saturday| | |__CS_Area_DayColor6__| √ | √ | √ |color|0| | |Background color for Saturday| |
| |__CS_Area_ClickedDate__| √ | | |int| | | |Last clicked cell\\ POSIX time of the clicked position| | |__CS_Area_DayHeaderAlignment__| √ | √ | √ |int|0|0|3|Modifies header alignment in Day view\\ 0 = current state - use __CS_Style_Header__ alignment\\ 1 = force left alignment\\ 2 = force centered alignment\\ 3 = force right alignment| |
| |__CS_Area_ClickedEventType__| √ | | |int| | | |Last clicked event type| | |__CS_Area_DayHeaderFormat__| √ | √ | √ |int|0|0|20|0 = current state: DDD, DD / DDDD, DD depending on column width: Sat, 29. / Saturday, 29\\ 1 = DDD, DD: Sat, 29\\ 2 = DDDD, DD: Saturday, 29\\ 3 = DD/MM: 29/02\\ 4 = sMM/DD: 02/29\\ 5 = DD MMM: Feb 29\\ 6 = MMM DD: 29 Feb\\ 7 = DDD, DD MMM: Sat, 29 Feb\\ 8 = MMM, DDD DD: Feb, Sat 29\\ 9 = DDD, MMM DD: Sat, Feb 29\\ 10 = YYYY-MM-DD: 2020-02-29\\ 11 = DD DDD: 29 Sat\\ 12 = DDD DD: Sat 29\\ Adding 8 to selectors 5-12 uses full names, e.g. for 9 + 8 = 17: Saturday, February 29| |
| |__CS_Area_ClickedEventIndex__| √ | | |int| | | |Last clicked event index| | |__CS_Area_DayInfoFormat__| √ | √ | √ |int|0|0|6|0 = current state (depends on __CS_Area_DisplayWeek__, __CS_Area_DisplayMonth__)\\ 1 = same as 0, but forced short month name\\ 2 = same as 0, but forced full month name\\ 3 = week: W9\\ 4 = short month name: Feb\\ 5 = long month name: February\\ 6 = short month + year: Feb 2020| |
| |__CS_Area_ClickedEventID__| √ | √ | |text| | | | | | |__CS_Area_DaySelectionType__| √ | √ | √ |int|0|0|2|0 = one day\\ 1 = multiple\\ 2 = discontiguous| |
| | |__CS_Area_DefaultForNewEvent__| √ | √ | |int| | | |iCal to use for new events\\ When dragging event inside area, identical calendarID is used\\ When dragging event across areas and destination area shows that owning calendar, identical calendarID is used\\ When zero, default calendar (__CS_Area_DefaultiCal__) is used\\ Finally, when resolved iCal to use is not visible in the area (does not exist or is hidden), first visible calendar is used| |
| | |__CS_Area_DefaultICal__| √ | √ | |int| | | |Default iCal owned by the area\\ Calendar number of the implicit default Calendar| |
| | |__CS_Area_DisplayBanners__| √ | √ | √ |bool|1|0|1|Display banners (all-day events)\\ Default is 0 for Agenda API| |
| | |__CS_Area_DisplayEventTimes__| √ | √ | √ |bool|1|0|1|Display event times in month view| |
| | |__CS_Area_DisplayMonth__| √ | √ | √ |int|1|0|2|Display month name on month change, even in Day/Week view\\ Value 2 means the month is displayed with year in OldMonth/Month views| |
| | |__CS_Area_DisplayUnused__| √ | √ | √ |int|2|0|2|What to display in used (out of date range) cells\\ 0 = nothing\\ 1 = day\\ 2 = events| |
| | |__CS_Area_DisplayWeek__| √ | √ | √ |bool|0|0|1|Display week number in first column| |
| | |__[[about_calendarset_v6#cs_area_drawingmode|CS_Area_DrawingMode]]__| √ | √ | √ |bool|0|0|1|Use Calendar.app - like drawing\\ Background color of event is not used, calendar/event color is shaded instead\\ Note: does not affect Old month view drawing and all views when Agenda API is used| |
| | |__CS_Area_EndDate__| √ | √ | |date| | | |End date of the date range to display\\ Used in old month view and day range view| |
| | |__CS_Area_EndHour__| √ | √ | √ |int|24|1|24|Specifies if any hours at the end of the day should be hidden (1 - 24)| |
| | |__CS_Area_EndWorkHour__| √ | √ | √ |int|18|0|24|Specifies if any hours at the end of the day should be grayed out| |
| | |__CS_Area_EventColumnation__| √ | √ | √ |int|0|-100|256|Columnation for overlapping events\\ 0 = no overlap\\ <0 = overlap as percentage of column width\\ >0 = overlap in points| |
| | |__CS_Area_FirstDay__| √ | √ | √ |int|-1|-1|6|First day of week\\ -1 = use workstation system setting\\ 0 = Sunday\\ 1 = Monday…| |
| |__CS_Area_FirstVisibleDate__| √ | √ | |date| | | |Date of the first cell in the view (column in day/week views)| | |__CS_Area_FirstVisibleDate__| √ | √ | |date| | | |Date of the first cell in the view (column in day/week views)| |
| | |__CS_Area_GoToNext__| | √ | |unused| | | |Change displayed date range to “next” (depends on the view, e.g. for day it is one day, for year view showing 1 month it is one month)| |
| | |__CS_Area_GoToPrevious__| | √ | |unused| | | |Change displayed date range to “previous” (depends on the view, e.g. for day it is one day, for year view showing 1 month it is one month)| |
| | |__CS_Area_GoToToday__| | √ | |unused| | | |Change displayed date range to “now”| |
| | |__CS_Area_HighlightMode__| √ | √ | √ |int|1|0|2|Highlight mode of the day\\ 0 = none\\ 1 = entire cell\\ 2 = day number| |
| | |__CS_Area_HoursInDayView__| √ | √ | √ |int|24|1|24|In Day/Week view, display specified hours at a time (using scrolling when more hours are to be displayed)| |
| | |__CS_Area_IsArea__| √ | | |bool| | | |Is this an CalendarSet area?| |
| | |__CS_Area_Kind__| √ | | √ |text| | | |Object kind = "CS"| |
| |__CS_Area_LastVisibleDate__| √ | √ | |date| | | |Date of the last cell in the view (column in day/week views)| | |__CS_Area_LastVisibleDate__| √ | √ | |date| | | |Date of the last cell in the view (column in day/week views)| |
| | |__CS_Area_MonthHeaderFormat__| √ | √ | √ |int|0|0|2|0 = current state (short/full day name depending on column width)\\ 1 = short day name\\ 2 = full day name| |
| | |__CS_Area_Name__| √ | √ | √ |text| | | |Name of the area\\ If empty, variable name from design| |
| | |__CS_Area_NoAllDayHeader__| √ | √ | √ |bool|0|0|1|When set to 1, the “all-day” text is not drawn above the time column in Day/Week view| |
| | |__CS_Area_ScaleColumns__| √ | √ | √ |real|0|0|64|coefficient for computing the column width:\\ 0 = automatic (fit into view), > 0: multiply by 128 to get the column width in points| |
| | |__CS_Area_ScaleRows__| √ | √ | √ |real|0|0|64|Coefficient for computing the row height:\\ 0 = automatic (fit into view), > 0: multiply by 48 to get the row height in points| |
| | |__CS_Area_ScrollDaysWeeks__| √ | √ | √ |bool|0|0|1|When set to 1, day/week view is "scrollable" with mouse wheel\\ When (possibly displayed) scrollbar is at the min/max and you scroll with mouse wheel more enough, displayed date range is changed, new __CS_Action_DayWeekScroll__ is reported| |
| | |__CS_Area_ScrollLeft__| √ | √ | |real| | | |Horizontal scroll position\\ In points| |
| | |__CS_Area_ScrollMonthViewWeeks__| √ | √ | √ |bool|0|0|1|In Month view: when there are more events than space in a day cell, the whole week row is scrollable instead of showing “+2” (meaning 2 more events are not visible)\\ Arrows for scrolling are displayed on the right side of the area and in each cell (containing events), number of events is displayed; can be scrolled with mouse wheel| |
| | |__CS_Area_ScrollTop__| √ | √ | |real| | | |Vertical scroll position\\ In points| |
| | |__CS_Area_Selected__| √ | | |bool| | | |Is selected (has focus in 4D)| |
| | |__CS_Area_SelectMultiple__| √ | √ | √ |bool|0|0|1|Allow multiple events/banners selection| |
| | |__CS_Area_Self__| √ | | |pointer| | | |Pointer to the area object|C_POINTER($ptr)\\ $err:=//**CS_GetAreaPtrProperty**// ($area;__CS_Area_Self__;->$ptr) |
| | |__CS_Area_ShowEventsInYearView__| √ | √ | √ |bool|1|0|1|When set to 1, days in year view (layout 0 - 5) are colored if there are events| |
| | |__CS_Area_ShowInfoText__| √ | √ | √ |bool|0|0|1|When set to 1, new event property CS_Event_InfoText is drawn in day/week view| |
| | |__CS_Area_ShowYearInYearView__| √ | √ | √ |bool|0|0|1|When set to 1, year is displayed in year view| |
| | |__CS_Area_StartDate__| √ | √ | |date| | | |Start date of the date range to display\\ Not necessarily the first visible day| |
| | |__CS_Area_StartHour__| √ | √ | √ |int|0|0|23|Specifies if any hours at the beginning of the day should be hidden (0 - 23)| |
| | |__CS_Area_StartWorkHour__| √ | √ | √ |int|8|0|23|Specifies if any hours at the beginning of the day should be grayed out| |
| | |__CS_Area_TimeRounding__| √ | √ | √ |int|1|0|5|Time rounding for dragging\\ 0 = none\\ 1 = 5 minutes\\ 2 = 10 min.\\ 3 = 15 min.\\ 4 = 30 min.\\ 5 = 60 minutes| |
| | |__CS_Area_TimeZone__| √ | √ | |text| | | |Area's time zone| |
| | |__CS_Area_UserBLOB__| √ | √ | √ |BLOB| | | |BLOB for free use by developer| |
| | |__CS_Area_View__| √ | √ | √ |int|0|0|5|0 = old month\\ 1 = day\\ 2 = day range\\ 3 = work week\\ 4 = week\\ 5 = month| |
| | |__CS_Area_Visible__| √ | √ | |bool| | | |Area is visible\\ Set to false before showing another dialog over CS to hide scrollbars...| |
| | |__CS_Area_VisibleDays__| √ | √ | √ |text|1111111| | |Which days should be visible\\ 0 = invisible or 1 = visible for every day starting at Sunday\\ e.g.to hide Saturday, use "1111110"| |
| | |__CS_Area_WeekHeaderAlignment__| √ | √ | √ |int|0|0|3|Modifies header alignment in Day-range/Week view\\ 0 = current state - use __CS_Style_Header__ alignment\\ 1 = force left alignment\\ 2 = force centered alignment\\ 3 = force right alignment| |
| | |__CS_Area_WeekHeaderFormat__| √ | √ | √ |int|0|0|20|Text drawn in day header in Day-range/Week view\\ Possible values are identical to __CS_Area_DayHeaderFormat__| |
| | |__CS_Area_WeekInfoFormat__| √ | √ | √ |int|0|0|6|Text drawn above the time column in Day-range/Week view\\ Possible values are identical to __CS_Area_DayInfoFormat__| |
| | |__CS_Area_XML__| √ | √ | |text| | | |Full description of the area in XML| |
| | |__CS_Area_YearViewLayout__| √ | √ | √ |int|2|0|8|0 = 1 row, 12 columns\\ 1 = 2 rows, 6 columns\\ 2 = 3 rows, 4 columns\\ 3 = 4 rows, 3 columns\\ 4 = 6 rows, 2 columns\\ 5 = 12 rows, 1 column\\ 6 = 1 row, 1 column → 1 month\\ 7 = 1 row, 3 columns → 3 months\\ 8 = 3 rows, 1 column → 3 months| |
| | |
