PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • 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/iPadApple WatchUniversal Windows 10 AppWindows Mobile
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 codePHP 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.
  • Versions 21 and later
    AndroidiPhone/iPad in a Scheduler control. The Appointment type will be handled by the WLanguage functions for managing the Scheduler controls.
    New in version 21
    AndroidiPhone/iPad in a Scheduler control. The Appointment type will be handled by the WLanguage functions for managing the Scheduler controls.
    AndroidiPhone/iPad in a Scheduler control. The Appointment type will be handled by the WLanguage functions for managing the Scheduler controls.
  • Versions 18 and later
    Android by the functions for managing the appointments on an Android device.
    New in version 18
    Android by the functions for managing the appointments on an Android device.
    Android by the functions for managing the appointments on an Android device.
    AndroidiPhone/iPad by the functions for managing the appointments on an Android or iOS device.
    Versions 21 and later
    iPhone/iPad The functions for managing the appointments on an iOS device are now available.
    New in version 21
    iPhone/iPad The functions for managing the appointments on an iOS device are now available.
    iPhone/iPad The functions for managing the appointments on an iOS device are now available.
The characteristics of this appointment can be defined and modified by several WLanguage properties.
Note: See Declaring a variable for more details.
Versions 21 and later
iPhone/iPad This type of variable is now available for the 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 the 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 the 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
WINDEVWEBDEV - Server codeWEBDEV - Browser code
// 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 = "Michael, Anthony, Sandra"
MyAppointment..Content = "Establishing the new price list"
MyAppointment..Note = "Don't forget to bring the blue folder."
MyAppointment..ToolTip = MyAppointment..Title + CR + MyAppointment..Note

// Add the appointment into the organizer
OrganizerAddAppointment(ORG_MyOrganizer, MyAppointment)
WINDEVWEBDEV - Server code
// 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)
Versions 18 and later
AndroidiPhone/iPad
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
New in version 18
AndroidiPhone/iPad
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
AndroidiPhone/iPad
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:

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, ..Repetition is used 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.
AndroidiPhone/iPad This property is not available.
CategoryCharacter stringCategory of the appointment. If this property is not specified, the appointment is associated with no category.
WEBDEV - Browser code This property is not available.
ContentCharacter stringDetailed description of the appointment.
WINDEVWEBDEV - Server codeWEBDEV - Browser codePHP The content is displayed in the Organizer control or in the Scheduler control.
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.
BrushColorIntegerBackground color used to display the appointment in the Organizer control or in the Scheduler control.
This color corresponds 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.
StartDateCharacter string or DateTime variableStart date and time of 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 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 library of the application,
  • 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 - 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 Scheduler control or in the Organizer control to indicate an important event.
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.
WEBDEV - Server codeWEBDEV - Browser codePHP This property is not available.
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 ..WithRepetition 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 stringTitle of appointment. The title is displayed in the Organizer control or in the Scheduler control.
If this property is not specified, the appointment has no title.

Note: These properties can be used with one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>
AndroidiPhone/iPad

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/iPad 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 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 ..TimeZone.
EndDateCharacter string or DateTime variableEnd date and time of 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 ..TimeZone.
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", ...
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:
<Name Guest 1> + TAB + <Email Guest 1> + CR + ...
+ CR + <Name Guest N> + TAB + <Email Guest N>
iPhone/iPad This property is available in read-only.
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:
Apt is Appointment
Apt..StartDate = "201201170000"
Apt..EndDate = "201201180000"
Apt..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 stringTitle of appointment.
If this property is not specified, the appointment has no title.

Note: These properties can be used with one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Functions that use the Appointment variables

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