<Table>.EnumBreak (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

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 subscript>)

<Result>: Character string

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

<Break name> + TAB + <Break position>

The break position can be set to 1 (break header) or 0 (break footer).Description of the break for the specified subscript. This description has the following format:

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

where:
<Break>: Name of 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 contains no break or if is equal to the number of breaks found in the Table control + 1.

<Table control>: Control name

Name of Table control to use.

<Break subscript>: Integer

Subscript of sought break, included between 1 and the number of breaks found 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 browsing or memory Table control.

Component : wd250obj.dll