PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of the ogiAppoitment variables
  • Functions that use the ogiAppointment 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
ogiAppointment (Type of variable)
In French: agRendezVous
Warning
From version 17, this type of variable is kept for backward compatibility. This type of variable is replaced by the Appointment type, used to manage the appointments found in a Scheduler control or in an Organizer control.
The ogiAppointment type is used to define the advanced characteristics of an appointment: time, location, ... This appointment will be displayed in an Organizer control. The characteristics of this appointment can be defined and modified by several WLanguage properties.
Then, the corresponding appointment can be used with the WLanguage functions for managing the Organizer controls.
Note: See Declaring a variable for more details.
Example
// Build an ogiAppointment variable
MyAppointment is ogiAppointment

// The appointment starts now and it lasts two hours
MyAppointment..StartDate = DateSys() + TimeSys()
MyAppointment..EndDate = MyAppointment..StartDate
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)
Remarks

Properties specific to the description of the ogiAppoitment variables

The following properties can be used to handle an appointment:

Property nameType usedEffect
AuthorCharacter stringName of the author of the appointment. If this property is not specified, the appointment has no author.
WithRepetitionBoolean
  • True if the appointment must be repeated. In this case, ..Repetition must specify the number of repetitions.
  • False (default) if the appointment only happens once.
ToolTipCharacter stringTooltip displayed when the appointment is hovered. By default, this value includes the start time and the end time of the appointment as well as the title of the appointment.
CategoryCharacter stringCategory of the appointment. If this property is not specified, the appointment is associated with no category.
ContentCharacter stringDetailed description of the appointment. The content is displayed in the Organizer control. If this property is not specified, the appointment has no description.
BrushColorIntegerBackground color used to display the appointment in the Organizer 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 the appointment. A valid date must be assigned to this property before using the variable.
This property is mandatory.
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 is mandatory.
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 (in addition to the pictogram 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.
ImportanceIntegerImportance of the appointment. If this property is equal to or greater than 1, a logo ( Logo for important appointment. ) will be displayed in the Organizer control to indicate an important appointment. If this property is not specified, its value is set to 0.
GuestCharacter stringList of persons invited to the appointment. If this property is not specified, the appointment has no guest.
LocationCharacter stringLocation of the appointment. If this property is not specified, the appointment has no location.
NoteCharacter stringNote associated with the appointment. If this property is not specified, no note is associated with the appointment.
RepetitionogiRepetition variableAdvanced parameters of the repetition. This property is taken into account only if ..WithRepetition is set to True.
TitleCharacter stringTitle of the appointment. The title is displayed in the Organizer control. If this property is not specified, the appointment has no title.
Note: These properties can be handled by using one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Functions that use the ogiAppointment variables

Versions 15 and later
OrganizerAddAppointment
New in version 15
OrganizerAddAppointment
OrganizerAddAppointment
Adds a new appointment into an Organizer control.
Minimum required version
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment