ColWordWrapOption, ColWordWrapOptionBand, ColWordWrapOptionFixed, ColWordWrapOptionHeader Properties (ModHFGrid)

Applies To

Return or set a value that specifies how text is wrapped.

Syntax

object.ColWordWrapOption (Index) = integer
object.ColWordWrapOptionBand (BandNumber, BandColIndex) = integer
object.ColWordWrapOptionFixed(Index) = integer
object.ColWordWrapOptionHeader(BandNumber, BandColIndex) = integer

Syntax for the properties has these parts:

Part Description
object An object expression that evaluates to an object in the Applies To list.
Index Long. The number of the column to get or on which to set word wrap. Valid values are in the range of -1 to Cols - 1. Setting this value to – 1 selects all columns.
BandNumber Required. Long. The number of the band to get or on which to set word wrap. The value must be in the range of zero to Bands - 1.
BandColIndex Required. Long. The number of the column to get or on which to set word wrap. This optional parameter defaults to – 1, indicating all columns in the band. Valid values are – 1 to Cols – 1.
integer A numeric expression that determines how words will wrap, as shown in Settings.

Settings

The settings for integer are:

Constant Value Description
flexSingleLine 0 (Default) Displays text on a single line only.
flexWordBreak 1 The lines are automatically broken between words.
flexWordEllipsis 2 Truncates text that does not fit in the rectangle and adds ellipsis.
flexWordBreakEllipsis 3 Breaks words between lines and adds ellipsis if text does not fit in the rectangle.