CalendarSet version 6 documentation

This is an old revision of the document!

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
CS_Area_ViewMode	√	√	√	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_AllowEventSelect	√	√	√	bool	1	0	1	Allow events 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_StartHour	√	√	√	int	0	0	23	Specifies if any hours at the beginning of the day should be hidden (0 - 23)
CS_Area_EndHour	√	√	√	int	24	1	24	Specifies if any hours at the end of the day should be hidden (1 - 24)
CS_Area_StartWorkHour	√	√	√	int	8	0	23	Specifies if any hours at the beginning of the day should be grayed out
CS_Area_EndWorkHour	√	√	√	int	18	0	24	Specifies if any hours at the end 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_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_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_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_DayColor0	√	√	√	color	0			Background color for Sunday
CS_Area_DayColor1	√	√	√	color	0			Background color for Monday
CS_Area_DayColor2	√	√	√	color	0			Background color for Tuesday
CS_Area_DayColor3	√	√	√	color	0			Background color for Wednesday
CS_Area_DayColor4	√	√	√	color	0			Background color for Thursday
CS_Area_DayColor5	√	√	√	color	0			Background color for Friday
CS_Area_DayColor6	√	√	√	color	0			Background color for Saturday
CS_Area_ClickedDate	√			int				Last clicked cell POSIX time of the clicked position
CS_Area_ClickedEventType	√			int				Last clicked event type
CS_Area_ClickedEventIndex	√			int				Last clicked event index
CS_Area_ClickedEventID	√	√		text
CS_Area_FirstVisibleDate	√	√		date				Date of the first 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)