Ribbon control properties

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Ribbon control

Ribbon control properties

Overview

Properties available for a Ribbon control

Properties available for a pane of a Ribbon control

Properties available for a group in a Ribbon control

See also

The Ribbon control

Ribbon control properties

Overview

The WLanguage properties can be used to handle:

a Ribbon control found in a window.
a pane of a Ribbon control.
a group in a Ribbon control.

Properties available for a Ribbon control

The following properties are associated with Ribbon controls:


Anchor	The Anchor property sets the anchors of a control in a window, page or report.
AnchorRateBottom	The 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.
AnchorRateHeight	The AnchorRateHeight property is used to: Find out the vertical anchor rate of a control. Modify the vertical anchor rate of a control.
AnchorRateRight	The 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.
AnchorRateWidth	The 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.
AutomaticTextColor	The AutomaticTextColor property is used to identify and change the color to be used for the text of the elements that use the "automatic" color.
BackgroundColor	The BackgroundColor property is used to set the background color of a control, window, page or block of a report.
Caption	In 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.
Collapsed	The Collapsed property is used to: get or define the state (collapsed or expanded) that will be used when rows are added to a TreeView Table control. find out or modify the collapsed/expanded status for: the breaks of a Table control, the breaks of a Looper control, the break headers and footers of Table and Looper controls, a Drawer control, a Ribbon control, a Navigation Bar control. a Pivot Table control in a report.
Color	The 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.
ContextMenu	The 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). Customize the system menus of the controls by adding options.
Count	The Count property returns the number of elements in a given set.
DataBinding	The DataBinding property is used to identify and change the binding between a control and: an item in a data file. a variable. several variables.
DisplayEnabled	The 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.
DndTarget	The DndTarget property determines and changes how a control behaves in a drag-and-drop operation.
New in version 28 Extra	The Extra property is used to: Get additional information about a control, window, or page. Edit additional information of a control, window or page.
FocusOnClick	The FocusOnClick property is used to: Determine if a control gains focus during a click. Modify the effect for gaining focus during the click on a control.
FontCharset	The 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.
FullName	The FullName property is used to find out the full name: of a control. of a window. of a menu option. of a table column.
Grayed	The 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.
Group	The 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.
Height	The 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.
HelpNumber	The HelpNumber property is used to identify and modify the help number associated with a control.
HideWhileScrolling	The HideWhileScrolling property is used to: Determine if the pinned control is hidden while scrolling, Show or hide the pinned control while scrolling.
Image	The Image property gets and sets the background image of a control or block.
ImageState	The ImageState property is used to get and change the number of drawings in: The image associated with a button. The image of the cursor in a slider. The image associated with the button of a sidebar pane. The image associated with the button of a tab pane. The image associated with the Rating control. The image associated with a group in a Ribbon control. The image associated with a menu option.
InitialHeight	The 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.
InitialState	The InitialState property is used to get the initial state of a control.
InitialValue	The InitialValue property is used to get the initial value of a control in a window or page.
InitialVisible	The 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.
InitialWidth	The 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.
LeftIndent	The LeftIndent property is used to get and change the space to the left of the text in a control.
MaxHeight	The MaxHeight property is used to get and change the maximum height of a control or window.
MaxWidth	The MaxWidth property is used to get and change the maximum width of a control or window.
Message	The 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).
MinHeight	The MinHeight property is used to get and change the minimum height of a control or window.
MinWidth	The MinWidth property is used to get and change the minimum width of a control or window.
Modified	The Modified property is used to determine if a control or group of controls has been modified by the user (keyboard or mouse input).
MouseCursor	The MouseCursor property is used to identify and change the hover cursor defined for a control, window or page.
Name	The 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.
Note	The 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.
NoteTitle	The 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.
Pane	The Pane property is used to: Find out the pane tabs associated with a control. Define the pane tabs associated with a control.
ParallaxRateHeight	The 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.
ParallaxRateY	The ParallaxRateY property is used to determine and specify how fast a control moves when the scrollbar in the window, internal window or page moves.
Pinned	The 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.
Plane	The 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.
Process	The Process property is used to modify the processes to be executed by the events available on a control, window, page, report, etc.
RightClick	The RightClick property is used to get and change the name of the Button control that will be executed when an object is right-clicked.
RightToLeft	The RightToLeft property is used to get the writing direction on a control, column, window or report.
State	The State property is used to get and change the state of an element.
StoreTheConfiguration	The StoreTheConfiguration property is used to: Determine whether the configuration of the panes in a dynamic Tab control or Ribbon control is automatically saved and restored. Modify the configuration of the panes in a dynamic Tab control or Ribbon control so that it is automatically saved and restored (or not)
Style	The Style property is used to retrieve and assign the entire style of a control (including the overrides).
TabOffset	The TabOffset property is used to get and change the offset between the border of a Tab or Ribbon control and the tab buttons.
TABOrder	The TABOrder property is used to get and change the position of a control in the tab order of a window.
TextDirection	The 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).
ToolTip	The ToolTip property is used to get and change the text displayed in the tooltip associated with a window or page control.
Type	The 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.
UndockablePane	The UnlockablePane property is used to: Determine if the end user can move the panes of a Ribbon or Dynamic Tab control outside the window. Allow or prevent the end user from moving the panes of a Ribbon or Dynamic Tab control outside the window.
Value	The 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.
Visible	The Visible property is used to: Find out whether an element is visible. Make an element visible or invisible.
VisibleWithAnimation	The VisibleWithAnimation property is used to make a control visible or invisible via the "Appear/Disappear" animation.
VisualEffect	The VisualEffect property allows you to apply a visual effect on a control or group of controls in a window.
Width	The 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.
WinEditAllowed	The WinEditAllowed property is used to determine and configure the actions allowed on a control when the window switches to "UI modification by end user" mode.
X	The 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).
XInitial	The 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.
Y	The 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.
YInitial	The 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.
ZOrder	The ZOrder property defines the Z-order of an element.

Properties available for a pane of a Ribbon control

The following properties are associated with the panes of a Ribbon control:


BackgroundColor	The BackgroundColor property is used to set the background color of a control, window, page or block of a report.
Caption	In 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.
Color	The 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.
FullName	The FullName property is used to find out the full name: of a control. of a window. of a menu option. of a table column.
Grayed	The 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.
HelpNumber	The HelpNumber property is used to identify and modify the help number associated with a control.
Image	The Image property gets and sets the background image of a control or block.
InitialState	The InitialState property is used to get the initial state of a control.
InitialVisible	The 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.
Name	The 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.
ParallaxRateHeight	The 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.
ParallaxRateY	The ParallaxRateY property is used to determine and specify how fast a control moves when the scrollbar in the window, internal window or page moves.
State	The State property is used to get and change the state of an element.
ToolTip	The ToolTip property is used to get and change the text displayed in the tooltip associated with a window or page control.
Undocked	The Undocked property is used to determine if a pane of a Tab or Ribbon control is undocked.
Visible	The Visible property is used to: Find out whether an element is visible. Make an element visible or invisible.
WinEditAllowed	The WinEditAllowed property is used to determine and configure the actions allowed on a control when the window switches to "UI modification by end user" mode.

Properties available for a group in a Ribbon control

The following properties are associated with the groupings in a Ribbon control:


AnchorRateWidth	The 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.
Caption	In 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.
Color	The 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.
Grayed	The 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.
Group	The 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.
Height	The 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.
Image	The Image property gets and sets the background image of a control or block.
ImageState	The ImageState property is used to get and change the number of drawings in: The image associated with a button. The image of the cursor in a slider. The image associated with the button of a sidebar pane. The image associated with the button of a tab pane. The image associated with the Rating control. The image associated with a group in a Ribbon control. The image associated with a menu option.
InitialHeight	The 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.
InitialVisible	The 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.
InitialWidth	The 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.
MaxWidth	The MaxWidth property is used to get and change the maximum width of a control or window.
MouseCursor	The MouseCursor property is used to identify and change the hover cursor defined for a control, window or page.
Name	The 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.
Note	The 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.
ParallaxRateHeight	The 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.
ParallaxRateY	The ParallaxRateY property is used to determine and specify how fast a control moves when the scrollbar in the window, internal window or page moves.
State	The State property is used to get and change the state of an element.
Type	The 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.
Visible	The Visible property is used to: Find out whether an element is visible. Make an element visible or invisible.
VisibleWithAnimation	The VisibleWithAnimation property is used to make a control visible or invisible via the "Appear/Disappear" animation.
Width	The 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.
WinEditAllowed	The WinEditAllowed property is used to determine and configure the actions allowed on a control when the window switches to "UI modification by end user" mode.
X	The 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).
XInitial	The 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.
Y	The 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.
YInitial	The 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.