PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Using the Appointment type
  • Properties specific to the management of Organizer and Scheduler controls
  • 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:
  • WINDEV 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.
This type of variable can be used:
  • WINDEV 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.
The characteristics of this appointment can be defined and modified by several WLanguage properties.
Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.
Versions 21 and later
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
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.
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
WINDEV
// 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)
// 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)
WINDEV
// 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)
// 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)
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.
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.
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.
CategoryCharacter stringCategory of appointment. If this property is not specified, the appointment is associated with no category.
ContentCharacter stringDetailed description of appointment.
WINDEV 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.
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 "BrushColor".
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 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.
ImportanceIntegerImportance of appointment.
If this property is greater than or equal to 1, an icon ( Pictogram for important appointment. ) will be displayed in the TimeLine control to indicate an important event.
If this property is not specified, its value is set to 0.
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).
WINDEV 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.
RemarkCharacter stringNote associated with the appointment.
If this property is not specified, no note is associated with the appointment.
Versions 22 and later
Order
New in version 22
Order
Order
IntegerOrder of appointments (for overlapping appointments).
RepetitionRepetition variableAdvanced parameters of repetition. This property is taken into account only if ..WithRepetition is set to True.
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.

Remark: 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 version required
  • Version 16
This page is also available for…
Comments
Click [Add] to post a comment