PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
This content has been translated automatically. Click here to view the French version.
  • Using the Appointment type
  • Properties specific to the management of Organizer and Scheduler controls
  • Properties specific to the management of Appointment functions
  • Functions that use the Appointment variables
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
The Appointment type is used to define the advanced characteristics of an appointment: time, location, ...
This type of variable can be used:
  • WINDEVWEBDEV - Server codeWEBDEV - Browser codeAndroidAndroid Widget iPhone/iPadIOS WidgetMac CatalystPHP in an Organizer control or in a Scheduler control. The Appointment type will be handled by the WLanguage functions for managing the Organizer controls or the Scheduler controls.
  • AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst by the functions for appointment management on an Android or iOS device.
The characteristics of this appointment can be defined and modified using different WLanguage properties.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
Versions 21 and later
iPhone/iPad This type of variable is now available for iPhone/iPad applications.
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
Universal Windows 10 App In Universal Windows 10 App mode, this type of variable can only be used to handle the appointments of the Scheduler controls found in a report.
New in version 21
iPhone/iPad This type of variable is now available for iPhone/iPad applications.
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
Universal Windows 10 App In Universal Windows 10 App mode, this type of variable can only be used to handle the appointments of the Scheduler controls found in a report.
iPhone/iPad This type of variable is now available for iPhone/iPad applications.
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
Universal Windows 10 App In Universal Windows 10 App mode, this type of variable can only be used to handle the appointments of the Scheduler controls found in a report.
Example
// Construction d'une variable de type RendezVous
MonRendezVous is Appointment
 
// Le rendez-vous commence immédiatement et dure deux heures
MonRendezVous.StartDate = DateSys() + TimeSys()
MonRendezVous.EndDate = MonRendezVous.StartDate
MonRendezVous.EndDate.Hour = MonRendezVous.EndDate.Hour + 2
 
MonRendezVous.Title = "Rendez-vous avec le directeur commercial"
MonRendezVous.Importance = 1
MonRendezVous.Guest = "Michel, Antoine, Sandra"
MonRendezVous.Content = "Mise au point de la nouvelle grille de tarifs"
MonRendezVous.Note = "Penser à prendre le dossier bleu."
MonRendezVous.ToolTip = MonRendezVous.Title + CR + MonRendezVous.Note
 
// Ajout du rendez-vous dans l'agenda
OrganizerAddAppointment(AGD_MonAgenda, MonRendezVous)
// Adds an appointment by using the Appointment type and with repetition
// Every first Monday of the month
// a Monday found in days from 1 to 7 of the month = 1st of month.
 
x is Appointment
x.StartDate = Today() + "1200"
x.EndDate = Today() + "1400"
x.WithRepetition = True
y is Répétition
y.Type = schEveryDay
y.DayOfWeek = 1
y.DayOfMonth = "1-7"
y.DayOfMonthOrDayOfWeek = False
x.Répétition = y
 
OrganizerAddAppointment(ORG_Organizer, x)
Versions 18 and later
AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst
gRDV is Appointment
gCal is Calendar
tabCalendrier is array of Calendar
// Récupère la liste des calendriers
tabCalendrier = AppointmentListCalendar()
gCal = tabCalendrier[1]
 
// Ajout d'un nouveau rendez-vous dans le premier calendrier
gRDV.Title = SAI_Titre
gRDV.StartDate = SAI_DateDeb + SAI_HeureDeb
gRDV.EndDate = SAI_DateFin + SAI_HeureFin
gRDV.Location = SAI_Lieu
gRDV.Content = SAI_Desc
IF SAI_Fuseau <> "" THEN
gRDV.TimeZone = SAI_Fuseau
END
gRDV.Author = SAI_Auteur
gRDV.Guest = SAI_Invités
gRDV.WholeDay = INT_Jentière[1]
 
IF AppointmentAdd(gCal, gRDV) THEN
ToastDisplay("RDV ajouté")
ELSE
Error(ErrorInfo())
END
New in version 18
AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst
gRDV is Appointment
gCal is Calendar
tabCalendrier is array of Calendar
// Récupère la liste des calendriers
tabCalendrier = AppointmentListCalendar()
gCal = tabCalendrier[1]
 
// Ajout d'un nouveau rendez-vous dans le premier calendrier
gRDV.Title = SAI_Titre
gRDV.StartDate = SAI_DateDeb + SAI_HeureDeb
gRDV.EndDate = SAI_DateFin + SAI_HeureFin
gRDV.Location = SAI_Lieu
gRDV.Content = SAI_Desc
IF SAI_Fuseau <> "" THEN
gRDV.TimeZone = SAI_Fuseau
END
gRDV.Author = SAI_Auteur
gRDV.Guest = SAI_Invités
gRDV.WholeDay = INT_Jentière[1]
 
IF AppointmentAdd(gCal, gRDV) THEN
ToastDisplay("RDV ajouté")
ELSE
Error(ErrorInfo())
END
AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst
gRDV is Appointment
gCal is Calendar
tabCalendrier is array of Calendar
// Récupère la liste des calendriers
tabCalendrier = AppointmentListCalendar()
gCal = tabCalendrier[1]
 
// Ajout d'un nouveau rendez-vous dans le premier calendrier
gRDV.Title = SAI_Titre
gRDV.StartDate = SAI_DateDeb + SAI_HeureDeb
gRDV.EndDate = SAI_DateFin + SAI_HeureFin
gRDV.Location = SAI_Lieu
gRDV.Content = SAI_Desc
IF SAI_Fuseau <> "" THEN
gRDV.TimeZone = SAI_Fuseau
END
gRDV.Author = SAI_Auteur
gRDV.Guest = SAI_Invités
gRDV.WholeDay = INT_Jentière[1]
 
IF AppointmentAdd(gCal, gRDV) THEN
ToastDisplay("RDV ajouté")
ELSE
Error(ErrorInfo())
END
Remarks

Using the Appointment type

The Appointment type can be used to manage the Organizer and Scheduler controls and to manage the contacts via the Appointment functions.
This help page presents:

Properties specific to the management of Organizer and Scheduler controls

The following properties can be used to handle an appointment:
Property nameType usedEffect
AuthorCharacter stringName of appointment author. If this property is not specified, the appointment has no author.
WEBDEV - Browser code This property is not available.
WithRepetitionBoolean
  • True if the appointment must be repeated,
  • False if the appointment takes place once only.
If the appointment is repeated, the Repetition property allows you to specify the frequency of the repetition.
This property is set to False by default.
WEBDEV - Browser code This property is not available.
ToolTipCharacter stringTooltip displayed when the appointment is hovered. By default, this value includes the start time and the end time of appointment as well as the appointment title.
AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst This property is not available.
CategoryCharacter stringCategory of appointment. If this property is not specified, the appointment is associated with no category.
ContentCharacter stringDetailed description of the appointment.
For a Scheduler control (or for an Organizer control), the content is displayed in the control.
If this property is not specified, the appointment has no description.
BackgroundColorIntegerBackground color used to display the appointment in the Organizer control or in the Scheduler control.
This color can correspond to:If this property is not specified, a color will be automatically calculated. The appointments found in the same category will have the same color.
Before version 24, this property was named "BackgroundColor".
StartDateCharacter string or DateTime variableStart date and time of the appointment. A valid date must be assigned to this property before using the variable.
This property must necessarily be specified.
EndDateCharacter string or DateTime variableEnd date and time of the appointment. A valid date must be assigned to this property before using the variable.
This property must necessarily be specified.
IDCharacter stringIdentifier associated with the appointment. Allows you to store the identifier of an element that must be associated with the appointment in order to use it later in programming.
For example, this identifier can correspond to the identifier of a record in a database.
ImageCharacter stringImage associated with the appointment. This image is displayed in the Organizer control or in the Scheduler control (in addition to the logo that represents an important appointment if necessary).
This property can correspond to:
  • the path to an image accessible from the current computer,
  • an image file found in the application library,
  • an Image control containing an image,
  • a drawing performed in an Image control with the drawing functions and saved in memory.
If this property is not specified, the appointment has no associated image.
WEBDEV - Server code The image file must be found in the <Project_Name>_WEB directory. The specified path must be relative to this directory.
WEBDEV - Browser code This property is not available.
ImportanceIntegerImportance of appointment.
If this Property is greater than or equal to 1, a pictogram ( Pictogram for important appointment. ) will be displayed in the Organizer control or in the Scheduler control to indicate an important appointment.
If this property is not specified, its value is set to 0.
WEBDEV - Browser code This property is not available.
Versions 18 and later
WholeDay
New in version 18
WholeDay
WholeDay
Boolean
  • True if the appointment is an appointment for the entire day.
  • False otherwise (default value).
WINDEVWEBDEV - Server codeWEBDEV - Browser codePHP Caution: In order for the appointment for the entire day to be properly displayed in the control, "Display and allow the appointments for the entire day" must be checked in the "Details" tab of the control description.
LocationCharacter stringLocation of appointment.
If this property is not specified, the appointment has no location.
WEBDEV - Browser code This property is not available.
NoteCharacter stringNote associated with the appointment.
If this property is not specified, no note is associated with the appointment.
WEBDEV - Browser code This property is not available.
Versions 22 and later
Order
New in version 22
Order
Order
IntegerOrder of appointments (for overlapping appointments).
WEBDEV - Server codeWEBDEV - Browser codePHP This property is not available.
RepetitionRepetition variableAdvanced parameters of repetition. This property is taken into account only if the WithRepetition property is set to True.
WEBDEV - Browser code This property is not available.
ResourceCharacter stringResource associated with the appointment. This property is taken into account only when the appointment is used by a Scheduler control.
TitleCharacter stringAppointment title. The title is displayed in the Organizer control or in the Scheduler control.
If this property is not specified, the appointment has no title.
AndroidAndroid Widget iPhone/iPadIOS WidgetMac Catalyst

Properties specific to the management of Appointment functions

The following properties can be used to handle an appointment:
Property nameType usedEffect
AuthorCharacter stringName of appointment author. If this property is not specified, the appointment has no author.
iPhone/iPadIOS WidgetMac Catalyst This property is not supported.
Versions 18 and later
Calendar
New in version 18
Calendar
Calendar
Calendar variable
  • Calendar to which the appointment belongs.
  • Null if the appointment belongs to no calendar.
  • Calendar to which the appointment belongs.
  • Null if the appointment belongs to no calendar.
To add an appointment to a given calendar, use AppointmentAdd.
ContentCharacter stringDetailed description of the appointment.
If this property is not specified, the appointment has no description.
StartDateCharacter string or DateTime variableStart date and time of the appointment. A valid date must be assigned to this property before using the variable.
The start time of the appointment is always expressed in the time zone associated with the appointment. The name of the time zone is returned by the TimeZone property
EndDateCharacter string or DateTime variableEnd date and time of the appointment. A valid date must be assigned to this property before using the variable.
The end time of the appointment is always expressed in the time zone associated with the appointment. The name of the time zone is returned by the TimeZone property
Versions 18 and later
TimeZone
New in version 18
TimeZone
TimeZone
Character stringName of time zone for the start and end times of appointment. This name must correspond to the full name of the time zone defined by the IANA Time Zone Database. For example: "Europe/Paris", "Europe/London", "America/New_York", etc.
This property is initialized by default with the current time zone. To reinitialize this property with the current time zone, use "" (empty string).
IDCharacter stringIdentifier associated with the appointment. Allows you to store the identifier of an element that must be associated with the appointment in order to use it later in programming.
This property is read-only. This property is automatically filled when reading the appointment in the corresponding calendar. We do not advise you to store this identifier beyond the lifetime of the application because this identifier can be modified when synchronizing the calendars.
GuestCharacter stringList of persons invited to the appointment.
If this property is not specified, the appointment has no guest.
The value of this property has the following format:
<Nom Invité 1> + TAB + <Email Invité 1> + RC + ...
+ RC + <Nom Invité N> + TAB + <Email Invité N>
iPhone/iPadIOS WidgetMac Catalyst This property is available in read-only mode.
Versions 18 and later
WholeDay
New in version 18
WholeDay
WholeDay
Boolean
  • True if the appointment is an appointment for the entire day.
  • False otherwise (default value).
If this property is set to True:
  • the time zone associated with the appointment must correspond to "UTC",
  • the start and end times of the appointments must be set to midnight.
Example: Appointments for July 17, 2012:
Rdv is Appointment
Rdv.StartDate = "201201170000"
Rdv.EndDate = "201201180000"
Rdv.WholeDay = True
LocationCharacter stringLocation of appointment.
If this property is not specified, the appointment has no location.
Versions 18 and later
Reminder
New in version 18
Reminder
Reminder
Array of Reminder variablesArray containing the list of reminders associated with the appointment. If no reminder is associated with the appointment, the array is empty.
TitleCharacter stringAppointment title.
If this property is not specified, the appointment has no title.

Functions that use the Appointment variables

Minimum version required
  • Version 16
This page is also available for…
Comments
Click [Add] to post a comment