DataGrid

Description

The DataGrid class implements the DataGrid development environment component that views and edits data as a table.

Properties inherited from IDataGrid

  Property name Brief description
The AbsoluteFocusedRow property determines an absolute index of the focused table row.
The AbsoluteRowCount property determines the absolute number of rows in a table.
The AllowAppend property determines whether the records adding is available.
The AllowDelete property determines whether it is possible to delete records.
The AllowEdit property determines whether the records editing is available.
The AutoFilter property determines whether autofilter is used in columns.
The BandCount property determines the number of custom bands contained in a table.
The Bands property returns the collection of table bands.
The BorderStyle property determines the style of a component border.
The CellValue property determines the value of the cell, which coordinates are passed as input parameters.
The ColumnCount property determines the columns number of the DataGrid component.
The Columns property returns the columns collection of the DataGrid component.
The CurentColumn property determines the number of the column, that is in the focus.
The CustomCellStyle property determines whether events for drawing cells are to be generated.
The DataSource property specifies the data source, which the component is connected with.
The DrawFocus property determines whether the focus frame is displayed for the table cell.
The EnableSort property determines the availability of data sorting by single click on the table header.
The FixedBorderColor property determines color of the lines dividing fixed bands of a table.
The FixedBorderWidth property determines width of the border between fixed bands.
The FocusedColumn property returns focused table column.
Outdated. The FocusedRow property determines the number of the row, that is in the focus.
The GridLinesColor property determines color of vertical and horizontal table gridlines.
The HeaderHeight property determines the height of component's columns headers and bands headers.
The HeaderMenu property determines the context menu that is called in the area of band or column headers.
The HideSelection property determines the visibility of the selection set when the component loses the focus.
The Images property determines the component, images of which are to be used in table cells.
The MultipleSort property determines whether it is possible to sort multiple columns at once.
The MultiSelect property determines the availability of multiple selection of the DataGrid component rows.
The ReadOnly property determines whether the user can edit the current field value.
The RootBands property returns the collection of table root bands.
Outdated. The RowCount property determines the number of rows.
The RowHeight property determines the basic height of component rows.
The Rows property returns the table row collection.
The RowSizing property determines whether the user can resize row height with a mouse.
The RowSizingMode property determines the mode, in which the row height is changed.
The Selection property determines the element selection in the component.
The ShowBands property determines whether band headers are displayed.
The ShowFocusedCell property determines whether a focused cell is to be displayed.
The ShowHeaders property determines whether table bands and headers are displayed.
The ShowHorizontalGridLines property determines whether horizontal table gridlines are displayed.
The ShowTotals property determines whether totals of the columns are displayed.
The ShowVerticalGridLines property determines whether vertical table gridlines are displayed.
The SortType property determines the component sorting type.
The Styles property determines the collection of formatting styles used in the DataGrid component.
The TableFilter property determines the autofiltering settings of the DataGrid component.
The TotalScope property determines, within which limits totals should be calculated.
The VisualFocusedRow property returns the index of the visible focused table row.
The VisualRowCount property returns the number of rows actually displayed in a table.

Properties inherited from IControl

  Property name Brief description
The Align property determines component alignment within its parent component.
The AllowDrag property determines whether an object can be dragged from a component.
The AllowDrop property determines whether the component can accept a dragged object.
The Anchors property returns settings determining % of the resize for the current component when the parent component is resized.
The Brush property determines the brush that is used to fill the component area.
The ClientHeight property determines the height of the client component area.
The ClientWidth property determines the width of the client component area.
The Color property determines color of the component background.
The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.
The Enabled property determines whether a component is available for the user.
The Focused property returns True if the focus is set to the component.
The Font property determines parameters of the font that is used to display text in the component.
The Height property determines component height in pixels.
The HelpContext property determines a unique index for a section of a context help for this component.
The Hint property determines a tooltip text displayed on hovering over the component.
The HintTimeout property determines for how long a tooltip is displayed.
The Left property determines a coordinate of the component left edge in pixels.
The Parent property determines a parent component.
The ParentColor property determines whether a component inherits the color of the parent component.
The ParentFont property determines whether a component uses the font of the parent component.
The ParentShowHint property determines when a tooltip is displayed.
The PopupMenu property determines the context menu displayed when a component is clicked with the right mouse button.
The Scrolls property returns parameters of component's scrollbars.
The ShowHint property determines whether a tooltip is displayed when the component is hovered.
The TabOrder property determines a component position in a tab order.
The TabStop property determines whether the component must be focused when the Tab button is pressed.
The Text property determines a row identifying a component for the user.
The Top property determines a coordinate of the component top edge in pixels.
The Visible property determines whether the component is displayed when a form is executed.
The Width property sets component width in pixels.

Properties inherited from IComponent

  Property name Brief description
The ComponentCount property returns the number of child components located on the parent component.
The Components property returns a child component, which index is passed via the input parameter.
The Data property is used to store any custom data.
The Name property determines the component name.
The Tag property is not used by the compiler. The user can change the value of this property and use it at his discretion.

Methods inherited from IDataGrid

   Method name Brief description
BeginUpdate The BeginUpdate method prohibits the DataGrid component redrawing.
EndUpdate The EndUpdate method disables the DataGrid component redrawing prohibition.
GetCellCoordAt The GetCellCoordAt method transforms coordinates of the specified point into component cell coordinates.
LoadAutoFilters The LoadAutoFilters method loads the table autofilters parameters.
LoadColumns The LoadColumns method loads table columns parameters.
ParametersOfColumnsDialog The ParametersOfColumnsDialog method calls the columns sorting settings dialog box.
RealToVisual The RealToVisual method returns the index of a visible row based on the absolute index of the row in a table.
SaveAutoFilters The SaveAutoFilters method saves the parameters of the autofilters that are set for table columns.
SaveColumns The SaveColumns method saves table columns parameters.
SelectColumnsDialog The SelectColumnsDialog method calls the dialog box for selecting bands or columns displayed in the component.
VisualToReal The VisualToReal method returns the absolute index of a row based on the index of the row among the actually displayed rows.

Methods inherited from IControl

  Method name Brief description
Outdated. The BringToFront method brings a component to the foreground.
The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
The DoDragDrop method enables the user to start dragging operation.
The GetImage method returns a graphic presentation of a component together with all child components.
The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
Outdated. The SendToBack method is used to send a component to the background.
The SetFocus method sets focus to this component.

Events

   Event name Brief description
The OnAfterEdit event occurs after an attempt to change the cell value.
The OnBandBaseClick event occurs after clicking on the column or band header.
The OnBandBaseMove event occurs on moving a column or a band.
The OnBandBaseResize event occurs on changing the width of the column or band.
The OnBeforeCellChange event occurs before assigning a new value to a cell.
The OnBeforeEdit event occurs before beginning of editing (interactive) a cell.
The OnCellChange event occurs after changing the value of any table cell.
The OnChangeBandVisible event occurs on changing of visibility of any component band or column.
The OnCompareItems event occurs at comparison of column values using custom sorting of the DataGrid component.
The OnFilter event follows the setting of filter in any table column.
The OnFocusedChange events occurs when focus is transferred to another cell of the component.
The OnGetCellStyle event occurs on cell drawing.
The OnGetRowStyle event occurs on row drawing.
The OnGetSelectedCellStyle event occurs when a selected cell is drawn.
The OnGetSelectedRowStyle event occurs when a selected row is drawn.
The OnSort event occurs after column sorting.

Events inherited from IControl

   Event name Brief description
The OnBeginDrag event occurs for the component when the user starts to drag an object from the component.
The OnClick event occurs if the user clicks the component area with the main mouse button.
The OnControlMove event occurs when the component is moved.
The OnControlResize event occurs when the component is resized.
The OnDblClick event occurs if the user double-clicks the component area with the mouse button.
The OnDragDrop event occurs for the component if the user drops a dragged object over it.
The OnDragEnter event occurs when a dragged object enters the component area.
The OnDragLeave event occurs when a dragged object leaves component borders.
The OnDragOver event occurs for the component when the user drags an object over it.
The OnEnter event occurs when the component receives focus.
The OnExit event occurs when the component loses focus.
The OnHScroll event occurs when horizontal scrollbar slider changes its position.
The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
The OnKeyPress event occurs if the component is focused when the user presses a character key.
The OnKeyPreview event occurs prior to each event related to key pressing.
The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
The OnMouseDown event occurs if the pointer is in the component area and a mouse key is pressed.
The OnMouseEnter event occurs when mouse cursor enters the component area.
The OnMouseHover event occurs when mouse cursor is held in the component area.
The OnMouseLeave event occurs when mouse cursor leaves the component area.
The OnMouseMove event occurs when the cursor is moved over the component.
The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.
The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel.
The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

ExtCtrls Assembly Classes