[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'DBGrids' (#lcl)

TDBGrid

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TdbGrid - a data-aware version of TStringGrid, for displaying and operating on a series of Rows and Columns from a database

Declaration

Source position: dbgrids.pas line 530

type TDBGrid = class(TCustomDBGrid) end;

public

  property BorderColor: TColor;

  

The colour of the border for this control

  property Canvas: TCanvas;

  

The drawing surface for the control, see TCanvas for details.

  property DefaultTextStyle: TTextStyle;

  

Default style for displaying text - includes alignment, layout, single or multi-lines

  property EditorBorderStyle: TBorderStyle;

  

The border style for the editor used in this grid

  property EditorMode: Boolean;

  

Is grid ready to accept edits? (EditorMode True)

  property ExtendedColSizing: Boolean;

  

ExtendedColSizing - the sizing to be used for extended columns

  property FastEditing: Boolean;

  

Is the FastEditing method being used?

  property FocusColor: TColor;

  

The colour to be used for the cell receiving focus

  property FocusRectVisible: Boolean;

  

FocusRectVisible - is the rectangle receiving focus visible?

  property GridLineColor: TColor;

  

Colour to be used for GridLines

  property GridLineStyle: TPenStyle;

  

Style to be used for GridLines

  property InplaceEditor: TWinControl;

  property SelectedColor: TColor;

  

Colour to be used for selected cells

  property SelectedRows: TBookmarkList;

  

SelectedRows - recorded as a bookmark list

  property OnRowMoved: TMovedEvent;

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property AlternateColor: TColor;

  

The colour to be used for the background on alternate rows of the grid. Having alternate rows in different colours can make the grid easier to read.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoAdvance: TAutoAdvance;

  

Automatically advance down the grid on successive mouse clicks or presses of the ENTER or TAB key

  property AutoEdit: Boolean;

  

Whether the Edit mode is automatically entered when a cell is selected

  property AutoFillColumns: Boolean;

  

Automatically resize columns so they fill all grid's visible area

  property BiDiMode: TBiDiMode;

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  

Allows to show a border (line) around the control,

  property CellHintPriority: TCellHintPriority;

  property Color: TColor;

  

The background color of the control.

  property Columns: TDBGridColumns;

  

The properties of the columns in this grid

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property DataSource: TDataSource;

  

The DataSource from which this grid displays - usually the result of a database Query

  property DefaultDrawing: Boolean;

  

Is the default drawing method to be used for this grid? Default is TRUE

  property DefaultRowHeight: Integer;

  

Default value for the height of newly created grid rows.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property FixedColor: TColor;

  

The color for the fixed cells of the grid.

  property FixedCols: Integer;

  property FixedHotColor: TColor;

  

FixedHotColor - the 'Hot' colour for the active (selected, etc) fixed cells of the grid

  property Flat: Boolean;

  

Is the cell to be displayed Flat, ie with no texturing or raised/lowered effect

  property Font: TFont;

  

The font to be used for text display in this control.

  property HeaderHotZones: TGridZoneSet;

  

HeaderHotZones - the zones of the header that are under the cursor, so are capable of being selected or pushed (or not!)

  property HeaderPushZones: TGridZoneSet;

  

HeaderPushZones - the zones of the header that have been selected by the cursor, or pushed

  property Options: TDbGridOptions;

  

The options available for use in this grid

  property Options2: TGridOptions2;

  property OptionsExtra: TDbGridExtraOptions;

  

OptionsExtra - the extra options for this grid

  property ParentBiDiMode: Boolean;

  property ParentColor: Boolean;

  

If true, the Color of the control will be the same as the one from the Parent. Default is true.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control

  property ReadOnly: Boolean;

  

Set True to prevent writing to grid; set False to allow modification

  property Scrollbars: TScrollStyle;

  

The ScrollBars to be used with this grid

  property ShowHint: Boolean;

  

Enables the Hint display.

  property TabAdvance: TAutoAdvance;

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property TitleFont: TFont;

  

The font to be used in the grid's title

  property TitleImageList: TImageList;

  property TitleStyle: TTitleStyle;

  

The style to be used for the grid's title

  property UseXORFeatures: Boolean;

  

UseXORFeatures: When True, the dotted focus rectangle is painted using the XOR raster operation

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

  property OnCellClick: TDBGridClickEvent;

  

Event handler for mouse click in a cell of the grid

  property OnColEnter: TNotifyEvent;

  

Event handler if mouse enters column or it gains focus

  property OnColExit: TNotifyEvent;

  

Event handler if mouse leaves column or it loses focus

  property OnColumnMoved: TMovedEvent;

  

OnColumnMoved - event handler for moving a column

  property OnColumnSized: TNotifyEvent;

  

OnColumnSized - event handler for re-sizing a column

  property OnContextPopup: TContextPopupEvent;

  property OnDrawColumnCell: TDrawColumnCellEvent;

  

Event handler if the cell in this column requires to be drawn

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEditButtonClick: TNotifyEvent;

  

Event handler for when the Edit button is clicked

  property OnEditingDone: TNotifyEvent;

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus. This is a good place for checking the finished user input.

  property OnFieldEditMask: TGetDbEditMaskEvent;

  

Event handler if field is associated with an edit mask

  property OnGetCellHint: TDbGridCellHintEvent;

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnPrepareCanvas: TPrepareDbGridCanvasEvent;

  

OnPrepareCanvas - event handler for preparing canvas

  property OnSelectEditor: TDbGridSelEditorEvent;

  

OnSelectEditor - event handler for selecting editor

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnTitleClick: TDBGridClickEvent;

  

Event handler for mouse click on Title

  property OnUserCheckboxBitmap: TDbGridCheckBoxBitmapEvent;

  

OnUserCheckboxBitmap - event handler for a user accessing a checkbox bitmap

  property OnUserCheckboxState: TDbGridCheckboxStateEvent;

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

Inheritance

TDBGrid

  

TdbGrid - a data-aware version of TStringGrid, for displaying and operating on a series of Rows and Columns from a database

|

TCustomDBGrid

  

TCustomDBGrid - the base class for TDBGrid , for displaying database information in the manner of a StringGrid

|

TCustomGrid

  

TCustomGrid - the base class for all grid controls

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

Description

TdbGrid - a data-aware version of TStringGrid, for displaying and operating on a series of Rows and Columns from a database

Inherits many of its properties from TCustomGrid and, of course, from TCustomDBGrid

See also

HowToUseDataAwareControls

  

HowToUseDataAwareControls - Hints for accessing databases

HowToUseGrids

  

How to use Grids including StringGrids, DrawGrids and DbGrids

The latest version of this document can be found at lazarus-ccr.sourceforge.net.