Events associated with an Organizer control

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / Developing an application or site / Controls, windows and pages / Controls: Available types / Organizer control

Events managed by default (window control)
Events with procedures for quick use
Advanced use of events with procedure
Optional events

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Events associated with an Organizer control

Events managed by default (window control)

WINDEV and WINDEV Mobile manage the following events by default (order of appearance in the code editor):

Event	Runtime condition

Initializing	Run when the window is opened. *
Before creating the appointment	Run when selecting "New appointment" in the context menu of Organizer control.
Entry in edit in an appointment	Run when selecting "New appointment" in the context menu of Organizer control. This event is run immediately after the event "Before creating the appointment".
Exit from input for the appointment	Run when exiting the input of an appointment (e.g., exit when adding an appointment or when editing an appointment via the context menu)
Selecting an appointment	Run when selecting an existing appointment in the Organizer control. This event is executed when the popup menu opens.
Moving an appointment	Run when moving an appointment in the Organizer control (move performed with the mouse for example).
Resizing an appointment	Run when resizing an appointment in the Organizer control (resize operation performed with the mouse for example).
Deleting an appointment	Run when selecting "Delete the appointment" in the context menu of Organizer control.
Range selection	Run when selecting a time range in the Organizer control.
Whenever changing period	Run when modifying the period displayed in the Organizer control.
Whenever changing the display mode	Run when the user changes the display mode of Organizer control. The new mode can be known in this event via OrganizerMode.

(*) By default, the "Initializing" event of each control is run according to the order in which the controls were created in the window. To modify this order of execution:

On the "Window" tab, in the "Order" group, click "Initialization".
In the window displayed, use the arrows on the right to modify the order in which the controls are initialized.

WEBDEV manages the following events by default (order of appearance in the code editor):

Event	Runtime condition

Initialization (server code)	Run when the page is opened.
Moving an appointment (server code)	Run when moving an appointment in the Organizer control (move performed with the mouse for example).
Resizing an appointment (server code)	Run when resizing an appointment in the Organizer control (resize operation performed with the mouse for example).
Deleting an appointment (server code)	Run during the click on the cross found at the top right of selected appointment.
Before creating the appointment (server code)	Run when creating an appointment with the mouse (before the input performed by the user).
Exit from appointment input (server code)	Run when exiting from the appointment in input.
Whenever the period changes (server code)	Run when modifying the period displayed in the Organizer control.
Selecting an appointment (browser code)	Run when selecting an existing appointment in the Organizer control. This event is run when an appointment is clicked on.
Moving an appointment (browser code)	Run when moving an appointment in the Organizer control (move performed with the mouse for example).
Resizing an appointment (browser code)	Run when resizing an appointment in the Organizer control (resize operation performed with the mouse for example).
Selecting a period (browser code)	Run when selecting a time range in the Organizer control.
Deleting an appointment (browser code)	Run during the click on the cross found at the top right of selected appointment.
Before creating the appointment (browser code)	Run when creating an appointment with the mouse (before the input performed by the user).
Enter an appointment in input (browser code)	Run when selecting "New appointment" in the context menu of Organizer control. This event is run immediately after the event "Before creating the appointment".
Exit from appointment input (browser code)	Run when exiting from the appointment in input.
Whenever changing period (browser code)	Run when modifying the period displayed in the Organizer control.

Events with procedures for quick use

Most of the events associated with the Organizer control are run:

when using the context menu of the Organizer control.
when using the mouse or the fingertips.
when using the deletion cross.

To simplify the operations performed on the appointments of an Organizer control, several procedures are proposed in each event. These procedures take the appointment variable (Appointment variable) as parameter. All the characteristics of the appointment handled by the popup menu, by the mouse or fingertips are automatically assigned to this variable.

Example: To store an appointment added by the user via the popup menu in an APT data file, simply write the following in the event "Entry in edit in an appointment":

PROCÉDURE Edit(aptEdited is Appointment)

// Store the data
APT.Title = aptEdited.Title
APT.StartDate = aptEdited.StartDate
APT.EndDate = aptEdited.EndDate
...
HAdd(APT)

Advanced use of events with procedure

You can also allow the user to define more precisely the characteristics of his appointment during an addition or a modification.

To do so, create a window with the information to specify.

In the code, simply open the window in the event "Entry in edit in an appointment". To lock the direct input via the context menu of the Organizer control, the event must return False.

This principle can be applied to all the events called by the context menu of the Organizer control.

Example:

PROCÉDURE Edit(aptEdited is Appointment)

// Opens the window for entering an appointment
// with the selected appointment (in Creation or Modification mode)
Open(WIN_InputAPT_HFSQL, aptEdited)

// Returns False to lock the direct input in the Organizer control
RESULT False

To do so, create a popup with the information to fill.

In the code, simply open the popup in the browser event "Enter the appointment in input".

Example:

PROCEDURE EnterInInput(aptEdited is Appointment)

// Open the edit popup
POPUP_Modification.EDT_Title = aptEdited.Title
POPUP_Modification.EDT_Content = aptEdited.Content

IF aptEdited.Category = "Personal" THEN
POPUP_Modification.COMBO_Category = 1
ELSE
POPUP_Modification.COMBO_Category = 2
END

IF aptEdited.ID = 0 THEN
POPUP_Modification.BTN_Delete.Visible = False
END

PopupDisplay(POPUP_Modification)

Optional events

Several optional events are supported. To add an optional event:

Select the desired control.
Display the code window of this control (F2 key).
Click the link "Add other events to xxx" at the bottom of the window code, after the last event.
All the optional events available for the control are displayed.
Check the optional event to add and validate.
Remark: You can select several optional events.
The selected optional event is automatically added to the events managed by the control.

To disable an optional event, simply perform the same operations to display the list of optional events. Then simply uncheck the optional events to delete.
Remark: If the disabled code contains WLanguage code, this code is automatically deleted.

You can manage, for example:

the mouse hover over the control,
left mouse button down, up, with a double click,
right mouse button down, up, double click,
mouse wheel, etc.

For more details, see the Optional events.