Help Center

ColWordWrapOptionBandproperty

Controls how text wrapping is applied to specific column bands.

Windowspropertydoc-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

PROPERTY ColWordWrapOptionBand (BYVAL BandNumber AS LONG, BYVAL BandColIdx AS LONG) AS WordWrapSettings
PROPERTY ColWordWrapOptionBand (BYVAL BandNumber AS LONG, BYVAL BandColIdx AS LONG, BYVAL opt AS WordWrapSettings)

Parameters

NameDescription
BandNumberThe zero-based index of the hierarchical band.
BandColIdxThe zero‑based index of the column within that band. A value of –1 applies the setting to all the bands.
optAn integer value or constant that defines how text is displayed:
flexWordBreak: Normal word-breaking/wrapping.
flexWordBreakEllipsis: Wraps text but appends an ellipsis ("...") if the text is still too long for the available space.

Description

Returns or sets how text wraps or is truncated within a specific band. Unlike the global WordWrap property, which targets a single column index, this property applies the specified wrapping rule to every column in the designated band.

Remarks

To see any effect, the global WordWrap property must be set to True.

Enabling this property does not automatically resize rows. You must programmatically adjust the RowHeight to accommodate multiple lines of text.

The setting applies only to the specified band column, not to the corresponding absolute column index in the flattened grid.

In hierarchical layouts, each band maintains its own formatting table. This means two different bands can have different wrapping rules for columns that share the same absolute column index.

Reference