GAMBAS BOOK 3.19.1

The report component gb.report2 offers the option of structurally arranging and printing data from different sources. You can define the layout of a report in the IDE with the Report Designer.

Please note! The graphical report designer is not a WYSIWYG editor. The individual report controls such as Report.Label or Report.Image - within a report section - can be inserted into report containers such as Report.HBox or Report.Panel. However, the properties of the report controls that are then defined are only partially displayed. You can check the selected layout and design at any time using a report preview and a control printout in order to make corrections. It can be helpful to set the Report.Debug property to True, as the boundaries of all objects contained in the report are drawn in this mode.

As an alternative to using the Report Designer, you can also define the complete layout and design of a report via the source code. However, this always harbours the risk of entering incorrect values for selected properties or not adhering to the specified syntax, which cannot happen in the Report Designer. The Report Designer can be used if the layout is extensive with many containers and many report control elements. For example, to define a border around a ReportPanel1 (left, right, top and bottom 5 mm, top left and bottom right corners additionally rounded with a radius of 5 mm) with a linear black-red-yellow colour gradient (linear gradient), you need this value assignment of the ReportPanel1.Border property in the source code:

ReportPanel.Border = ReportBorder["Top:5mm LinearGradient(0,0.04,0,1,[#000000,#FFFF00,#FF0000],[0,1,0.5]);
Bottom:5mm LinearGradient(0,0.04,0,1,[#000000,#FFFF00,#FF0000],[0,1,0.5]);
Left:5mm LinearGradient(0,0.04,0,1,[#000000,#FFFF00,#FF0000],[0,1,0.5]);
Right:5mm LinearGradient(0,0.04,0,1,[#000000,#FFFF00,#FF0000],[0,1,0.5]);
TopLeftCorner:5mm;TopRightCorner:0mm;BottomRightCorner:5mm;BottomLeftCorner:0mm"]

The component reimplements the Align, Arrange and Line classes and implements a number of report classes:

Report, ReportBorder, ReportBoxShadow, ReportBrush, ReportContainer, ReportControl, ReportDrawingArea, 
ReportFrame, ReportHBox, ReportImage, ReportLabel, ReportLine, ReportMargin, ReportPadding, ReportPageBreak, 
ReportPanel, ReportSection, ReportSizeHints, ReportSizeParser, ReportSvgImage, ReportTextLabel, 
ReportVBox, ReportView, ReportVPanel, TSizeParse.

A description of the properties for the Align, Arrange and Line classes can be found under

https://www.gambas-buch.de/doku.php?id=k20:k20.7:start&s[]=align#klasse_align
https://www.gambas-buch.de/doku.php?id=k20:k20.7:start&s[]=align#klasse_arrange
http://gambaswiki.org/wiki/comp/gb.qt4/line

The most important class of the gb.report2 component is Report, because this class represents a report.

The class behaves like a read-only array and returns a virtual object of the ReportSection data type for the specified index:

Dim hReport As Report
Dim hReportSection As ReportSection
hReportSection = hReport [ Index As Integer ]

Please note that many properties are defined via other classes such as ReportPadding, ReportBrush or ReportBoxShadow. For example, the `Report.Border` property is of the ReportBorder type. This means that these properties apply specifically to the report and are not necessarily comparable with the same properties of other control elements.

The Report class has the following properties:

Table 22.11.0.1.1 : Properties of the Report class

The Paper property can have one of the following values

• Printer.A4 210 × 297 mm, 8.26 × 11.69 inches (default).
• Printer.A3 297 × 420 mm.
• Printer.A5 148 × 210 mm.
• Printer.B5 182 × 257 mm, 7.17 × 10.13 inches.
• Printer.Letter 216 × 279 mm, 8.5 × 11 inches.
• Printer.Executive 191 × 254 mm, 7.5 × 10 inches.
• Printer.Legal 16 × 356 mm, 8.5 × 14 inches.
• Printer.PaperWidth Custom value
• Printer.PaperHeight User-defined value

The Report class has these methods:

Table 22.11.0.1.2 : Methods of the Report class