PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Overview
  • Properties available in a window
  • Properties available in a page
  • Properties available in a page (server code)
  • Properties available in a page (browser code)
  • Properties available in PHP
  • Properties available in a report
  • Properties available in a report
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
Overview
A Scheduler control can be handled in WLanguage by the following properties:
  • in a window.
  • in a page.
  • in a report.
Properties available in a window
Properties available in a page
WEBDEV - Server code

Properties available in a page (server code)

The following properties are associated with the Scheduler controls:
AliasThe Alias property is used to:
  • get or change the alias of a window (WINDEV and WINDEV Mobile).
  • get or change the alias of a dynamic tab (WINDEV).
  • get the internal HTML/JavaScript name of a control (WEBDEV).
BackgroundColorThe BackgroundColor property is used to set the background color of a control, window, page or block of a report.
BrowsedFileThe BrowsedFile property is used to get and change the data source used to display records in controls based on a data file.
BrowsedItemThe BrowsedItem property is used to:
  • Get the item used to automatically loop through Table, Looper, List Box, ListView and Combo Box controls, supercontrols and reports based on data files.
  • Change the item used to automatically loop through Table, Looper, List Box, ListView and Combo Box controls, supercontrols and reports based on data files. Then, the iteration is reinitialized.
ColorThe Color property is used to get or change the font color for:
  • a Font variable.
  • a text displayed in a Static control or in a calculated control of a report.
  • a text displayed in a window control.
  • a text displayed in a page control.
DayHeightThe DayHeight property is used to get and change the height of days in a Scheduler control where days are arranged in rows, and resources are arranged in columns.
DayWidthThe DayWidth property is used to determine and change the width of days:
  • in a Scheduler control where the days are displayed in column and the resources in rows.
  • in a Gantt Chart column.
DirectInputAPTThe DirectInputAPT property is used to determine and specify if the user can directly change the title of an appointment in a Scheduler or Organizer control.
DndTargetDndTarget is used to find out and modify the behavior of a control during "Drag and Drop".
FontThe Font property is used to
  • Get the identifier of the font used in a control in a report, page or window.
  • Change the font used in a control in a report, page or window.
FontBoldFontBold is used to:
  • Determine if the text is bold.
  • Change the weight of the text.
FontItalicFontItalic is used to:
  • Determine if the text is italicized.
  • Apply or remove italic formatting from the text.
FontNameThe FontName property is used to:
  • Identify the font used in a control.
  • Change the font used in a control.
FontSizeThe FontSize property is used to:
  • Identify the size of the font used in a control.
  • Change the size of the font used in a control.
FontUnderlinedFontUnderlined is used to:
  • Find out whether a text is underlined or not.
  • Underline (or not) a text.
FullNameThe FullName property is used to find out the full name:
  • of a control.
  • of a window.
  • of a menu option.
  • of a table column.
GranularityAppointmentThe GranularityAppointment gets and changes the precision of the grid used to define appointments in Organizer or Scheduler controls. Property kept for backward compatibility.
GranularityDurationThe GranularityDuration property is used to get and change the size of the grid to resize:
  • appointments in an Organizer control.
  • appointments in a Scheduler control.
  • events in a TimeLine control.
  • tasks in a Gantt Chart column.
GranularityMovementThe GranularityMovement property is used to get and change the size of the grid to move:
  • appointments in an Organizer control.
  • appointments in a Scheduler control.
  • events in a TimeLine control.
  • tasks in a Gantt Chart column.
GrayedThe Grayed property is used to:
  • Determine if a control (or a group of controls) is grayed out.
  • Gray out or ungray a control, a group of controls or a window.
GroupThe Group property is used to:
  • find out whether the control belongs to a group of controls. If the control belongs to one or more groups, the Group property can be used to identify these groups of controls.
  • associate a control with a group of controls.
HeightThe Height property is used to get and change the height:
  • of a control or block in a report.
  • of a control (in a window), window, row of a Table, List Box or ListView control, option of a Radio Button or Check Box control, break header or footer of a Table or Looper control.
  • of a control (in a page), break header or footer in a Table or Looper control. The control can be overlayable or not.
HorizontalAlignmentThe HorizontalAlignment property is used to get and change the horizontal alignment of a control.
HTMLAfterThe HTMLAfter property is used to get and change the HTML code inserted after the control.
HTMLBeforeHTMLBefore is used to find out and modify the HTML code added before the control.
HTMLClassThe HTMLClass property is used to read and change the value of the "class" HTML attribute of the control.
InitialStateThe InitialState property is used to get the initial state of a control.
InitialVisibleThe InitialVisible property is used to determine if:
  • a control was visible during the first display of the associated window or page.
  • a window was visible during its first display.
MaskTitleDateThe MaskTitleDate property is used to identify and change the input mask used for the title of day columns in Organizer or Scheduler controls
MemoryFormatThe MemoryFormat property is used to get and change the format of the value returned for:
  • Date or Time edit controls.
  • Date or Time table columns.
  • Calendar controls.
  • Static controls.
  • editable combo boxes.
  • table columns displayed by combo boxes.
ModificationDurationAPTThe ModificationDurationAPT property is used to determine and specify if the user can modify the duration of an appointment in a Scheduler or Organizer control.
MouseCursorThe MouseCursor property is used to identify and change the hover cursor defined for a control, window or page.
MovementAPTThe MovementAPT property allows you to know and specify whether users can move appointments in a Scheduler or Organizer control.
NameThe Name property is used to get:
  • the name of the font associated with a Font variable.
  • the name of a control, report or report block.
  • the name of a control, group of controls or window.
  • the name of a control, group of controls or page.
NewLineThe NewLine property is used to determine:
  • in a Table control, whether the current row was created with TableAddXXX or TableInsertXXX.
  • in a Looper control, whether the current row was created with LooperAddXXX or LooperInsertXXX.
  • in an Organizer control, whether an appointment was created via the popup menu.
  • in a Scheduler control, whether an appointment was created via the popup menu.
NoteThe Note property is used to:
  • Find out the notes associated with a control, a window, a page or a report.
  • Modify the notes associated with a control, a window a page or a report.
NoteTitleThe NoteTitle property is used to:
  • Get the title of the notes used in the technical documentation of a control, window, page or report.
  • Change the title of the notes used in the technical documentation of a control, window, page or report.
Num1stDayOfTheWeekNum1stDayOfTheWeek is used to find out and modify the 1st day of the week displayed in:
  • a Calendar control.
  • an Organizer control.
  • a Scheduler control.
  • an edit control in Date format with Calendar.
OpacityThe Opacity property is used to get and define the opacity percentage for a window, or for controls in a window or page.
PeriodSelectionThe PeriodSelection property is used to determine and specify if the user can select a time period in an Scheduler or Organizer control.
ProcessThe Process property is used to modify the processes to be executed by the events available on a control, window, page, report, etc.
ResourceThe Resource property is used to:
  • find out the resources visible in a Scheduler control.
  • find out the resource of the Scheduler control that corresponds to the specified index.
ResourceHeightThe ResourceHeight property is used to get and change the height of resources in a Scheduler control where resources are arranged in rows.
ResourceWidthThe ResourceWidth property is used to get and change the width of resources in a Scheduler control where resources are arranged in columns.
StateThe State property is used to get and change the state of an element.
ToolTipThe ToolTip property is used to get and change the text displayed in the tooltip associated with a window or page control.
TypeThe Type property is used to get:
  • the type of element described through programming (file or item description) or not (file or item defined in the data model editor, view or query).
  • the type of object.
  • the type of value stored in a variant.
ValueThe Value property is used to:
  • Find out and modify the value of a report control.
  • Find out and modify the value of a control or the title of a window.
  • Find out the identifier of a stream.
  • Find out and modify the value of a control or the title of a page.
VerticalVertical is used to:
  • find out whether a control is oriented horizontally or vertically.
  • modify the display direction of Table and Looper controls (switch from vertical to horizontal and conversely).
VerticalAlignmentThe VerticalAlignment property is used to get and change the vertical alignment of a control.
VisibleThe Visible property is used to:
  • Find out whether an element is visible.
  • Make an element visible or invisible.
WidthThe Width property gets and changes the width:
  • of a control or block in a report.
  • of a control (found in a window), window, column found in a table or column found in a list box (including listview).
  • of a control (found in a page), column found in a table or column found in a list box. The control can be overlayable or not.
WorkingHourEndThe WorkingHourEnd property is used to identify and change the end time of working hours used:
  • by an Organizer control.
  • by a Scheduler control.
  • by a Gantt Chart column (in a Table or TreeView Table control).
WorkingHourStartThe WorkingHourStart property is used to get and change the start time of working hours used:
  • by an Organizer control.
  • by a Scheduler control.
  • by a Gantt Chart column (in a Table or TreeView Table control).
XThe X property is used to:
  • Get the X-coordinate of a control, Table control column or window (position on the X-axis).
  • Get the X-coordinate of a control or window (position on the X-axis).
XInitialThe XInitial property is used to:
  • Get the X-coordinate:
    • of a control (position on the X-axis) when opening the window or the page.
    • of a window (position on X-axis) when opening the window.
  • Change the X-coordinate of a control anchored "to the right" (position on the X-axis) when opening the window.
  • Get the X-coordinate of a control in relation to its block (position in millimeters on the X-axis) when opening the report.
YThe Y property is used to:
  • Find out the Y-coordinate of a control or window (position on Y-axis).
  • Modify the Y-coordinate of a control or window.
YInitialThe YInitial property is used to:
  • Find out the Y-coordinate:
    • of a control (position on Y-axis) when opening the window or the page.
    • of a window (position on Y-axis) when opening the window.
  • Modify the Y-coordinate of a control anchored "to bottom" (position on the vertical axis) when opening the window.
  • Find out the Y-coordinate of a control in relation to its block (position in millimeters on the vertical axis) when opening the report.
PHP

Properties available in PHP

The following properties are associated with the Scheduler controls:
AliasThe Alias property is used to:
  • get or change the alias of a window (WINDEV and WINDEV Mobile).
  • get or change the alias of a dynamic tab (WINDEV).
  • get the internal HTML/JavaScript name of a control (WEBDEV).
BackgroundColorThe BackgroundColor property is used to set the background color of a control, window, page or block of a report.
CaptionIn a database, the Caption property is used to:
  • Find out the caption associated with a file item.
  • Find out the caption associated with a data file.
  • Find out and modify the connection caption.
In a report, the Caption property is used to:
  • Find out the text displayed in a Static or Link control.
  • Modify the text displayed in a Static or Link control.
In a window or page, the Caption property is also used to:
  • Find out and modify the caption of a control in a window or in a page.
  • Find out and modify the caption of a menu option.
  • Find out and modify the title of a window or page.
  • Find out the content of a Breadcrumb control.
ColorThe Color property is used to get or change the font color for:
  • a Font variable.
  • a text displayed in a Static control or in a calculated control of a report.
  • a text displayed in a window control.
  • a text displayed in a page control.
DirectInputAPTThe DirectInputAPT property is used to determine and specify if the user can directly change the title of an appointment in a Scheduler or Organizer control.
FontBoldFontBold is used to:
  • Determine if the text is bold.
  • Change the weight of the text.
FontItalicFontItalic is used to:
  • Determine if the text is italicized.
  • Apply or remove italic formatting from the text.
FontNameThe FontName property is used to:
  • Identify the font used in a control.
  • Change the font used in a control.
FontSizeThe FontSize property is used to:
  • Identify the size of the font used in a control.
  • Change the size of the font used in a control.
FontUnderlinedFontUnderlined is used to:
  • Find out whether a text is underlined or not.
  • Underline (or not) a text.
GranularityAppointmentThe GranularityAppointment gets and changes the precision of the grid used to define appointments in Organizer or Scheduler controls. Property kept for backward compatibility.
GranularityDurationThe GranularityDuration property is used to get and change the size of the grid to resize:
  • appointments in an Organizer control.
  • appointments in a Scheduler control.
  • events in a TimeLine control.
  • tasks in a Gantt Chart column.
GranularityMovementThe GranularityMovement property is used to get and change the size of the grid to move:
  • appointments in an Organizer control.
  • appointments in a Scheduler control.
  • events in a TimeLine control.
  • tasks in a Gantt Chart column.
GrayedThe Grayed property is used to:
  • Determine if a control (or a group of controls) is grayed out.
  • Gray out or ungray a control, a group of controls or a window.
HeightThe Height property is used to get and change the height:
  • of a control or block in a report.
  • of a control (in a window), window, row of a Table, List Box or ListView control, option of a Radio Button or Check Box control, break header or footer of a Table or Looper control.
  • of a control (in a page), break header or footer in a Table or Looper control. The control can be overlayable or not.
HorizontalAlignmentThe HorizontalAlignment property is used to get and change the horizontal alignment of a control.
HTMLAfterThe HTMLAfter property is used to get and change the HTML code inserted after the control.
HTMLBeforeHTMLBefore is used to find out and modify the HTML code added before the control.
HTMLClassThe HTMLClass property is used to read and change the value of the "class" HTML attribute of the control.
InitialStateThe InitialState property is used to get the initial state of a control.
InitialVisibleThe InitialVisible property is used to determine if:
  • a control was visible during the first display of the associated window or page.
  • a window was visible during its first display.
MaskTitleDateThe MaskTitleDate property is used to identify and change the input mask used for the title of day columns in Organizer or Scheduler controls
ModificationDurationAPTThe ModificationDurationAPT property is used to determine and specify if the user can modify the duration of an appointment in a Scheduler or Organizer control.
MovementAPTThe MovementAPT property allows you to know and specify whether users can move appointments in a Scheduler or Organizer control.
NameThe Name property is used to get:
  • the name of the font associated with a Font variable.
  • the name of a control, report or report block.
  • the name of a control, group of controls or window.
  • the name of a control, group of controls or page.
NewLineThe NewLine property is used to determine:
  • in a Table control, whether the current row was created with TableAddXXX or TableInsertXXX.
  • in a Looper control, whether the current row was created with LooperAddXXX or LooperInsertXXX.
  • in an Organizer control, whether an appointment was created via the popup menu.
  • in a Scheduler control, whether an appointment was created via the popup menu.
NoteThe Note property is used to:
  • Find out the notes associated with a control, a window, a page or a report.
  • Modify the notes associated with a control, a window a page or a report.
NoteTitleThe NoteTitle property is used to:
  • Get the title of the notes used in the technical documentation of a control, window, page or report.
  • Change the title of the notes used in the technical documentation of a control, window, page or report.
Num1stDayOfTheWeekNum1stDayOfTheWeek is used to find out and modify the 1st day of the week displayed in:
  • a Calendar control.
  • an Organizer control.
  • a Scheduler control.
  • an edit control in Date format with Calendar.
OpacityThe Opacity property is used to get and define the opacity percentage for a window, or for controls in a window or page.
PeriodSelectionThe PeriodSelection property is used to determine and specify if the user can select a time period in an Scheduler or Organizer control.
ResourceThe Resource property is used to:
  • find out the resources visible in a Scheduler control.
  • find out the resource of the Scheduler control that corresponds to the specified index.
StateThe State property is used to get and change the state of an element.
TypeThe Type property is used to get:
  • the type of element described through programming (file or item description) or not (file or item defined in the data model editor, view or query).
  • the type of object.
  • the type of value stored in a variant.
ValueThe Value property is used to:
  • Find out and modify the value of a report control.
  • Find out and modify the value of a control or the title of a window.
  • Find out the identifier of a stream.
  • Find out and modify the value of a control or the title of a page.
VerticalVertical is used to:
  • find out whether a control is oriented horizontally or vertically.
  • modify the display direction of Table and Looper controls (switch from vertical to horizontal and conversely).
VerticalAlignmentThe VerticalAlignment property is used to get and change the vertical alignment of a control.
VisibleThe Visible property is used to:
  • Find out whether an element is visible.
  • Make an element visible or invisible.
WidthThe Width property gets and changes the width:
  • of a control or block in a report.
  • of a control (found in a window), window, column found in a table or column found in a list box (including listview).
  • of a control (found in a page), column found in a table or column found in a list box. The control can be overlayable or not.
WorkingHourEndThe WorkingHourEnd property is used to identify and change the end time of working hours used:
  • by an Organizer control.
  • by a Scheduler control.
  • by a Gantt Chart column (in a Table or TreeView Table control).
WorkingHourStartThe WorkingHourStart property is used to get and change the start time of working hours used:
  • by an Organizer control.
  • by a Scheduler control.
  • by a Gantt Chart column (in a Table or TreeView Table control).
XThe X property is used to:
  • Get the X-coordinate of a control, Table control column or window (position on the X-axis).
  • Get the X-coordinate of a control or window (position on the X-axis).
XInitialThe XInitial property is used to:
  • Get the X-coordinate:
    • of a control (position on the X-axis) when opening the window or the page.
    • of a window (position on X-axis) when opening the window.
  • Change the X-coordinate of a control anchored "to the right" (position on the X-axis) when opening the window.
  • Get the X-coordinate of a control in relation to its block (position in millimeters on the X-axis) when opening the report.
YThe Y property is used to:
  • Find out the Y-coordinate of a control or window (position on Y-axis).
  • Modify the Y-coordinate of a control or window.
YInitialThe YInitial property is used to:
  • Find out the Y-coordinate:
    • of a control (position on Y-axis) when opening the window or the page.
    • of a window (position on Y-axis) when opening the window.
  • Modify the Y-coordinate of a control anchored "to bottom" (position on the vertical axis) when opening the window.
  • Find out the Y-coordinate of a control in relation to its block (position in millimeters on the vertical axis) when opening the report.
Properties available in a report

Properties available in a report

The following properties are associated with the Scheduler controls:
AnchorThe Anchor property is used to set the anchors of a control in a window, page or report.
AnchorRateBottomThe AnchorRateBottom property is used to:
  • Find out the anchor rate when a control moves on the vertical axis.
  • Modify the anchor rate when a control moves on the vertical axis.
AnchorRateHeightThe AnchorRateHeight property is used to:
  • Find out the vertical anchor rate of a control.
  • Modify the vertical anchor rate of a control.
AnchorRateRightThe AnchorRateRight property is used to:
  • Find out the anchor rate when a control moves on the horizontal axis.
  • Modify the anchor rate when a control moves on the horizontal axis.
AnchorRateWidthThe AnchorRateWidth property is used to:
  • Find out the anchor rate when a control (or a table column) stretches on the horizontal axis.
  • Modify the anchor rate when a control (or a table column) stretches on the horizontal axis.
BlurLevelThe BlurLevel property gets and sets the percentage of blur applied to a control in a report.
CaptionPeriodHeaderThe CaptionPeriodHeader property is used to get and change the caption of the time period displayed in the header of a Scheduler or Agenda control in a report.
EndDatePeriodDisplayedThe EndDatePeriodDisplayed property is used to get the end date of the time period displayed in a Scheduler or Organizer control of a report.
FontAppointmentContentThe FontAppointmentContent property is used to:
  • Find out the characteristics of the font used for the content of appointments in the Scheduler and Organizer reports.
  • Modify the characteristics of the font used for the content of appointments in the Scheduler and Organizer reports.
FontAppointmentTitleThe FontAppointmentTitle property is used to:
  • Find out the characteristics of the font used for the title of appointments in the Scheduler and Organizer reports.
  • Modify the characteristics of the font used for the title of appointments in the Scheduler and Organizer reports.
GranularityGridlinesThe GranularityGridlines property gets and changes the size of the grid that defines the gridlines in a Scheduler or Organizer control in a report.
HeightThe Height property is used to get and change the height:
  • of a control or block in a report.
  • of a control (in a window), window, row of a Table, List Box or ListView control, option of a Radio Button or Check Box control, break header or footer of a Table or Looper control.
  • of a control (in a page), break header or footer in a Table or Looper control. The control can be overlayable or not.
HiddenThe Hidden is used to:
  • Determine if a control in a report is hidden.
  • Redact or blur a control in a report.
NameThe Name property is used to get:
  • the name of the font associated with a Font variable.
  • the name of a control, report or report block.
  • the name of a control, group of controls or window.
  • the name of a control, group of controls or page.
NoteThe Note property is used to:
  • Find out the notes associated with a control, a window, a page or a report.
  • Modify the notes associated with a control, a window a page or a report.
NoteTitleThe NoteTitle property is used to:
  • Get the title of the notes used in the technical documentation of a control, window, page or report.
  • Change the title of the notes used in the technical documentation of a control, window, page or report.
PlanePlane is used to:
  • Get:
    • the active plane of a window (or report) or the plane to which a control belongs.
    • the active plane of a WEBDEV element.
  • Change:
    • the active plane of a window (or report) or associate a control with another plane.
    • the active plane of a WEBDEV element.
ProcessThe Process property is used to modify the processes to be executed by the events available on a control, window, page, report, etc.
StartDatePeriodDisplayedThe StartDatePeriodDisplayed property is used to get the start date of the time period displayed in a Scheduler or Organizer control of a report.
VisibleThe Visible property is used to:
  • Find out whether an element is visible.
  • Make an element visible or invisible.
WidthThe Width property gets and changes the width:
  • of a control or block in a report.
  • of a control (found in a window), window, column found in a table or column found in a list box (including listview).
  • of a control (found in a page), column found in a table or column found in a list box. The control can be overlayable or not.
XThe X property is used to:
  • Get the X-coordinate of a control, Table control column or window (position on the X-axis).
  • Get the X-coordinate of a control or window (position on the X-axis).
YThe Y property is used to:
  • Find out the Y-coordinate of a control or window (position on Y-axis).
  • Modify the Y-coordinate of a control or window.
Minimum version required
  • Version 16
This page is also available for…
Comments
Click [Add] to post a comment