ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Spreadsheet control
  • Overview
  • Properties available for a Spreadsheet control found in a window
  • Properties available for the Spreadsheet control
  • Properties available for the cells of Spreadsheet control
  • Properties available for a Spreadsheet control found in a report
  • Properties available for the Spreadsheet control
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Overview
You can manipulate a Spreadsheet controls and their cells in a window or report using the following WLanguage properties.
Properties available for a Spreadsheet control found in a window
WINDEV

Properties available for the Spreadsheet control

The following properties are associated with Spreadsheet controls:
AccessibilityThe 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.
BackgroundColorThe BackgroundColor property is used to set the background color of a control, window, page or block of a report.
BackgroundImageLineThe BackgroundImageLine property gets and sets the background image of each row:
  • of a Table control,
  • of a TreeView Table control,
  • in a Looper control.
BorderThe Border property gets and sets the characteristics of the borders:
  • for a report control or block.
  • for a window control.
  • for a cell of the Table control.
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 found 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 gets or sets the font color of:
  • a Font variable.
  • text displayed in a Static or Calculated control of a report.
  • text displayed in a window control.
  • text displayed in a page control.
ContentThe Content property is used to read or write the whole content of a control:
  • List Box populated programmatically,
  • Combo Box populated programmatically,
  • Spreadsheet.
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.
CountThe Count property returns the number of elements in a given set.
CurrentWorksheetThe CurrentWorksheet property gets and sets the current worksheet in a Spreadsheet control.
DataBindingThe DataBinding property is used to identify and change the binding between a control and:
  • a data file item.
  • a variable.
  • several variables.
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.
DoubleClickThe DoubleClick property gets and sets the name of the Button control that will be executed when a control is double-clicked.
EmptyThe Empty property is used to determine if:
  • a Looper, Table, List Box or Combo Box control is empty. The field can be a file or memory field.
  • a Chart control contains no series.
  • a report control is empty (control linked to an item).
  • an array (or an associative array) contains no element.
  • an element of an associative array exists or not.
  • a queue, a list or a stack contains no element.
ExtraThe Extra property is used to:
  • Get additional information about a control, window, or page.
  • Edit additional information of a control, window or page.
FilePathThe FilePath property gets:
  • the name of the xlsx file associated with a Spreadsheet control.
  • the name of the file associated with an Image Editor control.
  • the name of the PDF file associated with a PDF Reader control.
  • the name of the DOCX file associated with a Word Processing control.
  • the name of the wddiag file associated with a Diagram Editor control.
FillTypeThe FillType property is used to determine the type of source used to populate Table, List Box, ListView, Combo Box and Looper controls.
FlexAlignSelfThe FlexAlignSelf property gets and sets the alignment of an item along the cross axis of a Flexbox control (corresponding CSS property: "align-self").
FlexGrowThe FlexGrow property gets and sets the grow factor of an item in a line of a Flexbox control.
FlexShrinkThe FlexShrink property gets and sets the shrink factor of an item in a line of a Flexbox control.
FocusOnClickThe FocusOnClick property is used to:
  • Determine if a control gains focus when clicked.
  • Allow or prevent a control from gaining focus when clicked.
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.
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.
FormulaBarVisibleThe FormulaBarVisible property is used to:
  • Determine if a formula bar is displayed in a Spreadsheet control.
  • Show or hide a formula bar in a Spreadsheet control.
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.
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.
GridlinesVisibleThe GridlinesVisible property is used to:
  • Determine whether or not gridlines are visible in a control.
  • Show or hide gridlines in a control.
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.
HeaderVisibleThe HeaderVisible property is used to:
  • Determine if the row and column headers are displayed in a Spreadsheet control.
  • Show or hide the row and column headers in a Spreadsheet control.
HeightThe Height property gets and sets 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.
InitialContentThe InitialContent property gets the initial content:
  • of a List Box control populated programmatically.
  • of a Combo Box control populated programmatically.
  • of a "List of values" column in a Table control.
  • in a Spreadsheet control.
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.
InitialValueThe InitialValue property is used to get the initial value of a control in a window or page.
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 base width used for anchoring "width" fields.
  • Find out the initial width of a report control.
InputEnabledThe InputEnabled property is used to:
  • Determine if a control or a group of controls is editable or read-only.
  • Change the input options for a control or group of controls.
InputFormulaThe InputFormula property is used to:
  • find out whether the end user can enter or change formulas in a Spreadsheet control.
  • allow or prevent the end user from entering or changing formulas in a Spreadsheet control.
InputValueThe InputValue property is used to:
  • find out whether the end user can enter or change values in a Spreadsheet control.
  • allow or prevent the end user from entering or changing values in a Spreadsheet control.
LineHeightThe LineHeight property gets and sets 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.
MaxHeightThe MaxHeight property gets and sets the maximum height of a control or window.
MaxLineHeightThe MaxLineHeight property gets and sets the maximum height in:
  • the rows of a Table control (case of multiline rows with automatic resizing).
  • the rows of a TreeView Table control.
  • the rows of a Looper control.
MaxWidthThe MaxWidth property gets and sets 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 gets and sets the minimum height of a control or window.
MinWidthThe MinWidth property gets and sets the minimum width of a control or window.
ModifiedThe Modified property is used to determine if a control or group of controls has been modified by the user (keyboard or mouse input).
MouseCursorThe MouseCursor property gets and sets the cursor displayed when pointing over a control, window or page.
MultiWorksheetThe MultiWorksheet property is used to:
  • Find out whether a Spreadsheet control manages several worksheets.
  • Change the worksheet management mode of a Spreadsheet 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.
NbWorksheetThe NbWorksheet property is used to get the number of worksheets in a Spreadsheet control.
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 context menu.
  • in a Scheduler control, whether an appointment was created via the context 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.
NumberColumnThe NumberColumn property is used to:
  • Get the number of columns in Table, Check Box, Radio Button controls, etc..
  • Set the number of columns in a multi-column List Box control.
NumberRowThe NumberRow property returns the maximum number of rows containing data in a Spreadsheet control. These rows contain data, a formula, formatting or a non-standard height.
OpacityThe Opacity property is used to get and define the opacity percentage for a window, or for controls in a window or page.
PageLayoutThe PageLayout gets and sets the layout of the current diagram in the Diagram Editor control. The layout of the diagram is defined in a variable of type diagLayout.
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.
PinnedThe Pinned property is used to:
  • Pinned or not a field: the pinned field will be positioned in relation to the visible area of its container instead of the content area..
  • Determine if a control is pinned.
PlaneThe Plane property is used to:
  • Know:
    • the active plane of a window (or report) or the plane to which a control belongs.
    • the active plane of a WEBDEV element.
  • Edit:
    • 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.
RibbonThe Ribbon property is used to access the Ribbon control of the associated control (Word Processing, PDF Reader, Spreadsheet, Image Editor, HTML Editor or Diagram Editor controls).
RightClickThe RightClick property gets and sets the name of the Button control that will be executed when an object is right-clicked.
RightToLeftThe RightToLeft property is used to get the writing direction on a control, column, window or report.
SelectionThe Selection property is used to get the characteristics of the selection (or cursor):
  • in a Word Processing control.
    Note: This selection is located in the part being edited (body, header or footer)..
  • in a Spreadsheet control.
  • in an HTML Editor control.
  • in a Diagram Editor control.
SizeThe Size property is used to determine and change the size of an element.
StateThe State property gets and sets 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).
TitleHeightThe TitleHeight property gets and sets:
  • the height of the title for the columns of a Table or TreeView Table control.
  • the height of the title bar of a Dockable Panel control.
  • the height of the title bar of a window with a custom title bar.
ToolbarVisibleThe ToolbarVisible property is used to:
  • determine if the toolbar or the ribbon is displayed in a control.
  • show or hide the toolbar or the ribbon in a control.
ToolTipThe ToolTip property is gets and changes the tooltip text 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.
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.
WorksheetNameThe WorksheetName property is used to get or change the name of the current worksheet in a Spreadsheet 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.
ZoomThe Zoom property gets or sets the zoom value:
  • in an Image control.
  • in a Map control.
  • in an Organization Chart control.
  • in a Table, TreeView Table, Pivot Table, Spreadsheet or List Box control.
  • in a Word Processing control.
  • in a PDF Reader control.
  • in a Camera control.
  • in a Diagram Editor control;
  • in a window.
ZOrderThe ZOrder property defines the Z-order of an element.
WINDEV

Properties available for the cells of Spreadsheet control

The following properties are associated with the cells of Spreadsheet control:
BackgroundColorThe BackgroundColor property is used to set the background color of a control, window, page or block of a report.
ColorThe Color property gets or sets the font color of:
  • a Font variable.
  • text displayed in a Static or Calculated control of a report.
  • text displayed in a window control.
  • text displayed in a page control.
CommentThe Comment property gets and sets the different characteristics of comments in a cell of a Spreadsheet control.
DisplayedValueThe DisplayedValue property returns the value currently displayed in the control of a window 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.
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.
HeightThe Height property gets and sets 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.
InputMaskThe InputMask property is used to:
  • get the input mask.
  • set the input mask (from the masks available for the type).
MergeThe Merge property is used to merge the cells of a Table or TreeView Table 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.
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.
SelectedThe Selected property is used to:
  • Select, or determine if a row is selected in a List, ListView or Table control.
  • Select, or determine if a column or cell is selected in a Table control with row or column selection.
  • Select, or determine if a WEBDEV menu option is selected.
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.
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.
Properties available for a Spreadsheet control found in a report
WINDEVWEBDEV - Server code

Properties available for the Spreadsheet control

The following properties are associated with Spreadsheet controls:
AdjustmentModeThe AdjustmentMode property determines and changes how a Spreadsheet control is adjusted in a report.
BlurLevelThe BlurLevel property gets and sets the percentage of blur applied to a control in a report.
DisplayedItemThe DisplayedItem property is used to:
  • Find out the item or the variable displayed by the control.
  • Modify the item or the variable displayed by the control.
GridlinesVisibleThe GridlinesVisible property is used to:
  • Determine whether or not gridlines are visible in a control.
  • Show or hide gridlines in a control.
HeaderVisibleThe HeaderVisible property is used to:
  • Determine if the row and column headers are displayed in a Spreadsheet control.
  • Show or hide the row and column headers in a Spreadsheet control.
HeightThe Height property gets and sets 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:
  • Know:
    • the active plane of a window (or report) or the plane to which a control belongs.
    • the active plane of a WEBDEV element.
  • Edit:
    • the active plane of a window (or report) or associate a control with another plane.
    • the active plane of a WEBDEV element.
PrintAreaThe PrintArea property gets and sets the print area of a Spreadsheet control in a report.
PrintedSheetWithin a report, the PrintedSheet property is used to get and change the sheet of a Spreadsheet control to be printed.
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).
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 20
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 09/25/2024

Send a report | Local help