|
|
|
|
|
- Overview
- Manipulating Organizer controls programmatically
- Adding an appointment
- Filling an Organizer control with the data found in an HFSQL data file
- Retrieving a list of appointments
- Displaying an Organizer control from a specific date
- Delete an appointment
- Modifying the control display options
- Using the context menu (AAF)
- Management of public holidays
- Properties specific to Organizer controls
Manipulating Organizer controls programmatically
An Organizer control can be: - manipulated programmatically.
WINDEV and WEBDEV include the OrganizerXXX functions to manipulate Organizer controls. This help page explains how to programmatically manipulate an Organizer control in a window or page. The example used in the illustration allows you to store appointments in an HFSQL database. Manipulating Organizer controls programmatically Adding an appointment You can add an appointment to an Organizer control using OrganizerAddAppointment. This function accepts two syntaxes: - syntax for specifying appointment features: title, description, etc..
OrganizerAddAppointment(ORG_MyOrganizer, "Sales meeting", "201003220845", ...
"201003221230", "Sales")
- syntax that handles a variable of type Appointment.
MyAppointment is Appointment
MyAppointment.Title = "Sales meeting"
MyAppointment.Content = "Meeting to discuss the weekly objectives."
MyAppointment.StartDate = "201003220845"
MyAppointment.EndDate = "201003221230"
MyAppointment.Category = "Sales"
MyAppointment.ID = 1
OrganizerAddAppointment(ORG_Organizer, MyAppointment)
The BackgroundColor property of the Appointment variable is used to define a display color for an appointment. If no background color is defined, the Organizer control will automatically use the color associated with the appointment category. Filling an Organizer control with the data found in an HFSQL data file The records are stored in an HFSQL data file. The Organizer control can be initially filled by browsing the data file via the FOR EACH syntax and by adding each appointment via OrganizerAddAppointment.
MyAppointment is Appointment
FOR EACH APT
MyAppointment.Title = APT.Title
MyAppointment.Content = APT.Content
MyAppointment.StartDate = APT.StartDate
MyAppointment.EndDate = APT.EndDate
MyAppointment.Category = APT.Category
MyAppointment.ID = APT.APTID
OrganizerAddAppointment(ORG_MyOrganizer, MyAppointment)
END
Reminder: It's also possible to use an Organizer control linked to a data file. For more details, see Organizer control linked to a data file.Retrieving a list of appointments - the list of all the appointments found in the organizer control:
arrAppointmentList is array of Appointment
arrAppointmentList = OrganizerListAppointment(ORG_MyOrganizer)
- the list of appointments included between two dates:
arrAppointmentList is array of Appointment
arrAppointmentList = OrganizerListAppointment(ORG_MyOrganizer, "20100101", "20100131")
- the appointment currently selected or hovered:
arrAppointmentList is array of Appointment
arrAppointmentList = OrganizerListAppointment(ORG_MyOrganizer, orgAptSelected)
Displaying an Organizer control from a specific date To display the Organizer control from a specific date, use OrganizerPosition.
OrganizerPosition(AGD_Agenda1, Today())
OrganizerPosition(AGD_Agenda1, "20221220")
Delete an appointment - the appointment selected in the control.
- a specific appointment.
OrganizerDeleteAppointment(ORG_MyOrganizer, 1)
OrganizerDeleteAll deletes all the appointments from the Organizer control. Modifying the control display options The current display of an Organizer control can be modified by the following functions: Using the context menu (AAF) Management of public holidays Public holidays can be set programmatically. Several WLanguage functions (starting with BankHolidayXXX) are available. To define the bank holidays displayed in the Organizer controls and in the Calendar controls, you must use BankHolidayAdd. This function allows you to define the list of public holidays to be used. This function allows you to customize the public holidays according to the country and local regulations. This function must be used at the beginning of the application because it has a global effect on the application. The bank holidays will be colored in green in the Organizer control. Example:
BankHolidayDeleteAll()
BankHolidayAdd("0101")
BankHolidayAdd(bhEasterMonday)
BankHolidayAdd("0501")
BankHolidayAdd("0508")
BankHolidayAdd(bhAscensionDay)
BankHolidayAdd(bhWhitMonday)
BankHolidayAdd("0714")
BankHolidayAdd("0815")
BankHolidayAdd("1101")
BankHolidayAdd("1111")
BankHolidayAdd("1225")
BankHolidayAdd("1226" + CR + bhGoodFriday)
Properties specific to Organizer controls The following properties can be used to manipulate Organizer controls.
| | DirectInputAPT | The DirectInputAPT property is used to determine and specify if the user can directly change the title of an appointment in a Scheduler or Organizer control. | GranularityAppointment | The GranularityAppointment gets and changes the precision of the grid used to define appointments in Organizer or Scheduler controls.
Property retained by compatibility. | GranularityDuration | The GranularityDuration property gets and sets the size of the grid to resize:- appointments in an Organizer control.
- appointments in a Scheduler control.
- events in a TimeLine control.
- tasks in a Gantt Chart column.
| GranularityMovement | The GranularityMovement property gets and sets the size of the grid to move: - appointments in an Organizer control.
- appointments in a Scheduler control.
- events in a TimeLine control.
- tasks in a Gantt Chart column.
| MaskTitleDate | The MaskTitleDate property is used to identify and change the input mask used for the title of day columns in Organizer or Scheduler controls | ModificationDurationAPT | The ModificationDurationAPT property is used to determine and specify if the user can modify the duration of an appointment in a Scheduler or Organizer control. | MovementAPT | The MovementAPT property allows you to know and specify whether users can move appointments in a Scheduler or Organizer control. | Num1stDayOfTheWeek | The Num1stDayOfTheWeek property gets and sets the 1st day of the week displayed in:- a Calendar control.
- an Organizer control.
- a Scheduler control.
- an Edit control in Date format with Calendar.
| PeriodSelection | The PeriodSelection property is used to determine and specify if the user can select a time period in an Scheduler or Organizer control. | WorkingHourEnd | The WorkingHourEnd property is used to identify and change the end time of working hours used:- by an Organizer control.
- by a Scheduler control.
- by a Gantt Chart column (in a Table or TreeView Table control).
| WorkingHourStart | The WorkingHourStart property gets and sets the start time of working hours used: - by an Organizer control.
- by a Scheduler control.
- by a Gantt Chart column (in a Table or TreeView Table control).
|
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|