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

Contents

Description

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.

Properties

hmCal_prop_UserListWidth (1)

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.

hmCal_prop_MultiDayArea (2)

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.

hmCal_prop_SwitchUser (3)

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.

hmCal_prop_NewLineHeight (4)

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.



hmCal_prop_DefaultEffect (5)

With the property you can specify, which is the default effect for new created appointments.

hmCal_prop_Overlapping (7)

With the property you can set, that appointments can overlap other appointments. If you set the value to 1, all appointments are drawn 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.

Example:

(left: overlapped, right: not overlapped)

hmCal_prop_ScrollAutoHide (8)

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.

hmCal_prop_ColumnWidth (9)

The property returns the column width in the day view, week view user day view and user multi day view in pixels. The can only read the value.

hmCal_prop_DisplayTime (10)

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.

hmCal_prop_AllowDragNew (11)

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.

hmCal_prop_DeleteKey (12)

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.

hmCal_prop_FreezeView_V (13)

With the property you can freeze the current view vertically. The user cannot scroll anymore. This value can be read and written both.

hmCal_prop_ShowMonthHeader (14)

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.

hmCal_prop_LeftBarWidth (15)

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.

hmCal_prop_FreezeView_H (16)

With the property you can freeze the current view horizontally. The user cannot scroll anymore. This value can be read and written both.

hmCal_prop_IndicateOutsideApp (17)

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.



hmCal_prop_GridCaption (18)

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:



hmCal_prop_GridHourLine (19)

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.

hmCal_prop_GridHalfHourLine (20)

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.

hmCal_prop_Add3points (21)

Obsolete/Unsupported since hmCal 4.0

hmCal_prop_OneLineCaption (22)

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)

hmCal_prop_RepeatTimeline (23)

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:


hmCal_prop_ShowTimeline (24)

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.

hmCal_prop_ShowHeader (25)

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.

hmCal_prop_CurrentTimeIndicator (26)

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:


hmCal_prop_GMTexport (27)

The property defines, if the iCalendar export (hmCal_Export Appointments) should always export as GMT time.

hmCal_prop_MultiDayAreaHeight (28)

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.

hmCal_prop_AutoMonthWeeks (29)

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.

hmCal_prop_MultiDayAreaResize (30)

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.

hmCal_prop_ColumnLines (31)

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.

hmCal_prop_DragTimeVisible (32)

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.

hmCal_prop_proj_scaleweek (33)

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.

hmCal_prop_proj_scalemonth (34)

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.

hmCal_prop_proj_scalequarter (35)

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.

hmCal_prop_proj_scaleyear (36)

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.

hmCal_prop_PrintingWidth (37)

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.

hmCal_prop_PrintingHeight (38)

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.

hmCal_prop_ProjectAreaHeight (39)

With this property you can get the needed height of the projectarea. See picture:


hmCal_prop_DrawAsRect (40)

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.

hmCal_prop_ShowResources (41)

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:



hmCal_prop_UserListLock (43)

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.

hmCal_prop_AutoUpdateApp (44)

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.

hmCal_prop_Lineheight (48)

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.

Example

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)