Help Center

ColAlignmentHeaderfunction

Returns or sets the alignment of data in a column within a header.

Windowsfunctiondoc-orphan
No implementation located. This member is documented, but the source scan found no matching declaration. It is likely declared in a header this scan does not resolve, or provided by a macro.

Syntax

FUNCTION ColAlignmentHeader (BYVAL BandNumber AS LONG, BYVAL BandColIdx AS LONG) AS SHORT
FUNCTION ColAlignmentHeader (BYVAL BandNumber AS LONG, BYVAL BandColIdx AS LONG = -1, BYVAL nAlignment AS SHORT) AS HRESULT
FUNCTION ColAlignmentHeader (BYVAL BandColIdx AS LONG) AS SHORT
FUNCTION ColAlignmentHeader (BYVAL BandColIdx AS LONG = -1, BYVAL nAlignment AS SHORT) AS HRESULT

Parameters

NameDescription
BandNumberA zero‑based index identifying the band whose data alignment is being retrieved or modified. If the band number is omited, band 0 is assumed.
IndexThe number of the column.
nAlignmentAn integer or constant that specifies the alignment of data in a column.

Description

Returns or sets the alignment of data within the column headers of a specific band.

Remarks

Setting ColAlignmentHeader overrides more global settings like ColAlignment specifically for that header cell.

Use ColAlignmentBand to set the alignment for the data cells within the same band, as ColAlignmentHeader only affects the header labels.

Example

' Center-align the header for the 4th column of the primary band (Band 0) grid.ColAlignmentHeader(0, 3) = flexAlignCenterCenter

Reference