ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Scheduler control
  • Overview
  • Properties available in a window
  • 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
WINDEVAndroidiPhone/iPad

Properties available in a window

The following properties are associated with Scheduler controls:
New in version 2024
Accessibility
The Accessibility property gets and sets the accessibility properties of a control.
AnchorThe Anchor property sets 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.
AppointmentContinuousThe AppointmentContinuous property is used to determine or change how multiple-day appointments are displayed in a Scheduler control.
BackgroundColorThe BackgroundColor property is used to set the background color of a control, window, page or block of a report.
BrowsedFileThe BrowsedFile property gets and sets 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.
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.
ContextMenuThe ContextMenu property is used to:
  • Get the custom context menu of a control, window or page.
  • Change the custom context menu of a control, window or page (or associate another context menu).
  • WINDEVWINDEV Mobile Customize the system menus of the controls by adding options.
DayBreakHeightThe DayBreakHeight property is used to get and change the height of breaks between days in a Scheduler control where days are arranged in rows, and resources are arranged in columns.
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.
DisplayEnabledThe DisplayEnabled property is used to:
  • determine whether or not a control or window is refreshed. If the control is displayed, its content is refreshed regularly.
  • refresh a control or window.
DndSourceThe DndSource property is used to determine and change a control's drag-and-drop behavior.
DndTargetThe DndTarget property determines and changes how a control behaves in a drag-and-drop operation.
DoubleClickThe DoubleClick property is used to get and change the name of the Button control that will be executed when a control is double-clicked.
EndDateThe EndDate property is used to get and change the selected time period end date:
  • in a Calendar control,
  • in an Organizer control.
  • in a Scheduler control.
EndTotalRangeThe EndTotalRange property is used to:
  • get the last date or time that can be displayed in a Scheduler or TimeLine control.
  • change the last time that can be displayed in a TimeLine control.
EndVisibleRangeThe EndVisibleRange property is used to:
  • find out and modify the last visible date or time in a Scheduler control or in a TimeLine control.
  • modify the last visible time in a TimeLine control.
ExtraThe Extra property is used to:
  • Get additional information about a control, window, or page.
  • Edit additional information of a control, window or page.
WEBDEV - Browser code In browser code, you can only get additional information of a control or page.
New in version 2024
FlexAlignSelf
The FlexAlignSelf property gets and sets the alignment of an item along the cross axis of a Flexbox control (corresponding CSS property: "align-self").
New in version 2024
FlexGrow
The FlexGrow property gets and sets the grow factor of an item in a line of a Flexbox control.
New in version 2024
FlexShrink
The FlexShrink property gets and sets the shrink factor of an item in a line of a Flexbox control.
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.
FontBoldThe FontBold property is used to:
  • Determine if the text is bold.
  • Change the weight of the text.
FontCharsetThe FontCharset property is used to:
  • Find out the character set used by the screen fonts of a control.
  • Modify the character set used by the screen fonts of a control.
FontCondensedThe FontCondensed property is used to:
  • Determine if characters in a text are condensed.
  • Condense (or not) the characters in a text.
FontExtendedThe FontExtended property is used to:
  • Find out whether the spacing between characters in a text is increased.
  • Increase the spacing between characters in a text.
FontItalicThe FontItalic property is used to:
  • Determine if the text is italicized.
  • Apply or remove italic formatting from the text.
FontLargeThe FontLarge property is used to:
  • Determine if the text is expanded.
  • Expand 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.
FontStrikeOutThe FontStrikeOut property is used to:
  • Determine if the text displayed is struck through.
  • Apply strikethrough formatting (or not) the text displayed in a control.
FontUnderlinedThe FontUnderlined property is used to:
  • Determine if the text is underlined.
  • 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.
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.
  • of a break cell in a Table or Looper control.
HelpNumberThe HelpNumber property is used to identify and modify the help number associated with a control.
HideWhileScrollingThe HideWhileScrolling property is used to:
  • Determine if the pinned control is hidden while scrolling,
  • Show or hide the pinned control while scrolling.
InitialHeightThe InitialHeight property is used to:
  • Find out the creation height of a control or window.
  • Modify the base height used to anchor the controls "in height".
  • Find out the creation height of a block or control in a report.
InitialStateThe InitialState property gets 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.
InitialWidthThe InitialWidth property is used to:
  • Find out the initial width of a control or window.
  • Modify the base width used to anchor the controls in "width".
  • Find out the initial width of a report control.
LineHeightThe LineHeight property is used to get and change the height of the rows:
  • in a List Box control,
  • in a ListView control (standard display mode only),
  • in a Table control,
  • in a Combo Box control,
  • in a Looper control (height of the row),
  • in an Organizer control.
MarkdownThe Markdown property is used to enable or disable Markdown formatting in the controls of a window or a report.
MaskTitleDateThe MaskTitleDate property is used to identify and change the input mask used for the title of day columns in Organizer or Scheduler controls
MaskTitleTimeThe MaskTitleTime property is used to get or change the mask used for the title of time columns:
  • in an Organizer control.
  • in a Scheduler control.
  • in a TimeLine control.
MaxHeightThe MaxHeight property is used to get and change the maximum height of a control or window.
MaxWidthThe MaxWidth property is used to get and change the maximum width of a control or window.
MessageThe Message property is used to:
  • Find out the help message associated with a control or with a menu option (in a window).
  • Modify the help message associated with a control or with a menu option (in a window).
MinHeightThe MinHeight property is used to get and change the minimum height of a control or window.
MinWidthThe MinWidth property is used to get and change the minimum width of a control or window.
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.
NbDayDisplayedThe NbDayDisplayed property is used to:
  • get and change the number of days displayed in an Organizer or Scheduler control.
  • get the number of days displayed in a Gantt Chart control in a report.
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.
Num1stDayOfTheWeekThe Num1stDayOfTheWeek property gets and sets 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.
PaneThe Pane property is used to:
  • Find out the pane tabs associated with a control.
  • Define the pane tabs associated with a control.
ParallaxRateHeightThe ParallaxRateHeight property is used to determine and specify how fast a control is reduced when the scrollbar in the window, internal window or page moves.
ParallaxRateYThe ParallaxRateY property is used to determine and specify how fast a control moves when the scrollbar in the window, internal window or page moves.
PeriodSelectionThe PeriodSelection property is used to determine and specify if the user can select a time period in an Scheduler or Organizer control.
PinnedThe Pinned property is used to:
  • Pin a control: the position of the pinned control will be relative to the visible area of its container and not to the content area.
  • Determine if a control is pinned.
PlaneThe Plane property 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.
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.
RightClickThe RightClick property gets and sets the name of the Button control that will be executed when an object is right-clicked.
RulerModifiableThe RulerModifiable property is used to:
  • Find out whether the user can move the playhead in a TimeLine control.
  • Allow or prevent the user from moving the playhead in a TimeLine control.
RulerValueThe RulerValue property is used to get or change the position of the playhead in a TimeLine control.
RulerVisibleThe RulerVisible property is used to:
  • Determine if a playhead is visible in a TimeLine control.
  • Show or hide a playhead in a TimeLine control.
SelectedResourceThe SelectedResource property returns the name of the resource that corresponds to the user's selection in a Scheduler control.
StartDateThe StartDate property is used to determine and change the start date of the selected time period:
  • in a Calendar control.
  • in an Organizer control.
  • in a Scheduler control.
StartTotalRangeThe StartTotalRange property is used to:
  • get the first date or time that will be displayed in a Scheduler or TimeLine control.
  • change the first time that can be displayed in a TimeLine control.
StartVisibleRangeThe StartVisibleRange property is used to:
  • get and change the first visible date or time in a Scheduler or TimeLine control.
  • change the first visible time in a TimeLine control.
StateThe State property is used to get and change the state of an element.
StyleThe Style property is used to retrieve and assign the entire style of a control (including the overrides).
TABOrderThe TABOrder property gets and sets the position of a control in the tab order of a window.
TextDirectionThe TextDirection property is used to determine and change the writing direction in a window, report or control (useful for languages such as Arabic or Hebrew).
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 (data file or item) defined programmatically or in the data model editor, view or query.
  • the type of object.
  • the type of data held 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.
VerticalThe Vertical property is used to:
  • determine if a control is oriented horizontally or vertically.
  • change the orientation of Table and Looper controls (switch from vertical to horizontal and conversely).
VisibleThe Visible property is used to:
  • Find out whether an element is visible.
  • Make an element visible or invisible.
VisibleWithAnimationThe VisibleWithAnimation property is used to make a control visible or invisible via the "Appear/Disappear" animation.
VisualEffectThe VisualEffect property allows you to apply a visual effect on a control or group of controls in a window.
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.
WinEditAllowedThe WinEditAllowed property is used to determine and configure the actions allowed on a control when the window switches to "Allow end users to modify the UI" mode.
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.
ZOrderThe ZOrder property defines the Z-order of an element.
Properties available in a page
WEBDEV - Server code

Properties available in a page (server code)

The following properties are associated with 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 gets and sets 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.
ContextMenuThe ContextMenu property is used to:
  • Get the custom context menu of a control, window or page.
  • Change the custom context menu of a control, window or page (or associate another context menu).
  • WINDEVWINDEV Mobile Customize the system menus of the controls by adding options.
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.
DndTargetThe DndTarget property determines and changes how a control behaves in a drag-and-drop operation.
ExtraThe Extra property is used to:
  • Get additional information about a control, window, or page.
  • Edit additional information of a control, window or page.
WEBDEV - Browser code In browser code, you can only get additional information of a control or page.
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.
FontBoldThe FontBold property is used to:
  • Determine if the text is bold.
  • Change the weight of the text.
FontItalicThe FontItalic property 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.
FontUnderlinedThe FontUnderlined property is used to:
  • Determine if the text is underlined.
  • 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.
  • of a break cell in a Table or Looper control.
HorizontalAlignmentThe HorizontalAlignment property gets and changes the horizontal alignment of a control.
HTMLAfterThe HTMLAfter property is used to get and change the HTML code inserted after the control.
HTMLAttributeThe HTMLAttribute property reads and changes the HTML attributes of the control.
HTMLBeforeThe HTMLBefore property gets and changes the HTML code added before the control.
HTMLClassThe HTMLClass property reads and sets the value of the "class" HTML attribute of the control.
InitialStateThe InitialState property gets 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.
Num1stDayOfTheWeekThe Num1stDayOfTheWeek property gets and sets 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 (data file or item) defined programmatically or in the data model editor, view or query.
  • the type of object.
  • the type of data held 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.
VerticalThe Vertical property is used to:
  • determine if a control is oriented horizontally or vertically.
  • change the orientation of Table and Looper controls (switch from vertical to horizontal and conversely).
VerticalAlignmentThe VerticalAlignment property gets and changes 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.
WEBDEV - Browser code

Properties available in a page (browser code)

The following properties are associated with 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.
ExtraThe Extra property is used to:
  • Get additional information about a control, window, or page.
  • Edit additional information of a control, window or page.
WEBDEV - Browser code In browser code, you can only get additional information of a control or page.
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.
  • of a break cell in a Table or Looper control.
HTMLAttributeThe HTMLAttribute property reads and changes the HTML attributes of the control.
HTMLClassThe HTMLClass property reads and sets the value of the "class" HTML attribute of the control.
InitialStateThe InitialState property gets 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.
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.
OpacityThe Opacity property is used to get and define the opacity percentage for a window, or for controls in a window or page.
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 (data file or item) defined programmatically or in the data model editor, view or query.
  • the type of object.
  • the type of data held 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.
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).
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 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.
FontBoldThe FontBold property is used to:
  • Determine if the text is bold.
  • Change the weight of the text.
FontItalicThe FontItalic property 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.
FontUnderlinedThe FontUnderlined property is used to:
  • Determine if the text is underlined.
  • 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.
  • of a break cell in a Table or Looper control.
HorizontalAlignmentThe HorizontalAlignment property gets and changes the horizontal alignment of a control.
HTMLAfterThe HTMLAfter property is used to get and change the HTML code inserted after the control.
HTMLBeforeThe HTMLBefore property gets and changes the HTML code added before the control.
HTMLClassThe HTMLClass property reads and sets the value of the "class" HTML attribute of the control.
InitialStateThe InitialState property gets 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.
Num1stDayOfTheWeekThe Num1stDayOfTheWeek property gets and sets 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 (data file or item) defined programmatically or in the data model editor, view or query.
  • the type of object.
  • the type of data held 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.
VerticalThe Vertical property is used to:
  • determine if a control is oriented horizontally or vertically.
  • change the orientation of Table and Looper controls (switch from vertical to horizontal and conversely).
VerticalAlignmentThe VerticalAlignment property gets and changes 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 Scheduler controls:
AnchorThe Anchor property sets 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:
  • Get the characteristics of the font used for the content of appointments in Scheduler and Organizer reports.
  • Set the characteristics of the font used for the content of appointments in 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.
  • of a break cell in a Table or Looper control.
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.
PlaneThe Plane property 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

Last update: 03/05/2024

Send a report | Local help