OrganizerListAppointment (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

OrganizerListAppointment (Function)

In french: AgendaListeRendezVous

Returns:

the list of appointments found between two dates in an Organizer control,
all appointments found in an Organizer control,
a specific appointment (selected or hovered).

Versions 17 and later

This function can now be used to handle the Organizer controls found in a report.

New in version 17

This function can now be used to handle the Organizer controls found in a report.

Versions 18 and later

This function is now available for PHP sites.

New in version 18

This function is now available for PHP sites.

This function is now available for PHP sites.

Example

// List all the appointments of the Organizer control
arrApt is array of Appointment
arrApt = OrganizerListAppointment(ORG_MyOrganizer)

// Adds the appointments into a Table control
FOR EACH gMyAppointment OF arrApt
TableAddLine(TABLE_Table1, gMyAppointment.StartDate, ...
gMyAppointment.EndDate, gMyAppointment.Title)
END

// Lists the appointments from today's date
arrApt is array of Appointment
arrApt = OrganizerListAppointment(ORG_MyOrganizer, DateSys())

Syntax

Retrieving the list of appointments found between two dates Hide the details

<Result> = OrganizerListAppointment(<Organizer control> [, <Start date> [, <End date>]])

<Result>: Array of Appointment variables

Array containing the Appointment variables.
If an appointment corresponding to the specified criteria exists, this array will contain a single element.
If no appointment corresponds to the specified criteria, this array will contain 0 appointment.

<Organizer control>: Control name

Name of Organizer control to use. This control can correspond to:
Versions 18 and later
an Organizer control in a page.
New in version 18
an Organizer control in a page.
an Organizer control in a page.

<Start date>: Optional DateTime variable

Start date for selecting the appointments.
If this parameter is not specified, all the appointments found in the Organizer control will be returned.

<End date>: Optional DateTime variable

End date for selecting the appointments.
If this parameter is not specified, all appointments found from <Start date> will be returned.

Retrieving the information about a specific appointment Hide the details

<Result> = OrganizerListAppointment(<Organizer control> , <Type of appointment>)

<Result>: Array of Appointment variables

Array containing the Appointment variable.
If an appointment corresponding to the specified criteria exists, this array will contain a single element.
If no appointment corresponds to the specified criteria, this array will contain 0 appointment.

<Organizer control>: Control name

Name of Organizer control to use. This control can correspond to:
Versions 18 and later
an Organizer control in a page.
New in version 18
an Organizer control in a page.
an Organizer control in a page.

<Type of appointment>: Integer constant

Type of sought appointment:
orgAptSelected Appointment currently selected in the Organizer control. If no appointment is selected, <Result> will correspond to an array of 0 element.
orgAptHovered Appointment hovered by the mouse cursor in the Organizer control. If no appointment is hovered, <Result> will correspond to an array of 0 element.
This constant is not available.

Component: wd260mdl.dll