SchedulerListAppointment (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.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Scheduler functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SchedulerListAppointment (Function)

In french: PlanningListeRendezVous

Returns:

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

Example

// Liste tous les rendez-vous du champ Planning
tabRdv is array of Appointment
MaRessource = "Françoise"
tabRdv = SchedulerListAppointment(PLN_Planning)
// Ajoute les rendez-vous dans un champ Table
FOR EACH gMonRendezVous OF tabRdv
	TableAddLine(TABLE_Table1, MaRessource, ...
		gMonRendezVous.DateDébut, gMonRendezVous.DateFin, gMonRendezVous.Titre)
END

// Liste les rendez-vous à partir de la date du jour
tabRdv is array of Appointment
tabRdv = SchedulerListAppointment(PLN_Planning, MaRessource, DateSys())

Syntax

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

<Result> = SchedulerListAppointment(<Scheduler control> [, <Resource> [, <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 zero appointments.

<Scheduler control>: Control name

Name of the Scheduler control to be used. This field may correspond to:
the Scheduler control of a window,
the Scheduler control of a page,
the Scheduler control of a report.

<Resource>: Optional character string

Name of resource to which the appointments will be associated. If this parameter is not specified (or is an empty string), all appointments for all resources will be returned.
Note If schedule resources have been created with function SchedulerAddResource using function gStoredValue, this parameter must correspond to the value specified in function gStoredValue for this resource.

<Start date>: Optional DateTime variable

Start date for selecting the appointments.
If this parameter is not specified, all the appointments found in the Scheduler 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> = SchedulerListAppointment(<Scheduler control> , <Type of appointment>)

<Result>: Array of Appointment variables

Name of 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 zero appointments.

<Scheduler control>: Control name

Name of the Scheduler control to be used. This field may correspond to:
the Scheduler control of a window,
the Scheduler control of a page,
the Scheduler control of a report.

<Type of appointment>: Integer constant

Type of sought appointment:
schAptHovered Appointment hovered by the mouse cursor in the Scheduler control. If no appointment is hovered over, <Résultat> will correspond to an array of 0 elements..
This constant is not available.
schAptSelected Appointment currently selected in the Scheduler control. If no appointments are selected, <Résultat> will correspond to an array of 0 elements.

Component: wd300mdl.dll