<Table>.EnumBreak (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Use conditions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Table>.EnumBreak (Function)

In french: <Table>.EnumèreRupture

Enumerates the breaks found in a Table control.

Example

// Lists the breaks of TABLE_MyTable
sBreakName is string
bPosition is boolean
nColNum is int

let i = 1
sDesc is string = TABLE_MyTable.EnumBreak(i)
WHILE sDesc <> ""
sBreakName = ExtractString(sDesc, 1, TAB)
bPosition = ExtractString(sDesc, 2, TAB)
nColNum = ExtractString(sDesc, 3, TAB)
IF {sBreakName, indControl}..Visible THEN
Trace(sBreakName, bPosition, nColNum)
END
// Next break
i++
sDesc = TABLE_MyTable.EnumBreak(i)

END

Syntax

<Result> = <Table control>.EnumBreak(<Break index>)

<Result>: Character string

Description of the break for the specified index. This description has the following format:

<Break> + TAB + <Break position> + TAB + <Column number>

where:
<Break>: Name of the break.
<Break position>: 1 for a break header and 0 for a break footer.
<Column number>: Number of the column that triggers the break.
Empty string ("") if the Table control does not have any breaks or if <Break index> is equal to the number of breaks in the Table control + 1.

<Table control>: Control name

Name of the Table control to be used.

<Break index>: Integer

Index of the search break, between 1 and the number of breaks in the Table control + 1.
If this parameter is greater than the number of breaks found in the Table control, the function returns an empty string ("").

Remarks

Use conditions

<Table>.EnumBreak can be used on a Table control based on a data file or populated programmatically.

Component: wd270obj.dll