PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Adds a break into a Table control or into a Looper control.
Example
// Add a green break on the date into the Table control
x is Control
x <- BreakAdd(TABLE_Order.COL_DATE, "BrkDate", brkHeader, 50)
x..BrushColor = DarkGreen // Colors the break in green
// Add a break header and footer into the Table control
BreakHeader is Control
BreakFooter is Control
(BreakHeader, BreakFooter) <- BreakAdd(TABLE_Customer.COL_NAME, "BreakHeaderName" + TAB + ...
"BreakFooterName", brkHeaderAndFooter)
Syntax
[<Result> <- ] BreakAdd(<Element Name>, <Break Name> [, <Break Type> [, <Height> ]])
<Result>: Control variable
Name of Control variable used to handle the created break. In this case, the assignment must be performed by the '<-' operator.
If <BreakType> corresponds to the brkHeaderAndFooter constant, the function returns 2 controls. The syntax becomes:
(<NameBreakHeaderControl>,<NameBreakFooterControl>) <- ] BreakAdd(<Element Name>, ...
<Name of Header Break> + TAB + <Name of Footer Break>, brkHeaderAndFooter)
<Element Name>: Character string (with or without quotes)
Name of element on which the break will be done. It is a Table column or the name of a Looper attribute.
<Break Name>: Character string (with quotes)
Name of break to create. This name must not exist in the Table control or in the Looper control.
If <Type of Break> corresponds to the brkHeaderAndFooter constant, this parameter has the following format:
<Name of Header Break> + TAB + <Name of Footer Break>
<Break Type>: Integer constant
Type of break to create:
brkHeader
(Default value)
Adds a break header.
brkFooterAdds a break footer.
brkHeaderAndFooterAdds 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:
    • The browsing Table and Looper controls in direct access.
    • The Vertical Table controls.
    In this case, the function fails and a non-fatal error is displayed.
Components
WINDEVReports and Queries wd230obj.dll
Minimum required version
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment