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

TDrawGrid

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

TDrawGrid - a drawn grid. May contain images in its cells

Declaration

Source position: grids.pas line 1498

type TDrawGrid = class(TCustomDrawGrid) end;

public

  property InplaceEditor: TWinControl;

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 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 Color: TColor;

  

The background color of the control.

  property ColCount: Integer;

  

Number of columns of the grid.

  property ColumnClickSorts: Boolean;

  property Columns: TGridColumns;

  

The properties of the columns in this grid

  property Constraints: TSizeConstraints;

  property DefaultColWidth: Integer;

  

Default value for the width of newly created grid columns.

  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 DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property ExtendedSelect: Boolean;

  

ExtendedSelect - the ability to select cells beyond the boundary of the visible part of the grid

  property FixedColor: TColor;

  

The color for the fixed cells of the grid.

  property FixedCols: Integer;

  

Number of the fixed columns of the grid (ie the columns containing title or identifier material, that don't get scrolled when the rest of the grid moves).

  property FixedRows: Integer;

  

Number of the fixed rows of the grid (ie the rows containing title or identifier material, that don't get scrolled when the rest of the grid moves).

  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 GridLineWidth: Integer;

  

Width (thickness) of GridLines

  property HeaderHotZones: TGridZoneSet;

  

HeaderHotZones - the header zones corresponding to the position of the mouse cursor

  property HeaderPushZones: TGridZoneSet;

  

HeaderPushZones - the zones of the header that have been pushed down (selected)

  property MouseWheelOption: TMouseWheelOption;

  property Options: TGridOptions;

  

The options available for use in this grid

  property Options2: TGridOptions2;

  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 ParentShowHint: Boolean;

  

If true, the value of ShowHint for 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 RangeSelectMode: TRangeSelectMode;

  property RowCount: Integer;

  

Number of rows in the grid

  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;

  

TitleImageList - the list of images to be used with the titles

  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 VisibleColCount: Integer;

  

The number of visible columns

  property VisibleRowCount: Integer;

  

The number of visible rows

  property OnAfterSelection: TOnSelectEvent;

  property OnBeforeSelection: TOnSelectEvent;

  

OnBeforeSelection - event handler for use before a selection is made

  property OnCheckboxToggled: TToggledCheckboxEvent;

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnColRowDeleted: TGridOperationEvent;

  

Event handler when a grid column or row is deleted

  property OnColRowExchanged: TGridOperationEvent;

  

Event handler when a grid column or row has its position exchanged with another

  property OnColRowInserted: TGridOperationEvent;

  

Event handler when a column or row is inserted into the grid

  property OnColRowMoved: TGridOperationEvent;

  

Event handler when a grid column or row is moved

  property OnCompareCells: TOnCompareCells;

  

Event handler for comparing the contents of cells

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  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 OnDrawCell: TOnDrawCell;

  

Event handler for drawing a cell

  property OnEditButtonClick: TNotifyEvent; deprecated ;

  

Event handler for when the Edit button is clicked

  property OnButtonClick: TOnSelectEvent;

  property OnEditingDone: TNotifyEvent;

  

Event handler when editing is done.

  property OnEndDock: TEndDragEvent;

  

Notification handler for the end of a docking operation.

  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 OnGetCellHint: TGetCellHintEvent;

  property OnGetCheckboxState: TGetCheckboxStateEvent;

  property OnGetEditMask: TGetEditEvent;

  

Event handler for finding the edit mask while editing a grid cell

  property OnGetEditText: TGetEditEvent;

  

Event handler for finding the text to be edited in a grid cell

  property OnHeaderClick: THdrEvent;

  

Event handler when a column or row header is clicked

  property OnHeaderSized: THdrEvent;

  

Event handler when a column or row header is re-sized

  property OnHeaderSizing: THeaderSizingEvent;

  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;

  

Notification handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Notification handler for upward movement of mouse wheel.

  property OnPickListSelect: TNotifyEvent;

  

Event handler for selecting an item from a picklist (eg drop-down list in TComboBox)

  property OnPrepareCanvas: TOnPrepareCanvasEvent;

  

Event handler to prepare the Canvas for drawing

  property OnSelectEditor: TSelectEditorEvent;

  

Event handler for selecting an editor

  property OnSelection: TOnSelectEvent;

  

Event handler for when an area of a grid (one or a group of cells) is selected

  property OnSelectCell: TOnSelectCellEvent;

  

Event handler when a grid cell is selected

  property OnSetCheckboxState: TSetCheckboxStateEvent;

  property OnSetEditText: TSetEditEvent;

  

Event handler for storing the text that has been edited in a cell

  property OnStartDock: TStartDockEvent;

  

Event handler for the start of a docking operation.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnTopleftChanged: TNotifyEvent;

  

Event handler when the top left cell is changed (ie the grid has been scrolled so that a different cell occupies top left)

  property OnUserCheckboxBitmap: TUserCheckBoxBitmapEvent;

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

Inheritance

TDrawGrid

  

TDrawGrid - a drawn grid. May contain images in its cells

|

TCustomDrawGrid

  

TCustomDrawGrid - Base Class for drawn grids including TDrawGrid and TStringGrid

|

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

See also

HowToUseGrids

  

How to use Grids including StringGrids, DrawGrids and DbGrids

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