A grid column heading.

Syntax

These controls are created for each GridColumn object.

Properties

The following tables list the properties of interest in the ColumnHeadingControl class. (No particular events or methods are associated with this class.)

Property

Default

Description

baseClassName

COLUMNHEADINGCONTROL

Identifies the object as an instance of the ColumnHeadingControl class

className

(COLUMNHEADINGCONTROL)

Identifies the object as an instance of a custom class. When no custom class exists, defaults to baseClassName

colorNormal

WindowText
/Window

The color of the control and its text

function

 

A text formatting function

picture

 

Formatting template

value

 

The text displayed in the ColumnHeadingControl object

 

Notable properties of class columnHeadingControl as a PushButton (grid.headingType = 2 //pushbutton)

            text                - text displayed on button

            cellLeftMargin      - Distance between left edge of cell and left edge of button (in pixels)

            cellRightMargin     - Distance between right edge of cell and right edge of button (in pixels)

            cellTopMargin       - Distance between top edge of cell and top edge of button (in pixels)

            cellBottomMargin    - Distance between bottom edge of cell and bottom edge of button (in pixels)

            cellBackgroundColor - Color applied to margin area around button - Default: Window

 

The following table lists the common properties, events, and methods of the ColumnHeadingControl class:

Property

 

Event

 

Method

fontBold
fontItalic

fontName

fontSize

fontStrikeout

fontUnderline

 

hWnd
parent

beforeCellPaint
onCellPaint

onLeftDblClick

onLeftMouseDown

onLeftMouseUp

onMiddleDblClick

onMiddleMouseDown
onMiddleMouseUp

onRightDblClick

onRightMouseDown

onRightMouseUp

none

Description

Each column in a grid has a ColumnHeadingControl object that represents the column heading. It is accessible through the GridColumn object’s headingControl property.

As with all column controls, the width for the control is in the parent GridColumn object, not the control itself. The height is controlled by the cellHeight of the grid.

If a mouse event is implemented for this control it overrides the matching grid level event.