<Organizer>.ListAppointment (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Organizer functions

Prefix syntax

ListAppointment

Presentation

Example

See also

<Organizer>.ListAppointment (Function)

In french: <Agenda>.ListeRendezVous

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).

In Universal Windows 10 App mode, this function can only be used to handle Organizer controls in a report.

Example

// Lists all appointments found in the organizer
arrApt is array of Appointment
arrApt = ORG_Organizer1.ListAppointment()
// Adds the appointments into a Table control
FOR EACH gMyAppointment OF arrApt
TABLE_Table1.AddLine(gMyAppointment.StartDate, ...
gMyAppointment.EndDate, gMyAppointment.Title)
END

// Lists the appointments from today's date
arrApt is array of Appointment
arrApt = ORG_Organizer1.ListAppointment(DateSys())

Syntax

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

<Result> = <Organizer control>.ListAppointment([<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 the Organizer control to be used. This control can correspond to:
an Organizer control in a window.

<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> = <Organizer control>.ListAppointment(<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 the Organizer control to be used. This control can correspond to:
an Organizer control in a window.

<Type of appointment>: Integer constant

Type of sought appointment:
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.
orgAptSelected Appointment currently selected in the Organizer control. If no appointment is selected, <Result> will correspond to an array of 0 element.

Component: wd270mdl.dll