hmCal_SET AREA PROPERTY
hmCal_SET AREA PROPERTY(area;property;value)
Parameter Type Description
area Longint -> hmCal area
property Longint -> area property
value Longint -> value to set
The command hmCal_SET AREA PROPERTY sets several properties of the area. With the parameter property, you can decide, which information, is to be set. See also chapter Constants.
To get properties about the area you can use the command hmCal_Get Area Property.
The property sets the width of the user list in the user multi day view in pixels. The value must amount to at least 10. This value can be read and written both.
The property shows or hides the full-day-area of the area. The full-day-area is in the daily view, user daily view and the multi day view. If value is set to 1, then the full-day-area is shown. If value is set to 0, then the full-day-area is hide. This value can be read and written both.
With the help of this property you can specify whether the user may shift appointments between several users by drag & drop in user views. If you set the value to 1, the user may shift appointments between the users by drag & drop. If you set the value to 0 the user cannot shift appointments between the users. This value can be read and written both.
With the property you can specify, how much space should be, to create a new appointment by drag and drop (see picture). Only values between 0 and 20 are valid. This value can be read and written both.
With the property you can specify, which is the default effect for new created appointments.
The property defines, if a full day appointment can be multi line or not. You also need to set the maximum lines with the property hmCal_prop_MaxLines.
With the property you can set, that appointments can overlap other appointments. If you set the value to 1, all appointments are drawn half overlapped. Use value 2 for fully overlapped. If you set the value to 0, all appointments are drawn not overlapped. The standard-value is 1. This value can be read and written both.
You can use the constants:
- hmCal_Overlapping_None
- hmCal_Overlapping_Half
- hmCal_Overlapping_Complete
Example:
(left: overlapped, right: not overlapped)
If you set the value to 1, all scrollbars will be only displayed if necessary. If you set the value to 0, all scrollbars are always visible. The standard-value is 0. This value can be read and written both.
The property returns the column width in the day view, user day view, user day view and user multi day view in pixels. If you are activate the option hmCal_prop_StaticArea you can also write this property. Else this option can be read only.
With the property you can set, if the time should be visible in the appointment header. The standard-value is 1. This value can be read and written both.
The property defines if the user can create appointments by dragging the mouse. This is possible in all views, except the month view. If activated the callback-event hmCal_NewAppointment will released. See chapter hmCal_INSTALL CALLBACK. This value can be read and written both.
The property defines if the delete key should be used in the calendar. If the delete key is deactivated the callback-event hmCal_DeleteAppointment will not released. See chapter hmCal_INSTALL CALLBACK. This value can be read and written both.
With the property you can freeze the current view vertically. The user cannot scroll anymore. This value can be read and written both.
With the property you can show or hide the headline of the month view. If you set the value to 1, the headline will be shown. If you set the value to 0, the headline will be hide. The standard-value is 1. This value can be read and written both.
With the property you can define the width of the left bar using the effect hmCal_Effect_LeftBar. Only values between 1 and 20 are valid. This value can be read and written both.
With the property you can freeze the current view horizontally. The user cannot scroll anymore. This value can be read and written both.
With this property you can indicate the user, that there are appointments outside the visible area. The property only works in the day view, multi day view and user day view.
With this property you can set the distance in minutes of the time captions of the vertical timeline. Default is 60 (minutes). This value can be read and written both.
Example:
The following example shows one hour. The caption of the y-axis shall be drawn every 15 minutes. Call the command as follows:
hmCal_SET AREA PROPERTY (hmCal;hmCal_prop_GridCaption;15)
And all halfhourlines shall be drawn every 5 minutes:
hmCal_SET AREA PROPERTY (hmCal;hmCal_prop_GridHalfHourLine;5)
That's the result:
With this property you can set the distance in minutes of the hourlines in the calendar. Default is 60 (minutes). This value can be read and written both.
With this property you can set the distance in minutes of the halfhourlines in the calendar. Default is 30 (minutes). This value can be read and written both.
Obsolete/Unsupported since hmCal 4.0
With this property you can define which text of an appointment is shown if the appointment is displayed as a single line. A value of 1 shows the header text and a value 0 shows the description text of the appointment. This value can be read and written both.
The following example define, that the header text is shown, if the appointment is displayed as a single line:
hmCal_SET AREA PROPERTY (calarea;hmCal_prop_OneLineCaption;1)
With this property you can define, if the timeline should be visible at each user. If you pass a value of 1 the timeline is repeated for each single user. This value can be read and written both.
Example view:
With this property you can define, if the timeline should be visible in the day view, user day view and the multi day view. This value can be read and written both.
With this property you can define, if the day header should be visible in the day view, user day view, user multi day view and the multi day view. This value can be read and written both.
With this property you can display an horizontal line with the current time in the day view, multi day view and user day view.
Example:
The property defines, if the iCalendar export (hmCal_Export Appointments) should always export as GMT time.
With this property, you can specify how big the multi day area in pixels should be. Pass 0 for automatically. That means the area will automatically resize depending on the number of full day appointments.
The property activates the month automatism in hmCal. The property is only valid in the month view. If the automatic is actived the month view begins with the 1st of the month. The number of weeks will automatically calculated. If the mode is deactivated, you can display weeks independent from the 1st of the month. For example you can show three weeks from August 15th.
With this property you can set whether the multi day area can be enlarged by the user or not. Pass 0 for disable or 1 for enable.
With this property, you can specify how many rows of the columns may be wrapped up. Pass a 0, then the number is unlimited. The property is only valid for the project view.
With this property, you can set the visibility of the time if the user drags an appointment. Pass a 0 for invisible and 1 visible. Standard is 1 for visible.
With this property you can define, if the header should turn to the week mode. This property is only valid in the project view. The value relates to seconds per pixel. Standard is 1500.
With this property you can define, if the header should turn to the month mode. This property is only valid in the project view. The value relates to seconds per pixel. Standard is 5000.
With this property you can define, if the header should turn to the quarter mode. This property is only valid in the project view. The value relates to seconds per pixel. Standard is 15000.
With this property you can define, if the header should turn to the year mode. This property is only valid in the project view. The value relates to seconds per pixel. Standard is 20000.
With this property you can set the width of the printing area. If you want to create an image with the command hmCal_Area To Picture you can change the width of the picture. Just pass the width of the picture in the parameter value. Pass 0 for the default size. This value can be read and written both.
With this property you can set the height of the printing area. If you want to create an image with the command hmCal_Area To Picture you can change the height of the picture. Just pass the height of the picture in the parameter value. Pass 0 for the default size. This value can be read and written both.
With this property you can get the needed height of the projectarea. See picture:
With this property you can set the default value of new appointments. Further informations in the chapter hmCal_Set App Property, property hmCal_aprop_DrawAsRect.
With this property you can define, if the resources/users are shown under the appointments in the project view. Default is 0. If you set 1, the users are shown under the appointment:
This property is obsolete.
With this property you can define, if the listview can be resized in width by the user. Pass 0 in value for resizeable or 1 for resizeable.
With this property you can activate or deactive the Auto-Update-Mode of appointments. Default the mode is activated. If the time range has changed in hmCal, the auto update mode deletes all appointments and the event hmCal_UpdateAppointments is called in the callback method. If you do not want the mechanism, you can deactivate this. Pass 0 in value for deactivation.
With this property you can define in the resources view, in how many columns each hour should be divided.
Example:
hmCal_SET AREA PROPERTY (eExt1;hmCal_prop_ResourcesHourGrid ;2)
With this property you can define the maximal count of lines, in which a full day appointment can break. Standard is 1.
With this property you can define the offset of the timeline in seconds. The setting only shift the timeline, not the appointments! Standard is 0.
With this property you can set the height of the appointments in the multi user view and the project view. You have to pass at least 20 (pixel) in value.
With this property you can show or hide the vertical hour-lines in the project view. Pass 1 for visible or 0 for invisible. Standard is 0.
With this property you can show or hide the week numbers in the month view. Pass 1 for visible or 0 for invisible. Standard is 0.
With this property you can set the width of the week numbers area in the month view. Pass the width in pixels. Standard is 40 pixels.
With this property you can activate the new month view. In the new month you can scroll in each day if there are too many appointments to show. Pass 1 for new month view or 0 for the old month view behaviour. Standard is 1 = new month view.
With this property you can define the maximum height (in pixels) of an appointment in the month view. Pass the height in pixels or 0 for automatically (unlimited). Standard is 0.
With this property you define, if the user can scroll in a day in the month view or not. The user can only scroll if there are too many appointments in a day, that scrolling is necessary.
Pass 1 for scrolling or 0 for not scrolling. Standard is 1.
With this property you define, if the appointment description text is visible on the bar in the project view. Pass 1 for visible or 0 for invisible. Standard is 1.
With this property you define an offset of the current time indicator line. Pass the count of seconds in value. Standard is 0.
With this property, you can define the size of the internal memory allocation. Standard is 100. The value defines, for how many appointments' memory is allocated. This is helpful, e. g. if you want to create several thousands appointments, you should set the value to the known count of these appointments. In this case, all necessary memory for the count of appointments will be allocated. This avoids coping memory through realloction.
With this property, you can get the needed space in pixels for the full-day-area of the day, week or user-day view. In all other views a value of 0 will be returned. This value can be read only.
With this property, you can set a vertical text offset in pixels within a column (user-week view, project view or resources view). Standard is 0.
This property is obsolete.
This property sets the standard height of full day appointments in the month view. Standard value is 16 pixels.
With this property you can activate (=1) a ghost appointment while dragging. That means, that the user can see the origin position of the appointment while dragging the appointment to a new position:
The option is deactivated (=0) by default.
With this property, you can define if an appointment can become a full day or not-full day appointment while dragging to the full day area or to the week view. This option is deactivated by default (=0).
If this property is set, relations are visible and supported in view hmCal_UserMultiDayView. This option is deactived by default.
With this property you can deactivate the auto-resize mechanism of hmCal. By default, all days, columns and apointments are fit to the current area size. If you want to set a specific width of each day, which will not change by resizing the area, you can activate this option (=1). This option is deactivated (=0) by default.
If this option is active, you also have to set hmCal_prop_StaticSecPerPixel to set the size of seconds per pixels and the hmCal_prop_ColumnWidth to set the width of the columns.
This mode is currently available for the following views:
- 1 - day view
- 2 - multi day view
- 9 - day user view
If hmCal_prop_StaticArea is active, you can set the count of seconds per pixel. If hmCal_prop_StaticArea is deactivated, you can read this option only, because it's calculated dynamically.
This option sets and gets the current scroll position of the horizontal scrollbar of the views with columns.
This property sets the timeline to s specific position: 1=left (Standard), 2=right.
This option gets and sets the first displayed user reference in the user day view. Pass 0 as reference, then hmCal scrolls to the first user.
If this property is set, appointments are displayed hierarchically in view hmCal_UserMultiDayView. This option is deactived by default. To set a user's hierarchy, you have to set a superior user in hmCal_Set User Property.
If the property is set to 1, the time line has a differnt format for full hours and non full hours. You can set the format with hmCal_SET FORMAT. 0=off is default.
Example with option off (default):
Example with option on:
This property defines the thickness of selected appointments. Standard is 2. You can set a value between 1 and 10.
This example sets the thickness of the selection to a size of 5 pixels:
hmCal_SET AREA PROPERTY (calArea;hmCal_prop_SelectionThickness;5)
Result:
This property defines for the User-Day-View, if the user description is shown instead of the date in the header (second row).
This property defines for the User-Multi-Day-View and Year view, if a new appointment is created as a full day appointment.
This property defines the ID for new appointments. This ID is a placeholder for manipulation appointment properties within the callback event hmCal_CreateNewAppointment. Default is -1.
This property defines if the current time indicator is moveable. 1 for yes and 0 for no (default).
This property sets a custom time for the current time indicator. The value is a time stamp which you can convert from hmCal_Date2Seconds. Default is 0 which is the current time.
This property defines the edge, of an appointment. This is the thickness of the frame. Default value is 2.0
This property defines if the user list in the user multi day view is sortable. Pass 1 for sortable or 0 for non-sortable (default).
This property defines, if the selection of an appointment is set to "frame" or "invert". Invert means, that the foreground color is hidden and the header and description text uses a special color values: hmCal_clr_AppHeadertextInv and hmCal_clr_AppDescrtextInv. This option is available for the hmCal_Effect_LeftBar-effect only.
Unselected:
Selected:
This property defines, if three lines are shown in the header of the user multi day view and project view. Default are two lines.
Example of three lines:
This property defines the barheight of all appointments. If barheight is 0 (which is the default value), the barheight will be calculated automatically.
With this property, you can set an offset for the time text of the time line. A negative values moves the text in the given pixels up and a positive value moves it down. Default is 0.
This property defines the height of the first header line in pixels. Default value is 16.
This property defines the height of the second header line in pixels. Default value is 16.
This property defines the height of the third header line in pixels. Default value is 16.
This property defines if the vertical day separator-line of the multi day view goes from the header (value=1, default) or from the calendar-area (value=0).
The property defines the scroll increment of the scrollbar (same for mouse wheel) per step. Default value is 1800 (seconds). This is for views only, where the scrolling is time-based. For pixel-based increment use hmCal_prop_ScrollIncrementPixels.
If this property is set to 1, the description text of the appointment is shown next to the bar on the right side.
Example:
The property defines the scroll increment of the scrollbar (same for mouse wheel) per step. Default value is 5 (pixels). This is for views only, where the scrolling is pixel-based. For time-based increment use hmCal_prop_ScrollIncrementSeconds.
The property defines, if the icons should be displayed on the right side of the appointments. Default value is 0.
The property defines, if the bullet in front of each appointment is visible in month view. Default value is 1.
The following example get the width of the user list in the user week view and increases the value around 10 pixels:
C_LONGINT($vl_width)
$vl_width=hmCal_Get Area Property(hmCal;hmCal_prop_UserListWidth)
hmCal_SET AREA PROPERTY(hmCal;hmCal_prop_UserListWidth;$vl_width+10)