| Both sides previous revisionPrevious revision | Next revisionBoth sides next revision |
| area_area_properties [2019/08/29 18:43] – cs_admin | area_area_properties [2020/06/10 17:29] – 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_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_DaySelectionType__| √ | √ | √ |int|0|0|2|0 = one day\\ 1 = multiple\\ 2 = discontiguous| |
| |__CS_Area_ClickedEventType__| √ | | |int| | | |Last clicked event type| | |__CS_Area_DefaultICal__| √ | √ | |int| | | |Default iCal owned by the area\\ Calendar number of the implicit default Calendar| |
| |__CS_Area_ClickedEventIndex__| √ | | |int| | | |Last clicked event index| | |__CS_Area_DisplayBanners__| √ | √ | √ |bool|1|0|1|Display banners (all-day events)\\ Default is 0 for Agenda API| |
| |__CS_Area_ClickedEventID__| √ | √ | |text| | | | | | |__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| |
| | |__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_HighlightMode__| √ | √ | √ |int|1|0|2|Highlight mode of the day\\ 0 = none\\ 1 = entire cell\\ 2 = day number| |
| | |__CS_Area_IsArea__| √ | | |bool| | | |Is this an CS 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_Name__| √ | √ | √ |text| | | |Name of the area\\ If empty, variable name from design| |
| | |__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_ScrollLeft__| √ | √ | |real| | | |Horizontal scroll position\\ In points| |
| | |__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_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_XML__| √ | √ | |text| | | |Full description of the area in XML| |
