Help Center

ApplyBandFieldNameInfoChangesfunction

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 ApplyBandFieldNameInfoChanges () AS HRESULT

Description

Undocumented. Applies any pending changes to the internal band/field metadata previously modified through internal methods such as SetColumnInBandInfo.

ApplyBandFieldNameInfoChanges is an undocumented internal method of the MSHFlexGrid. It finalizes and commits updates made to the grid’s internal representation of:

  • band names
  • field names
  • column captions
  • hidden states
  • alignment
  • Recordset field mappings

This method works in conjunction with the following internal functions:

  • CollectBandFieldNameInfo: Gathers the initial metadata from the shaped Recordset.
  • GetColumnInBandInfo: Retrieves metadata for a specific column in a band.
  • SetColumnInBandInfo: Modifies metadata for a specific column in a band.

After one or more calls to SetColumnInBandInfo, the grid does not immediately rebuild its internal structures. Instead, it queues the changes.

ApplyBandFieldNameInfoChanges forces the grid to:

  • validate the updated metadata
  • rebuild its internal band/column tables
  • refresh the UI to reflect the changes

Example

' Modify metadata for a column in Band 1 grid.SetColumnInBandInfo 1, 0, "OrderID", "Order ID", False, 3, 1

' Commit the changes grid.ApplyBandFieldNameInfoChanges

Reference