Help Center

SetColumnInBandInfofunction

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 SetColumnInBandInfo (BYVAL BandNumber AS LONG, BYVAL UIIndex AS LONG, BYVAL ColName AS BSTR, BYVAL Caption AS BSTR, BYVAL Hidden AS VARIANT_BOOL, BYVAL RowsetColIndex AS LONG, BYVAL Alignment AS SHORT) AS HRESULT

Parameters

NameDescription
BandNumberZero‑based band index of the band.
UIIndexZero‑based column index within that band.
ColNameNew underlying field name.
CaptionNew display caption.
HiddenWhether the column should be hidden (VARIANT_TRUE / VARIANT_FALSE).
RowsetColIndexNew Recordset field index to map to.
AlignmentNew alignment constant.

Description

Undocumented. Sets or updates the metadata for a specific column within a specific band.

This is the internal setter for hierarchical column metadata.

It allows the grid to modify:

  • captions
  • hidden state
  • alignment
  • field mapping
  • column names

This is the mechanism behind the following public properties:

  • ColHeaderCaption
  • ColAlignment
  • ColHidden
  • ColData
  • ColWidth (indirectly)

The grid calls this internally when

  • applying formatting
  • responding to property changes
  • rebuilding the UI after binding
  • refreshing shaped Recordsets

Reference