DrawGrid¶

Qualified name: delphivcl.DrawGrid

class DrawGrid¶

Bases: CustomDrawGrid

TDrawGrid represents a grid control that displays information in column and row format. Add a TDrawGrid object to a form to present arbitrary information in a tabular format. TDrawGrid provides many properties to control the appearance of the grid, as well as events and methods that take advantage of the tabular organization of the grid in responding to user actions. TDrawGrid introduces several events and methods to allow applications to customize the appearance and behavior of the grid. If the cells of the grid contain text strings that represent objects, consider using a TStringGrid object instead. If the grid displays field values from the records in a dataset, use TDBGrid instead.

Methods

`CanFocus`	Indicates whether a control can receive focus.
`SetFocus`	Gives the input focus to the control.

Attributes

`Action`	Specifies the action associated with the control.
`Align`	Determines how the control aligns within its container (parent control).
`AlignDisabled`	Indicates child control realignment disabled.
`AlignWithMargins`	Specifies whether a control should be constrained by margins.
`Anchors`	Specifies how the control is anchored to its parent.
`BevelEdges`	Specifies which edges of the control are beveled.
`BevelInner`	Specifies the cut of the inner bevel.
`BevelKind`	Specifies the control's bevel style.
`BevelOuter`	Specifies the cut of the outer bevel.
`BevelWidth`	Specifies the width of the inner and outer bevels.
`BiDiMode`	Specifies the bidirectional mode for the control.
`BorderStyle`	Determines whether a single line border is drawn around the grid.
`BoundsRect`	Specifies the bounding rectangle of the control, expressed in the coordinate system of the parent control.
`Brush`	Determines the color and pattern used for painting the background of the control.
`Canvas`	Specifies the TCanvas object that presents a drawing surface for the control.
`CellAlignments`	Alignment:
`ClassName`	Returns the TObject.ClassName
`ClientHeight`	Specifies the height of the control's client area in pixels.
`ClientOrigin`	Specifies the screen coordinates (in pixels) of the upper-left corner of a control's client area.
`ClientRect`	Specifies the size of a control's client area in pixels.
`ClientWidth`	Specifies the horizontal size of the control's client area in pixels.
`Col`	Specifies the index of the column that contains the selected cell.
`ColAlignments`	Alignment:
`ColCount`	Specifies the number of columns in the grid.
`ColWidths`	Specifies column widths of the grid
`Color`	Specifies the background color of the control.
`ComObject`	Specifies the interface reference implemented by the component.
`ComponentCount`	Returns the owned component count
`ComponentIndex`	Indicates the position of the component in its owner's Components property array.
`ComponentState`	Describes the current state of the component, indicating when a component needs to avoid certain actions.
`ComponentStyle`	Governs the behavior of the component.
`Components`	Returns an iterator over the owned components
`Constraints`	Specifies the size constraints for the control.
`ControlCount`	Returns the count of contained controls
`ControlState`	Specifies the current state of a control at run time.
`ControlStyle`	Determines style characteristics of the control.
`Controls`	Returns an iterator over contained controls
`Ctl3D`	Determines whether a control has a three-dimensional (3-D) or two-dimensional look.
`CurrentPPI`	Embarcadero Technologies does not currently have any additional information.
`Cursor`	Specifies the image used to represent the mouse pointer when it passes into the region covered by the control.
`CustomHint`	CustomHint is a custom hint for the control.
`DefaultColAlignment`	DefaultColAlignment is the default text alignment for all columns where alignment is not explicitly specified using TCustomGrid.ColAlignments.
`DefaultColWidth`	Determines the width (in pixels) of all columns that have not been explicitly resized.
`DefaultDrawing`	Determines whether the Cells are painted when the grid is drawn.
`DefaultRowHeight`	Specifies the height (in pixels) of all rows that have not been explicitly resized.
`DesignInfo`	Contains information used by the Form designer.
`DockClientCount`	Specifies the number of controls that are docked on the windowed control.
`DockClients`	Control:
`DockManager`	Specifies the control's docking manager interface.
`DockOrientation`	DockOrientation specifies how the control is docked relative to other controls docked in the same parent.
`DockSite`	Specifies whether the control can be the target of drag-and-dock operations.
`DoubleBuffered`	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
`DoubleBufferedMode`	DoubleBufferedMode:
`DragCursor`	Specifies the image used to represent the mouse pointer when the control is being dragged.
`DragKind`	Specifies whether the control is being dragged normally or for docking.
`DragMode`	Specifies how the control initiates drag-and-drop or drag-and-dock operations.
`DrawingStyle`	Determines the style used when drawing the grid.
`EditorMode`	Determines whether the current cell can be edited.
`Enabled`	Controls whether the control responds to mouse, keyboard, and timer events.
`ExplicitHeight`	Specifies the explicit vertical size of the control in pixels.
`ExplicitLeft`	Specifies the explicit horizontal pixel coordinate of the left edge of a component relative to its parent.
`ExplicitTop`	Specifies the explicit vertical pixel coordinate of the top edge of a component relative to its parent.
`ExplicitWidth`	Specifies the explicit horizontal size of the control in pixels.
`FixedColor`	Specifies the background color of the fixed rows and columns in the grid.
`FixedCols`	Specifies the number of columns on the left of the grid that cannot be scrolled.
`FixedRows`	Specifies the number of rows on the top of the grid that cannot be scrolled.
`Floating`	Specifies whether the control is floating.
`FloatingDockSiteClass`	Specifies the class of the temporary control that hosts the control when it is floating.
`Focused`	Determines whether the control has input focus.
`Font`	Specifies the attributes of text written on or in the control.
`GradientEndColor`	Determines the ending gradient color.
`GradientStartColor`	Determines the starting gradient color.
`GridHeight`	Specifies the height of the grid in pixels.
`GridLineWidth`	Specifies the width (in pixels) of the lines that separate the cells of the grid.
`GridWidth`	Specifies the width of the grid in pixels.
`Handle`	Provides access to the underlying Windows screen object for the control.
`HandleAllocated`	Reports whether a screen object handle exists for the control.
`Height`	Specifies the vertical size of the control in pixels.
`HelpContext`	The HelpContext property contains the numeric context ID that identifies the Help topic for the control.
`HelpKeyword`	The HelpKeyword property contains the keyword string that identifies the Help topic for the control.
`HelpType`	Specifies whether the control's context-sensitive Help topic is identified by a context ID or by keyword.
`Hint`	Hint contains the text string that appears when the user moves the mouse over the control.
`HostDockSite`	Specifies the control in which the control is docked.
`IsDrawingLocked`	IsDrawingLocked property returns True when redrawing for this control is locked.
`IsUpdating`	Embarcadero Technologies does not currently have any additional information.
`LRDockWidth`	Specifies the width of the control when it is docked horizontally.
`Left`	Specifies the horizontal coordinate of the left edge of a component relative to its parent.
`LeftCol`	Specifies the index of the first visible scrollable column in the grid.
`Margins`	Specifies the margins of the control.
`MouseInClient`	Indicates whether the mouse pointer is currently in the client area of the control.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`OnColumnMoved`	Callable[[Object, int, int], None]:
`OnDragDrop`	Callable[[Object, Object, int, int], None]:
`OnDragOver`	Callable[[Object, Object, int, int, DragState, bool], None]:
`OnEndDock`	Callable[[Object, Object, int, int], None]:
`OnEndDrag`	Callable[[Object, Object, int, int], None]:
`OnFixedCellClick`	Callable[[Object, int, int], None]:
`OnGesture`	Callable[[Object, GestureEventInfo, bool], None]:
`OnGetEditMask`	Callable[[Object, int, int, str], None]:
`OnGetEditText`	Callable[[Object, int, int, str], None]:
`OnMouseActivate`	Callable[[Object, MouseButton, ShiftState, int, int, int, MouseActivate], None]:
`OnMouseWheelDown`	Callable[[Object, ShiftState, Point, bool], None]:
`OnMouseWheelUp`	Callable[[Object, ShiftState, Point, bool], None]:
`OnRowMoved`	Callable[[Object, int, int], None]:
`OnSetEditText`	Callable[[Object, int, int, str], None]:
`OnStartDock`	Callable[[Object, DragDockObject], None]:
`OnStartDrag`	Callable[[Object, DragObject], None]:
`Options`	Specifies various display and behavioral properties of the grid.
`Owner`	Returns the Component Owner
`Padding`	Specifies the padding of a control.
`Parent`	Returns/Sets the Control Parent
`ParentBiDiMode`	Specifies whether the control uses its parent's BiDiMode.
`ParentColor`	Specifies where a control looks for its color information.
`ParentCtl3D`	Determines where a component looks to determine whether it should have a three-dimensional look.
`ParentCustomHint`	Specifies where a control looks for its custom hint.
`ParentDoubleBuffered`	ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
`ParentFont`	Specifies where a control looks for its font information.
`ParentShowHint`	Specifies where a control looks to find out if its Help Hint should be shown.
`ParentWindow`	Reference to parent's underlying control.
`PixelsPerInch`	Embarcadero Technologies does not currently have any additional information.
`PopupMenu`	Specifies the pop-up menu associated with the control.
`RedrawDisabled`	RedrawDisabled property returns True when redrawing for this control is locked.
`Row`	Specifies the index of the row that contains the selected cell.
`RowCount`	Specifies the number of rows in the grid.
`RowHeights`	Specifies row heights of the grid
`ScaleFactor`	Embarcadero Technologies does not currently have any additional information.
`ScrollBars`	Specifies whether the grid includes horizontal and vertical scroll bars.
`Selection`	Indicates the boundaries of the current selection.
`ShowHint`	ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control.
`Showing`	Indicates whether the control is showing on the screen.
`StyleElements`	Specifies the style elements that are used by the control.
`StyleName`	Embarcadero Technologies does not currently have any additional information.
`TBDockHeight`	Specifies the height of the control when it is docked vertically.
`TabOrder`	Indicates the position of the control in its parent's tab order.
`TabStop`	Determines whether the user can tab to a control.
`TabStops`	bool:
`Tag`	Stores a NativeInt integral value as a part of a component.
`Top`	Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels.
`TopRow`	Specifies the index of the first visible scrollable row in the grid.
`Touch`	Specifies the touch manager component associated with the control.
`UndockHeight`	Specifies the height of the control when it is floating.
`UndockWidth`	Specifies the width of the control when it is floating.
`UseDockManager`	Specifies whether the docking manager is used in drag-and-dock operations.
`VCLComObject`	Represents information used internally by components that support COM.
`Visible`	Specifies whether the component appears onscreen.
`VisibleColCount`	Indicates the number of scrollable columns visible in the grid.
`VisibleDockClientCount`	Specifies the number of visible controls that are docked on the windowed control.
`VisibleRowCount`	Indicates the number of scrollable rows visible in the grid.
`Width`	Specifies the horizontal size of the control or form in pixels.

Align¶

Determines how the control aligns within its container (parent control). Use Align to align a control to the top, bottom, left, or right of a form or panel and have it remain there even if the size of the form, panel, or component that contains the control changes. When the parent is resized, an aligned control also resizes so that it continues to span the top, bottom, left, or right edge of the parent. For example, to use a panel component with various controls on it as a tool palette, change the panel’s Align value to alLeft. The value of alLeft for the Align property of the panel guarantees that the tool palette remains on the left side of the form and always equals the client height of the form. The default value of Align is alNone, which means a control remains where it is positioned on a form or panel.

Tip: If Align is set to alClient, the control fills the entire client area so that it is impossible to select the parent form by clicking it. In this case, select the parent by selecting the control on the form and pressing ESC, or by using the Object Inspector. Any number of child components within a single parent can have the same Align value, in which case they stack up along the edge of the parent. The child controls stack up in z-order. To adjust the order in which the controls stack up, drag the controls into their desired positions.

Note: To cause a control to maintain a specified relationship with an edge of its parent, but not necessarily lie along one edge of the parent, use the Anchors property instead.

Type:: Align

Anchors¶

Specifies how the control is anchored to its parent. Use Anchors to ensure that a control maintains its current position relative to an edge of its parent, even if the parent is resized. When its parent is resized, the control holds its position relative to the edges to which it is anchored. If a control is anchored to opposite edges of its parent, the control stretches when its parent is resized. For example, if a control has its Anchors property set to [akLeft, akRight], the control stretches when the width of its parent changes. Anchors is enforced only when the parent is resized. Thus, for example, if a control is anchored to opposite edges of a form at design time and the form is created in a maximized state, the control is not stretched because the form is not resized after the control is created.

Note: If a control should maintain contact with three edges of its parent (hugging one side of the parent and stretching the length of that side), use the Align property instead. Unlike Anchors, Align allows controls to adjust to changes in the size of other aligned sibling controls as well as changes to the parent’s size.

Type:: Anchors

BevelEdges¶

Specifies which edges of the control are beveled. Use BevelEdges to get or set which edges of the control are beveled. The BevelInner, BevelOuter, and BevelKind properties determine the appearance of the specified edges.

Type:: BevelEdges

BevelInner¶

Specifies the cut of the inner bevel. Use BevelInner to specify whether the inner bevel has a raised, lowered, or flat look. The inner bevel appears immediately inside the outer bevel. If there is no outer bevel (BevelOuter is bvNone), the inner bevel appears immediately inside the border.

Type:: BevelCut

BevelKind¶

Specifies the control’s bevel style. Use BevelKind to modify the appearance of a bevel. BevelKind influences how sharply the bevel stands out. BevelKind, in combination with BevelWidth and the cut of the bevel specified by BevelInner or BevelOuter, can create a variety of effects. Experiment with various combinations to get the look you want.

Type:: BevelKind

BevelOuter¶

Specifies the cut of the outer bevel. Use BevelOuter to specify whether the outer bevel has a raised, lowered, or flat look. The outer bevel appears immediately inside the border and outside the inner bevel.

Type:: BevelCut

BevelWidth¶

Specifies the width of the inner and outer bevels. Use BevelWidth to specify the width, in pixels, of the inner and outer bevels.

Type:: int

BiDiMode¶

Specifies the bidirectional mode for the control. Use BiDiMode to enable the control to adjust its appearance and behavior automatically when the application runs in a locale that reads from right to left instead of left to right. The bidirectional mode controls the reading order for the text, the placement of the vertical scroll bar, and whether the alignment is changed. Alignment does not change for controls that are known to contain number, date, time, or currency values. For example, with data-aware controls, the alignment does not change for the following field types: ftSmallint, ftInteger, ftWord, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftAutoInc.

Type:: BiDiMode

BorderStyle¶

Determines whether a single line border is drawn around the grid. Set BorderStyle to bsSingle to add a single line border around the grid’s image. Set BorderStyle to bsNone to omit the border.

Type:: BorderStyle

CanFocus()¶: Indicates whether a control can receive focus.

Canvas¶: Specifies the TCanvas object that presents a drawing surface for the control.

Col¶: Specifies the index of the column that contains the selected cell.

ColCount¶

Specifies the number of columns in the grid. Read ColCount to determine the number entries in the ColWidths array. Set ColCount to add or delete columns at the right side of the grid. The value of ColCount includes any fixed columns at the left of the grid as well as the scrollable columns in the body of the grid.

Type:: int

ColWidths¶: Specifies column widths of the grid

Color¶

Specifies the background color of the control. Use Color to read or change the background color of the control. If a control’s Vcl.Controls.TControl.ParentColor property is True, then changing the Color property of the control’s parent automatically changes the Color property of the control. When the value of the Color property is changed, the control’s ParentColor property is automatically set to False. The Color of a TLabel is always the color of the background unless you set TLabel.Transparent to False.

Type:: int

Constraints¶

Specifies the size constraints for the control. Use Constraints to specify the minimum and maximum width and height of the control. When Constraints contains maximum or minimum values, the control cannot be resized to violate those constraints.

Note: Constraints apply to the height of the form. However, the height of the form depends on how large Windows makes the title bar. For example, Windows XP uses much larger title bars than other windowing systems. To work around this, note the ClientHeight when you design your form and set the constraints in the FormCreate event. In the following example, ClientHeight is represented by x: Constraints.MinHeight�:= x + Height - ClientHeight. Warning: Do not set up constraints that conflict with the value of the Align or Anchors property. When these properties conflict, the response of the control to resize attempts is not well-defined.

Type:: SizeConstraints

Ctl3D¶

Determines whether a control has a three-dimensional (3-D) or two-dimensional look. Ctl3D is provided for backward compatibility. It is not used by 32-bit versions of Windows or NT4.0 and later, with the exception of Windows XP Home, where it is used on occasion. On earlier platforms, Ctl3D controlled whether the control had a flat or beveled appearance.

Note RAD Studio no longer supports Windows Vista or earlier.

Type:: bool

DefaultColAlignment¶

DefaultColAlignment is the default text alignment for all columns where alignment is not explicitly specified using TCustomGrid.ColAlignments.

Type:: Alignment

DefaultColWidth¶

Determines the width (in pixels) of all columns that have not been explicitly resized. Set DefaultColWidth to change the size of all columns in the grid. When DefaultColWidth is set, columns that have been resized using the mouse or by setting the ColWidths property are given the DefaultColWidth as well. When new columns are added to the grid using the ColCount property, they are created with a width of DefaultColWidth.

Type:: int

DefaultDrawing¶

Determines whether the Cells are painted when the grid is drawn. Set DefaultDrawing to true to have the grid automatically paint the cells in the grid, including adding the background color, the 3-D effects on the fixed cells, and the focus rectangle around the selected cell. Set DefaultDrawing to false to skip the painting of the cells when the grid is drawn. When DefaultDrawing is false, the cells should be painted using the DrawCell method. For TCustomGrid, DrawCell is an abstract method. Descendants of TCustomGrid use DrawCell to provide their own customized drawing code, or to generate an OnDrawCell event.

Type:: bool

DefaultRowHeight¶

Specifies the height (in pixels) of all rows that have not been explicitly resized. Set DefaultRowHeight to change the size of all rows in the grid. When DefaultRowHeight is set, rows that have been resized using the mouse or by setting the RowHeights property are given the DefaultRowHeight as well. When new rows are added to the grid using the RowCount property, they are created with a height of DefaultRowHeight.

Type:: int

DoubleBuffered¶

Determines whether the control’s image is rendered directly to the window or painted to an in-memory bitmap first. When DoubleBuffered is false, the windowed control paints itself directly to the window. When DoubleBuffered is true, the windowed control paints itself to an in-memory bitmap that is then used to paint the window. Double buffering reduces the amount of flicker when the control repaints, but is more memory intensive. When a windowed control is a dock site and has an associated dock manager, it must be double-buffered.

Note: Some controls, such as TRichEdit, can’t paint themselves into a bitmap. For such controls, DoubleBuffered must be set to false.

Type:: bool

DoubleBufferedMode¶: DoubleBufferedMode:

DragCursor¶

Specifies the image used to represent the mouse pointer when the control is being dragged. Use the DragCursor property to change the cursor image presented when the control is being dragged.

Note: To make a custom cursor available for the DragCursor property, see the Cursor property.

Type:: int

DragKind¶

Specifies whether the control is being dragged normally or for docking. Use DragKind to get or set whether the control participates in drag-and-drop operations or drag-and-dock operations.

Type:: DragKind

DragMode¶

Specifies how the control initiates drag-and-drop or drag-and-dock operations. Use DragMode to control when the user can drag the control. Disable the drag-and-drop or drag-and-dock capability at run time by setting the DragMode property value to dmManual. Enable automatic dragging by setting DragMode to dmAutomatic. For more information about dmManual and dmAutomatic, see TDragMode.

Type:: DragMode

DrawingStyle¶

Determines the style used when drawing the grid. DrawingStyle determines the style used to draw the grid. The following table lists the possible values of DrawingStyle.

Value

Meaning

gdsClassic

The grid control uses the standard, unthemed style.

gdsThemed

The grid control uses the current operating system theme.

gdsGradient

The grid control uses gradients for styling.

Notes about DrawingStyle for Vcl.Grids.TStringGrid: Setting FixedColor has no effect unless you also set DrawingStyle to gdsClassic. Setting GradientStartColor and GradientEndColor has no effect unless you set the value of DrawingStyle to gdsGradient.

Type:: GridDrawingStyle

EditorMode¶: Determines whether the current cell can be edited.

Enabled¶

Controls whether the control responds to mouse, keyboard, and timer events. Use Enabled to change the availability of the control to the user. To disable a control, set Enabled to False. Some disabled controls appear dimmed (for example: buttons, check boxes, labels), while others (container controls) simply lose their functionality without changing their appearance. If Enabled is set to False, the control ignores mouse, keyboard, and timer events. To re-enable a control, set Enabled to True.

Note: This property applies to all TControl descendants.

Type:: bool

FixedColor¶

Specifies the background color of the fixed rows and columns in the grid. Set FixedColor to specify the color for the nonscrolling cells in the grid. The scrolling region of the grid is drawn using the Color property.

Type:: int

FixedCols¶

Specifies the number of columns on the left of the grid that cannot be scrolled. Set FixedCols to create or get rid of nonscrolling columns. Nonscrolling columns appear at the left of the grid, and are always visible, even when the user scrolls the other columns in the grid. Use nonscrolling columns for displaying row titles or row numbers, or to implement a scroll lock that the user can set. Nonscrolling columns are visually distinct from the scrollable columns in the grid. They are painted with a separate background color, and their cells have a raised, 3-D look.

Note: Grids must include at least one scrolling column. Do not set FixedCols to a value greater than ColCount - 1.

Type:: int

FixedRows¶

Specifies the number of rows on the top of the grid that cannot be scrolled. Set FixedRows to create or get rid of nonscrolling rows. Nonscrolling rows appear at the top of the grid, and are always visible, even when the user scrolls the other rows in the grid. Use nonscrolling rows for displaying column titles or column numbers. Nonscrolling rows are visually distinct from the scrollable rows in the grid. They are painted with a separate background color, and their cells have a raised, 3-D look.

Note: Grids must include at least one scrolling row. Do not set FixedRows to a value greater than RowCount - 1.

Type:: int

Font¶

Specifies the attributes of text written on or in the control. To change to a new font, specify a new TFont object. To modify a font, change the value of the Charset, Color, Height, Name , Pitch, Size, or Style of the TFont object.

Note: Changing the font color of the Caption is not supported for some controls (such as TButton). In most cases, there is an alternate control you can use whose Font property will change the color of the caption or text (such as TBitBtn or TSpeedButton).

Type:: Font

GradientEndColor¶

Determines the ending gradient color. GradientEndColor determines the ending gradient color. GradientEndColor is used when the value of DrawingStyle is gdsGradient. GradientEndColor and GradientStartColor define the color range used when drawing individual cells within the grid control.

Type:: int

GradientStartColor¶

Determines the starting gradient color. GradientStartColor determines the starting gradient color. GradientStartColor is used when the value of DrawingStyle is gdsGradient. GradientEndColor and GradientStartColor define a color range used when drawing individual cells within the grid control.

Type:: int

GridHeight¶: Specifies the height of the grid in pixels.

GridLineWidth¶

Specifies the width (in pixels) of the lines that separate the cells of the grid. Set GridLineWidth to make the lines that separate the cells in the grid heavier or lighter. When GridLineWidth is zero, no separators are drawn between the cells of the grid. GridLineWidth will have no effect if the Options property does not include goFixedHorzLine, goFixedVertLine, goHorzLine, or goVertLine.

Note: Values greater than 3 pixels are not recommended for applications that run on Windows 9x or Windows ME because of distortions that can appear.

Type:: int

GridWidth¶: Specifies the width of the grid in pixels.

LeftCol¶: Specifies the index of the first visible scrollable column in the grid.

OnColumnMoved¶: Callable[[Object, int, int], None]:

OnDragDrop¶: Callable[[Object, Object, int, int], None]:

OnDragOver¶: Callable[[Object, Object, int, int, DragState, bool], None]:

OnEndDock¶: Callable[[Object, Object, int, int], None]:

OnEndDrag¶: Callable[[Object, Object, int, int], None]:

OnFixedCellClick¶: Callable[[Object, int, int], None]:

OnGesture¶: Callable[[Object, GestureEventInfo, bool], None]:

OnGetEditMask¶: Callable[[Object, int, int, str], None]:

OnGetEditText¶: Callable[[Object, int, int, str], None]:

OnMouseActivate¶: Callable[[Object, MouseButton, ShiftState, int, int, int, MouseActivate], None]:

OnMouseWheelDown¶: Callable[[Object, ShiftState, Point, bool], None]:

OnMouseWheelUp¶: Callable[[Object, ShiftState, Point, bool], None]:

OnRowMoved¶: Callable[[Object, int, int], None]:

OnSetEditText¶: Callable[[Object, int, int, str], None]:

OnStartDock¶: Callable[[Object, DragDockObject], None]:

OnStartDrag¶: Callable[[Object, DragObject], None]:

Options¶

Specifies various display and behavioral properties of the grid. Set Options to include the desired properties for the grid. See the type Vcl.Grids.TGridOptions for definitions of these properties.

Type:: GridOptions

ParentBiDiMode¶

Specifies whether the control uses its parent’s BiDiMode. Use ParentBiDiMode to get or set whether the control uses its parent’s BiDiMode. When ParentBiDiMode is true, the control’s BiDiMode property is always equal to that of its parent. If ParentBiDiMode is false, the control uses its own BiDiMode property. Set ParentBiDiMode to true for all controls in a form to ensure that the entire user interface adjusts to Middle Eastern locales in a uniform manner. When the value of the control’s BiDiMode property changes, ParentBiDiMode becomes false automatically.

Type:: bool

ParentColor¶

Specifies where a control looks for its color information. To have a control use the same color as its parent control, set ParentColor to True. If ParentColor is False, the control uses its own Color property. Set ParentColor to True for all controls to ensure that all the controls on a form have a uniform appearance. For example, if ParentColor is True for all controls in a form, changing the background color of the form to gray causes all the controls on the form to also have a gray background. When the value of a control’s Color property changes, ParentColor becomes False automatically.

Type:: bool

ParentCtl3D¶

Determines where a component looks to determine whether it should have a three-dimensional look. ParentCtl3D is provided for backwards compatibility. It has no effect on 32-bit versions of Windows or NT 4.0 and later. ParentCtl3D determines whether the control uses its parent’s Ctl3D property.

Type:: bool

ParentDoubleBuffered¶

ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent’s DoubleBuffered property. ParentDoubleBuffered is a boolean indicating that the DoubleBuffered property of this component is overridden by the value of the parent’s DoubleBuffered property.

Type:: bool

ParentFont¶

Specifies where a control looks for its font information. To have a control use the same font as its parent control, set ParentFont to true. If ParentFont is false, the control uses its own Font property. Many controls default ParentFont to true so that all the controls in a form or other container present a uniform appearance. When the value of a control’s Font property changes, ParentFont becomes false automatically. When ParentFont is true for a form, the form uses the default font. Currently, the default font is Tahoma 8 pt.

Type:: bool

ParentShowHint¶

Specifies where a control looks to find out if its Help Hint should be shown. Use ParentShowHint to ensure that all the controls on a form either uniformly show their Help Hints or uniformly do not show them. If ParentShowHint is True, the control uses the ShowHint property value of its parent. If ParentShowHint is False, the control uses the value of its own ShowHint property. To provide Help Hints only for selected controls on a form, set the ShowHint property for those controls that should have Help Hints to True, and ParentShowHint becomes False automatically.

Note: Enable or disable all Help Hints for the entire application using the ShowHint property of the application object.

Type:: bool

PopupMenu¶

Specifies the pop-up menu associated with the control. Assign a value to PopupMenu to make a pop-up menu appear when the user selects the control and clicks the right mouse button. If the TPopupMenu’s AutoPopup property is True, the pop-up menu appears automatically. If the menu’s AutoPopup property is False, display the menu with a call to its Popup method from the control’s OnContextPopup event handler.

Type:: PopupMenu

Row¶: Specifies the index of the row that contains the selected cell.

RowCount¶

Specifies the number of rows in the grid. Read RowCount to determine the number of entries in the RowHeights array. Set RowCount to add or delete rows at the bottom of the grid. The value of RowCount includes any fixed rows at the top of the grid as well as the scrollable rows in the body of the grid.

Type:: int

RowHeights¶: Specifies row heights of the grid

ScrollBars¶

Specifies whether the grid includes horizontal and vertical scroll bars. Use ScrollBars to give the grid horizontal or vertical scroll bars.

Note: If all the cells in the grid fit in the ClientWidth, no horizontal scroll bar appears, even if ScrollBars is ssHorizontal or ssBoth. If all the cells fit in the ClientHeight, no vertical scroll bar appears, even if ScrollBars is ssVertical or ssBoth.

Type:: ScrollStyle

Selection¶: Indicates the boundaries of the current selection.

SetFocus()¶: Gives the input focus to the control.

ShowHint¶

ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. ShowHint determines whether the Help Hint appears for the control. The Help Hint is the value of the TControl.Hint property. The Help Hint appears in a box just beneath the control when the mouse pointer moves over the control. To enable Help Hints for a particular control, two conditions must be satisfied:

The application’s ShowHint property must be True. Either the control’s own ShowHint property must be True, or the control’s ParentShowHint property must be True and its parent’s ShowHint property must be True. For example, imagine a check box within a group box. If the ShowHint property of the group box is True and the ParentShowHint property of the check box is True, but the ShowHint property of the check box is False, the check box still displays its Help Hint. Changing the ShowHint value automatically sets the ParentShowHint property to False.

Type:: bool

StyleElements¶

Specifies the style elements that are used by the control. Use StyleElements to customize the style of the control. If a custom style is enabled, you can enable or disable style elements in the control. StyleElements is a set of values that specify which elements of the current style are to be applied to this control. By default, all the elements of the style are enabled.

Type:: StyleElements

StyleName¶

Embarcadero Technologies does not currently have any additional information.

Type:: str

TabOrder¶

Indicates the position of the control in its parent’s tab order. TabOrder is the order in which child windows are visited when the user presses the Tab key. The control with the TabOrder value of 0 is the control that has the focus when the form first appears. Initially, the tab order is always the order in which the controls were added to the form. The first control added to the form has a TabOrder value of 0, the second is 1, the third is 2, and so on. Change this by changing the TabOrder property. Each control has a unique tab-order value within its parent. If you change the TabOrder property value of one control to be the same as the value of a second control, the TabOrder value for all the other controls changes. For example, suppose a control is sixth in the tab order. If you change the control’s TabOrder property value to 3 (making the control fourth in the tab order), the control that was originally fourth in the tab order now becomes fifth, and the control that was fifth becomes sixth. Assigning TabOrder a value greater than the number of controls contained in the parent control moves the control to the end of the tab order. The control does not take on the assigned value of TabOrder, but instead is given the number that assures the control is the last in the tab order.

Note: TabOrder is meaningful only if the TabStop property is True and if the control has a parent. (The TabOrder property of a form is not used unless the form is the child of another form.) A control with a TabOrder of -1 has no parent, and therefore cannot be reached by pressing the Tab key. To remove a parented control from the Tab order, set its TabStop property to False.

Type:: int

TopRow¶: Specifies the index of the first visible scrollable row in the grid.

Touch¶

Specifies the touch manager component associated with the control. Use the Touch property to access gesturing options associated with a control. Touch specifies a class of type TTouchManager. Touch is used to:

Associate a TGestureManager. (TGestureManager manages all the gestures that can be used by the control.) Select the standard, interactive, or custom gestures to associate with the control. (You can also connect each gesture to an action; see Assigning Actions to Gestures.) Specify a set of options for interactive or tablet gestures.

Type:: TouchManager

Visible¶

Specifies whether the component appears onscreen. Use the Visible property to control the visibility of the control at run time. If Visible is True, the control appears. If Visible is False, the control is not visible. Calling the Show method sets the control’s Visible property to True. Calling the Hide method sets it to False. For TCustomForm descendants, the Show and ShowModal methods set Visible to True and bring the form to the front of all open windows. For TTabSheet descendants, Visible does not control the visibility of the control at run time. For more information, see the description of the TabVisible property.

Type:: bool

VisibleColCount¶

Indicates the number of scrollable columns visible in the grid. Use VisibleColCount to determine the number of scrollable columns fully visible in the grid. VisibleColCount does not include the fixed columns counted by the FixedCols property. It does not include any partially visible columns on the right edge of the grid.

Type:: int

VisibleRowCount¶

Indicates the number of scrollable rows visible in the grid. Use VisibleRowCount to determine the number of scrollable rows fully visible in the grid. VisibleRowCount does not include the fixed rows counted by the FixedRows property. It does not include any partially visible rows on the bottom of the grid.

Type:: int