BreakAdd (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Break functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

BreakAdd (Function)

In french: RuptureAjoute

Adds a break in a Table or Looper control.

Example

// Ajout d'une rupture verte sur la date dans un champ Table
x is Control
x <- BreakAdd(TABLE_Commande.COL_DATE, "RuptDate", brkHeader, 50) 
x.CouleurFond = DarkGreen // Colorie en vert la rupture

// Ajout d'un haut et d'un bas de rupture dans un champ Table 
RuptureHaut is Control
RuptureBas is Control
(RuptureHaut, RuptureBas) <- BreakAdd(TABLE_Client.COL_NOM, "NomRuptureHaut" + TAB + ...
	"NomRuptureBas", brkHeaderAndFooter)

Syntax

<Result> = BreakAdd(<Element name> , <Break name> [, <Type of break> [, <Height>]])

<Result>: Control variable

Name of the Control variable that allows you to handle the new break. In this case, values must be assigned with the '<-' operator.
If <Type of break> is set to the brkHeaderAndFooter constant, the function returns two controls. The syntax becomes:
(<NameBreakHeaderControl>,<NameBreakFooterControl>) <- ] BreakAdd(<Element name>, ...
<Name of header break> + TAB + <Name of footer break>, brkHeaderAndFooter)

<Element name>: Character string

Name of the element on which the break will be created. It is a Table column or the name of a Looper attribute.

<Break name>: Character string

Name of break to create. This name must not exist in the Table control or in the Looper control.
If <Type of break> is set to the brkHeaderAndFooter constant, it has the following format:
<Name of header break> + TAB + <Name of footer break>

<Type of break>: Integer constant

Type of break to create:
brkHeader
(Default value) Adds a break header.
brkFooter Adds a break footer.
brkHeaderAndFooter Adds a break header and footer.

<Height>: Optional integer

Height of break in pixels. The break height is set to 32 pixels by default.

Remarks

The breaks created by BreakAdd can be deleted by BreakDelete.
If the Table or Looper control already contains breaks, the break is created on the next level:
[Existing break header]
[New break header]
Row 1 of table
[New break footer]
[Existing break footer]
BreakAdd cannot be used on:
- Table and Looper controls with direct access to the data source.
- Vertical Table controls.
In this case, the function fails and a non-fatal error is displayed.

Business / UI classification: UI Code

Component: wd300obj.dll