Appointment (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Using the Appointment type
Properties specific to Organizer and Scheduler controls
Properties specific to the management of Appointment functions
Functions that use Appointment variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Appointment (Type of variable)

In french: RendezVous

The Appointment type is used to define the advanced characteristics of an appointment: time, location, ...

This type of variable can be used:

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.
by the functions for appointment management on an Android or iOS device.

You can define and change the characteristics of this appointment 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.

In Universal Windows 10 App mode, this type of variable can only be used to manipulate the appointments of the Scheduler controls found in a report.

Example

// Build an Appointment variable
MyAppointment is Appointment

// The appointment starts now and it lasts two hours
MyAppointment.StartDate = DateSys() + TimeSys()
MyAppointment.EndDate = MyAppointment.StartDate
MyAppointment.EndDate.Time = MyAppointment.EndDate.Time + 2

MyAppointment.Title = "Appointment with the sales director"
MyAppointment.Importance = 1
MyAppointment.Guest = "Tommy, Vince, Sandra"
MyAppointment.Content = "Establishing the new price list"
MyAppointment.Note = "Remember to bring the blue folder."
MyAppointment.ToolTip = MyAppointment.Title + CR + MyAppointment.Note

// Add the appointment into the organizer
OrganizerAddAppointment(ORG_MyOrganizer, MyAppointment)

// 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 Repetition
y.Type = schEveryDay
y.DayOfWeek = 1
y.DayOfMonth = "1-7"
y.DayOfMonthOrDayOfWeek = False
x.Repetition = y
OrganizerAddAppointment(ORG_Organizer, x)

gAPT is Appointment
gCal is Calendar
arrCalendar is array of Calendar
// Retrieves the list of calendars
arrCalendar = AppointmentListCalendar()
gCal = arrCalendar[1]

// Add a new appointment into the first calendar
gAPT.Title = EDT_Title
gAPT.StartDate = EDT_StartDate + EDT_StartTime
gAPT.EndDate = EDT_EndDate + EDT_EndTime
gAPT.Location = EDT_Location
gAPT.Content = EDT_Desc
IF EDT_TimeZone <> "" THEN
gAPT.TimeZone = EDT_TimeZone
END
gAPT.Author = EDT_Author
gAPT.Guest = EDT_Guests
gAPT.WholeDay = CBOX_WholeDay[1]

IF AppointmentAdd(gCal, gAPT) THEN
ToastDisplay("APT added")
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:

The properties specific to the management of Organizer and Scheduler controls.
The properties specific to the management of Appointment functions.

Properties specific to Organizer and Scheduler controls

The following properties can be used to handle an appointment:

Property name	Type used	Effect

Author	Character string	Name of appointment author. If this property is not specified, the appointment has no author. This property is not available.
BackgroundColor	Integer	Background color used to display the appointment in the Organizer control or in the Scheduler control. This color can correspond to: an RGB color (returned by RGB), an HSL color (returned by HSL), a preset color (see the preset colors of WLanguage). 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".
Category	Character string	Category of appointment. If this property is not specified, the appointment is associated with no category.
Content	Character string	Detailed 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.
EndDate	Character string or DateTime variable	End 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.
ID	Character string	Identifier 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.
Image	Character string	Image 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. The image file must be found in the <Project_Name>_WEB directory. The specified path must be relative to this directory. This property is not available.
Importance	Integer	Importance of appointment. If this property is greater than or equal to 1, an icon () will be displayed in the Organizer or Scheduler control to indicate an important event. If this property is not specified, its value is set to 0. This property is not available.
Location	Character string	Location of the appointment. If this property is not specified, the appointment has no location. This property is not available.
Note	Character string	Note associated with the appointment. If this property is not specified, no note is associated with the appointment. This property is not available.
Order	Integer	Order of appointments (for overlapping appointments). This property is not available.
Repetition	Repetition variable	Advanced parameters of repetition. This property is taken into account only if the WithRepetition property is set to True. This property is not available.
Resource	Character string	Resource associated with the appointment. This property is taken into account only when the appointment is used by a Scheduler control.
StartDate	Character string or DateTime variable	Start 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.
Title	Character string	Appointment 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.
ToolTip	Character string	Tooltip 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. This property is not available.
WholeDay	Boolean	True if the appointment is an appointment for the entire day. False otherwise (default value). 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.
WithRepetition	Boolean	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. This property is not available.

Properties specific to the management of Appointment functions

The following properties can be used to handle an appointment:

Property name	Type used	Effect

Author	Character string	Name of appointment author. If this property is not specified, the appointment has no author. This property is not supported.
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.
Content	Character string	Detailed description of the appointment. If this property is not specified, the appointment has no description.
EndDate	Character string or DateTime variable	End 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
Guest	Character string	List 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: <Name guest 1> + TAB + <Email guest 1> + CR + ... + CR + <Name guest N> + TAB + <Email guest N> This property is read-only.
ID	Character string	Identifier 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.
Location	Character string	Location of the appointment. If this property is not specified, the appointment has no location.
Reminder	Array of Reminder variables	Array containing the list of reminders associated with the appointment. If no reminder is associated with the appointment, the array is empty.
StartDate	Character string or DateTime variable	Start 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
TimeZone	Character string	Name 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).
Title	Character string	Appointment title. If this property is not specified, the appointment has no title.
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: Apt is Appointment Apt.StartDate = "201201170000" Apt.EndDate = "201201180000" Apt.WholeDay = True

Functions that use Appointment variables

Functions for managing Organizer and Scheduler controls:


<Organizer>.AddAppointment	Adds a new appointment to an Organizer control.
<Scheduler>.AddAppointment	Adds a new appointment into a Scheduler control.
OrganizerAddAppointment	Adds a new appointment to an Organizer control.
SchedulerAddAppointment	Adds a new appointment into a Scheduler control.

Appointment functions:


AppointmentAdd	Adds an appointment: in a Lotus Notes or Outlook calendar. in a calendar on a mobile device (Android or iOS).
AppointmentCreate	Displays the window for appointment creation of native application for managing appointments found on the Android device.
AppointmentDelete	Deletes: the current appointment from the calendar of a Lotus Notes or Outlook messaging. an appointment from the calendar found on a mobile device (Android/iOS).
AppointmentDisplay	Displays an appointment in the native application for managing appointments found on the mobile device (Android or iOS).
AppointmentModify	Modifies the current appointment: in a Lotus Notes or Outlook calendar. in the calendar found on a mobile device (Android/iOS).
AppointmentReset	Reinitializes: the Appointment structure. the Appointment variable.