0% found this document useful (0 votes)
20 views256 pages

Report Designer

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
20 views256 pages

Report Designer

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 256

Report Designer

User Guide
AVEVA Solutions Limited

Disclaimer
AVEVA Instrumentation provides instrument sizing calculations for estimation purposes only, end users of the
software should not rely on the calculations produced by the software for design purposes. End users should seek
the advice of certified equipment suppliers prior to specifying or purchasing equipment.

To the fullest extent permissible at law:

a) AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from viruses;

b) AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any
special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be
suffered by the customer, including any loss suffered by the customer resulting from the inaccuracy or invalidity of
any data created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or
arise in contract, tort (including negligence) or otherwise;

c) AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the
customer's claim is brought.

In the event of any conflict between the above clauses and the analogous clauses in the software licence under
which the AVEVA software was purchased, the clauses in the software licence shall take precedence.

Copyright
All intellectual property rights, including but not limited to, copyright in this manual and the associated software,
(including source code, object code, and any data) belongs to or is validly licensed by AVEVA Solutions Limited or
its subsidiaries.

All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document
is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without
the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires
that this Disclaimer and Copyright notice is prominently displayed at the beginning of every copy that is made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may also not reverse
engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product described in
this publication may be incorporated into any third-party software, product, machine, or system without the prior
written permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.

The AVEVA products described in this guide are to be installed and operated strictly in accordance with the terms
and conditions of the respective licence agreements, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the product is strictly prohibited.

Copyright 2000 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

The AVEVA Instrumentation user interface is based on the Microsoft® Office Fluent™ user interface.

Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Group plc or its subsidiaries. AVEVA product names are
trademarks or registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of
trademarks belonging to AVEVA Group plc or its subsidiaries is strictly forbidden.

Fluent is a trademark of Microsoft Corporation and the Fluent user interface is licensed from Microsoft Corporation.

The Microsoft Office User Interface is subject to protection under U.S. and international intellectual property laws
and is used by AVEVA Solutions Limited under license from Microsoft.

AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
Report Designer User Guide

Revision Sheet

Date Version Comments / Remarks


March 2012 Copyright added to all pages.
November 2013 Made specific to AVEVA Instrumentation and Electrical
Report Designer User Guide
Report Designer User Guide

Report Designer User Guide

Contents Page

Report Designer
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Report Editing Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1


Back up the Current Layout before Modification . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Manually Update Report Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Change Element Layout in a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Add or Modify Static Information in a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Delete Report Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Display Values from a Database (Bind Report Elements to Data). . . . . . . . . . . 2:6
Use Mail Merge in Report Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:10
Change Value Formatting of Report Elements . . . . . . . . . . . . . . . . . . . . . . . . . 2:11
Change Fonts and Colours of Report Elements . . . . . . . . . . . . . . . . . . . . . . . . 2:12
Change or Apply Data Sorting to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:13
Change or Apply Data Filtering to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:15
Change or Apply Data Grouping to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . 2:17
Add Totals to a Report or Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:20
Create or Modify Watermarks of a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:23
Add Page Numbers and System Information to a Report . . . . . . . . . . . . . . . . 2:25
Add Calculated Fields to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:28
Add Parameters to a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:31

© Copyright 2000 to current year. i 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide

Edit Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1


Basic Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Change Measurement Units for a Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Change Page Settings for a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Bind a Report to Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Controls Positioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10
Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:13
Static Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:13
Table Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:16
Label Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:17
Master-Detail Report (Detail Report Bands). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:19
Multi-Column Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:21
Cross-Tab Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:23
Parameterised Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:26
Chart with Static Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:28
Chart with Dynamic Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:32
Styles and Conditional Formatting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:36
Styles Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:36
Use of Odd and Even Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:41
Store and Restore Style Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:45
Conditionally Change a Control's Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:48
Conditionally Hide Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:51
Conditionally Change a Label's Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:54
Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:56
Add Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:56
Create Hyperlinks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:60
Add a Cross-Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:60
Miscellaneous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:62
Handle Events via Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:62
Show the Current Row Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:65
Count the Number of Records in a Report or a Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:67
Add Page Numbers for Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:69
Sort Groups by a Summary Function Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:71
Cancel Printing If a Report Does Not Contain any Records. . . . . . . . . . . . . . . . . . . . . . . . 3:73
Limit the Number of Records per Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:74

Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Component Tray. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2

© Copyright 2000 to current year. ii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide

Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2


Standard Controls Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3
Design Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5
Designer Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6
Preview Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:7
HTML View Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Scripts Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Group and Sort Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Scripts Errors Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:9
Field List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:10
Report Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:11
Property Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:12
Main Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:13
Main Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:14
Formatting Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:15
Layout Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:16
Zoom Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:16
Smart Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:17
Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:19
Report Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:20
Appearance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:22
Behaviour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:24
Data ............................................................. 4:25
Design ............................................................. 4:26
Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:28
Page Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:28
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:29
Printing ............................................................. 4:29
Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:30
Report Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:31
Manage Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:31
Band Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:33
reportDetail Band . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:33
Group Header and Footer Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:36
Report Header and Footer Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:40
Page Header and Footer Bands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:43
Page Margin Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:45
Detail Report Bands (for Master-Detail Reports) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:47
Report Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:50

© Copyright 2000 to current year. iii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide

Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:54
Check Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:57
Rich Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:60
Picture Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:64
Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:66
Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:69
Table Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:72
Table Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:74
Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:77
Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:79
Bar Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:81
Zip Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:88
Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:90
Pivot Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:95
Page Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:98
Page Break. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:101
Cross-band Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:102
Cross-band Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:103
Subreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:105
Report Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:107
Standard Report Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:108
Label Report Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:119
Preview, Print and Export Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:121
Exporting from Print Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:122
PDF-Specific Export Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:123
HTML-Specific Export Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:125
MHT-Specific Export Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:126
RTF-Specific Export Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:127
XLS and XLSX-Specific Export Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:128
CSV-Specific Export Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:129
TXT-Specific Export Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:130
Image-Specific Export Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:130

© Copyright 2000 to current year. iv 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Introduction

1 Introduction

The Report Designer User Guide guide contains information on how to edit reports using
Report Designer.
Report Designer enables users to edit reports, bind them to data, and pass them to another
workstation for loading into another instance of the Report Designer. In addition to report
editing capabilities, it allows the user to display print previews and to print reports and export
reports to files.

Note: Some features described may differ depending on the version of Report Designer in
use. This depends on the application vendor.

1.1 Guide Structure


The guide consists of the following sections:
• Report Editing Basics

© Copyright 2000 to current year. 1:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Introduction

• Edit Reports
• Reference

© Copyright 2000 to current year. 1:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

2 Report Editing Basics

The Report Editing Basics topic describes the basic tasks the user may need to carry out
when editing a report using Report Designer:
• Back up the Current Layout before Modification
• Manually Update Report Output
• Change Element Layout in a Report
• Add or Modify Static Information in a Report
• Delete Report Element
• Display Values from a Database (Bind Report Elements to Data)
• Use Mail Merge in Report Elements
• Change Value Formatting of Report Elements
• Change Fonts and Colours of Report Elements
• Change or Apply Data Sorting to a Report
• Change or Apply Data Filtering to a Report
• Change or Apply Data Grouping to a Report
• Add Totals to a Report or Group
• Create or Modify Watermarks of a Report
• Add Page Numbers and System Information to a Report
• Add Calculated Fields to a Report
• Add Parameters to a Report.

2.1 Back up the Current Layout before Modification


To guarantee that a user will be able to revert a report to its previous state, a backup copy
must be created. The report can then be restored to this state in case something goes
wrong while is being subsequently edited by closing it without saving the unwanted changes
and then re-opening it.
To save a copy of a report, select File > Save or press CTRL+S. The report will then be
saved in the application's current folder.

© Copyright 2000 to current year. 2:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

To specify a different name for the report, select File > Save As... from the main menu,
which will display the standard Please enter the name of the Report window.

Enter the name and click Save.

2.2 Manually Update Report Output


Sometimes the user may only need to change a small number of values in the report before
printing it. In these cases, the best way to make these changes may be to export the report
to an editable file (e.g. an RTF file), then use an appropriate editor tool to edit values and
then print the report.
To export a report, switch to the Preview tab and use the Export options as shown below.

For more information about exporting reports, see Preview, Print and Export Reports.

© Copyright 2000 to current year. 2:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

2.3 Change Element Layout in a Report


The user can freely move report elements, e.g. labels, by dragging them. Another way to
change the element position is to select an element, and then press the arrow keys.

To resize an element, select it and then drag one of the small boxes shown on its edges and
corners. To resize an element using keyboard shortcuts, press SHIFT+ARROW or
CTRL+SHIFT+ARROW.

The user can also easily align controls to each other or make them the same size, by
selecting the multiple controls and using the Layout Toolbar.

To select multiple controls, use one of the following methods:


• Click the controls while holding CTRL or SHIFT.
• Click on blank space and drag the mouse to create a selection frame around the
controls. When the mouse button is released, all controls within the selection frame's
boundaries will be selected. In this case, any previous selection is cleared.
Note: For information on how to work with tables, refer to Table.

2.4 Add or Modify Static Information in a Report


Reports display static and dynamic information.
Dynamic information is text or values that are taken from values in a database (actual report
data) or service information (such as current user name or page numbers), and therefore
changes in the report if the source data changes.

© Copyright 2000 to current year. 2:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Static information is text or images that does not change in this way. For example, general
information in a report header or a page header, or text labels describing data.

Change Static Information


To change static information, locate the report element in the designer and display the
element's smart tag. The smart tag will contain a link or a button enabling the user to edit
the element's content.

Text elements, such as labels and rich text boxes, also allow in-place editing of their
content. Double-click an element and activate the editor. When working with rich text, use
the Formatting Toolbar.

Add Information to a Report


To add information to a report, select the appropriate element from the Standard Controls
toolbar, such as a Label, Rich Text Box or Picture Box. Once an element has been placed
at the appropriate position, specify its content using the smart tag. For instance, the
following instructions describe how to add a rich text box into a report.
• Drop the Rich Text control from the Standard Controls toolbar onto the reportDetail
band.

© Copyright 2000 to current year. 2:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• Select the created control and click its Smart Tag. In the displayed actions list, click the
Load File... context link.

In the displayed window, define the path to the RTF or TXT file containing the text of the
information, and click Open.

Note: Additional text formatting can be performed using the Formatting Toolbar.

2.5 Delete Report Element


To delete a report element (band or control), use one of the following methods:
• Select the element in the Design Panel or Report Explorer, and press DELETE. To
select multiple elements, hold down the SHIFT key while selecting them.
• Select the element or elements then select Edit > Delete from the Main Menu.

© Copyright 2000 to current year. 2:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• Right-click the report element, and in the Context menu, choose Delete.

Note: To undo a deletion press CTRL+Z.

2.6 Display Values from a Database (Bind Report


Elements to Data)
Report elements can display dynamic data from a bound database. If a database contains
this information, it can easily be added to the report using one of the methods described
below.

© Copyright 2000 to current year. 2:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Databound elements are indicated in the Report Designer by a yellow database icon in their
top-right corners.

Use Field List


• To bind an existing report element to database data, click the required field item in the
Field List window, and then drag and drop it onto the element. The yellow database
icon inside the control will then appear.

© Copyright 2000 to current year. 2:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• To add a new data-bound report element, drag the required field item from the Field
List window onto a report band. This will create a Label bound to the selected data
field.

• A more flexible way to create data-bound elements is to right-click a Field List item,
and then drag and drop it onto a report. This will display the context menu shown in the
image below. Choose the element type that will represent the data, and it will be
automatically created and bound to the selected data field.

© Copyright 2000 to current year. 2:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Use Smart Tag


Click an element's Smart Tag, and in the displayed menu, expand the Data Binding
drop-down list and select the required data field.

Use Property Grid


Click an element to show its properties in the Property Grid. Expand the Data Bindings
branch that holds the bindable attributes. Specify a data field for the required attribute (e.g.
Text).

© Copyright 2000 to current year. 2:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

2.7 Use Mail Merge in Report Elements


Several report elements support the Mail Merge feature. To use this feature, insert field
names surrounded by square brackets into the element's text.

© Copyright 2000 to current year. 2:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Project, report and revision data (i.e. data that is not listed under “Table” in the Field List)
must be prefixed with the appropriate table name as in the example above.
As shown in the image above, the user can apply formatting to database values when using
the Mail Merge feature. Place the cursor on the field name inside the square brackets and
click the control's Smart Tag. In the displayed actions list, define the required formatting in
the Format String section.

2.8 Change Value Formatting of Report Elements


To change value formatting, locate the element, click its smart tag, and then click the
ellipsis next to Format String.

The FormatString Editor window will be displayed, allowing the user to choose one of the
predefined formatting styles.

© Copyright 2000 to current year. 2:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Select the required style and click OK to close the window and save the changes.

2.9 Change Fonts and Colours of Report Elements


To change the fonts and colours, as well as paddings, text alignment and other appearance
properties of report controller bands, select an element and use one of the following
methods:
• Use the Formatting Toolbar.

• Use the Property Grid.


Note: All appearance-related properties are located under the Appearance category.

© Copyright 2000 to current year. 2:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Note: For more information on customizing the appearance of report elements, refer to
Styles and Conditional Formatting.

2.10 Change or Apply Data Sorting to a Report


To sort a report's data, use a report containing a Label control bound to a CategoryID data
field. This field will be used as a sorting criteria.
• Click a reportDetail band's Smart Tag. In the displayed menu, locate the Sort Fields
section, and click the ellipsis.
• In the displayed window, click Add to add a new entry, and set the FieldName property
to a data field against which the data is to be sorted. The user can also define a sorting
order (ascending or descending).

© Copyright 2000 to current year. 2:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Note: Data can be sorted against multiple data fields. If this is required, add more entries
and specify their data field and sort order settings as described above.

• To apply the settings and close the window, click OK.


The sorting is now applied to the report. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 2:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

2.11 Change or Apply Data Filtering to a Report


To filter a report's data, select the report, and in the Property Grid, locate the Filter String
property and click the ellipsis. The FilterString Editor is displayed, enabling the user to
define a required expression.

© Copyright 2000 to current year. 2:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Click OK. The filtering is then applied to the report. Switch to the Preview tab to view the
result.

© Copyright 2000 to current year. 2:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

It is also possible to request a filtering parameter each time a report is previewed. Refer to
Add Parameters to a Report for details.

2.12 Change or Apply Data Grouping to a Report


Data grouping can be performed only if a report is bound to a data source.
To group records in a report, follow these instructions.
• In the Group and Sort Panel, and click Add a Group. From the list, choose the data
which will be used to group the report. Note that grouping across calculated fields is
supported, as well.

Specify the sort order and make sure Show Header is checked.
If multiple groups are created, you can specify the priority for each group, by selecting
it in the Group and Sort Panel, and using the Move Up and Move Down buttons.
• A GroupHeader band is then added to the report. Drop a field, which will be used as
the grouping criteria, from the Field List onto the GroupHeader band.

© Copyright 2000 to current year. 2:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• Drop a field, representing the report’s general data onto the report's reportDetail band.

• Users may add a corresponding GroupFooter band by checking the Show Footer
option in the Group and Sort Panel.
• A calculated total for each group may be set to be displayed in the GroupFooter band
by placing a label onto the band, and specifying its Summary properties. For example:

© Copyright 2000 to current year. 2:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

The grouping is now applied to the Report. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 2:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

2.13 Add Totals to a Report or Group


To calculate summaries (totals) within a report, follow these instructions:
• Report totals are displayed in Report Footer bands, group totals in Group Footer
bands. If the required band is not present in a report, it must be added by right-clicking
anywhere on the report, and in the Context Menu, selecting Insert Band >
ReportFooter or Group Footer.

© Copyright 2000 to current year. 2:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• Click the field for which a summary will be calculated, to select it. Then, hold down
CTRL and drag the field onto the Report Footer area to create an exact copy of the
label that will display the summary.

Note: A new label can also be created for the total by dragging it from the Standard
Controls toolbar.

• Select the newly created label. In the Property Grid, locate the Summary property
and click the ellipsis. The Summary Editor is then displayed.
The following image shows an example of how to set up a total.

© Copyright 2000 to current year. 2:21 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Note: The Summary Running option is set to Report to make sure that all values from the
specified data field are taken into account.

Note: The Ignore NULL values option will not affect the result in this example, since by
default NULL values are treated as if they were zeros. So the Sum will not be
affected whether or not these values are taken into account. This option applies to
functions like Count or Average, because it affects the number of elements counted.

• To save the settings and close the window, click OK.


Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 2:22 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

2.14 Create or Modify Watermarks of a Report


To create or modify a watermark, add a text watermark, or turn a picture into a report's
background follow these instructions:

Note: Watermarks are visible only in Preview and HTML View modes.

• Select the report and click on any blank area surrounding its bands area.
In the Property Grid that is then displayed, locate the report's Watermark property.
• Expand the Watermark property and set the required properties.

© Copyright 2000 to current year. 2:23 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Once the watermark has been set up, switch to the Preview tab to view the result.

© Copyright 2000 to current year. 2:24 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

2.15 Add Page Numbers and System Information to a


Report
Page numbers or other system information (e.g. current date and time, user name, etc.) can
be inserted into a report.
Generally, this information is displayed within Page Headers and Footers and in Page
Margin bands. To add page numbers or system information to a report, drag and drop the
Page Info control from the Standard Controls toolbar.

Follow the instructions below for the following specific tasks:


• Add Page Numbers
• Add System Date and Time
• Add the User Name.
Add Page Numbers
• Select the Page Info control, then in the Property Grid locate the Page Information
property, and display its dropdown list.
There are several options available. Select whether to display only the current page
number (Latin or Roman, uppercase or lowercase) or the current page number and the
of total number of pages.

© Copyright 2000 to current year. 2:25 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• Formatting of the control's text can be defined. In the Property Grid, set the Format
property to Page {0} of {1} (type it in the field).

Add System Date and Time


• Select the Page Info control, then in the Property Grid, locate the Page Information
property and set it to Current Date and Time.

© Copyright 2000 to current year. 2:26 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• Define the formatting of the control's text using its Format property.

Add the User Name


• Select the Page Info control, then in the Property Grid, locate the Page Information
property and set it to User Name.

© Copyright 2000 to current year. 2:27 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Define the formatting of the control's text. In the Property Grid, set the Format property to
Current User: {0} (type it in the field).

2.16 Add Calculated Fields to a Report


The main purpose of calculated fields is to perform calculations using data in multiple data
fields. To learn how to perform calculations within a single data field, refer to Add Totals to a
Report or Group.
To add a calculated field to a report, follow the instructions below:

© Copyright 2000 to current year. 2:28 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• To create a calculated field, right-click any item in the Field List and choose Add
Calculated Field from the displayed menu.

• In the Field List, select the created field to show its properties in the Property Grid.
Change the Field Type property to an appropriate value.

• To create an expression for the calculated field, click the ellipsis in the Expression
section. The Expression Editor is then displayed. The user can also display this
window by right-clicking the calculated field within the Field List and selecting Edit
Expression.

© Copyright 2000 to current year. 2:29 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Click Fields to display the field list. Double-click field names to add them to the
expression string. Use the toolbar to add operators between field names.
To close the window and save the expression, click OK.
• Drag the calculated field from the Field List onto a control or a table cell.

© Copyright 2000 to current year. 2:30 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

The calculated field is now set up. Switch to the Preview tab to view the result.

2.17 Add Parameters to a Report


Parameters can be used to filter the data in a report or specify a value that will be used to
calculate other values (in the latter case, use calculated fields).
To add parameters and filter a report based on their values, follow the steps below. In this
example a parameter will be added to filter the report by an ISA Location specified by the
user when the report is run.
• In the Field List window, right-click on the Parameters section, and in the displayed
menu, click Add Parameter.

Repeat this action to create the second parameter.

© Copyright 2000 to current year. 2:31 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

• Set the properties of the parameter as required. For example:

Note: Every time a report is previewed, the user will be asked to enter the values of any
parameters. The following instructions explain how to use these values to filter a
report's data.

• Select the report (by clicking anywhere on the blank space of the report), and in the
Property Grid, locate the Filter String property and click the ellipsis. The FilterString
Editor is displayed.
In this window, define the required expressions for the parameters. Construct an
expression where a data field (e.g. ISA Location) is compared with the create
parameter. To access parameters, click the icon on the right until it turns into a question
mark. For example:

© Copyright 2000 to current year. 2:32 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

Note: Make sure that the report's Request Parameters property is set to Yes. Otherwise,
the parameters will not be requested when the report is previewed, and a blank
report will be the result.

The parameter filtered report is now ready. To view the results, switch to the Preview tab,
and in the Parameters section, define the required values and click Submit.

© Copyright 2000 to current year. 2:33 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Report Editing Basics

© Copyright 2000 to current year. 2:34 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3 Edit Reports

Using Report Designer, the user can edit existing reports. The procedures for editing reports
are described in the following topics:
• Basic Operations
• Report Types
• Styles and Conditional Formatting
• Navigation
• Miscellaneous.

3.1 Basic Operations


Basic Operations covers the basic procedures carried out when working with reports in
Report Designer, and consists of the following topics:
• Change Measurement Units for a Report
• Change Page Settings for a Reportt
• Bind a Report to Data
• Controls Positioning.

3.1.1 Change Measurement Units for a Report


Units of measurement are determined by the report's Measure Units property. It defines the
basic measurement unit for all the unit-related properties of the report and its elements
(such as location, size, border width, etc.). It is set to one hundredth of an inch by default.
If required, the user can change the units to a tenth of a millimeter, by setting the Measure
Units property, either using the Property Grid:

© Copyright 2000 to current year. 3:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

... or via the report's Smart Tag (click the arrow button in the top-left corner between the
axis):

3.1.2 Change Page Settings for a Report


In Report Designer, each page setting of a report can be specified in one of two ways. They
can either be set to use the default printer settings when the report is printed, or use report-
specific printer settings.

© Copyright 2000 to current year. 3:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Default Printer Settings


The orientation, margins and paper size can be set to use printer settings instead of the
report's settings. This is useful for reports that could be printed in several places with
different printers and printer settings.
In the example below, the page properties in the Property Grid are set the default
printer settings and are disabled (displayed as greyed out).

• Specify the Report's Page Settings


Report specific page settings are specified using the Property Grid:

© Copyright 2000 to current year. 3:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The user can set the page orientation and modify the margins. The margin values are
expressed in the report's measurement units. The user can select from the predefined
paper sizes (Paper Kind property) or choose Custom and create a paper size, or
select one which is already defined for this printer (Paper Name property).
These settings affect the layout of the report's design area. After their modification, red
warning marks might be displayed, indicating that the controls go beyond the page
dimensions. These warnings can be switched off by setting the Show Print Margins
Warning property of the report to No.

To change the measurement units shown in the margins tooltips, customise the report's
Measure Units property.

Measure Units = Hundredths of an Inch

• Modify the Settings in Preview Tab

© Copyright 2000 to current year. 3:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The report's Preview tab toolbar has an icon that enables the user to modify the page
settings. Clicking this icon displays the Page Setup window, which allows the user to
adjust the page layout before printing or exporting, and to select the printer.

The margins can also be set visually by dragging the dashed lines in the Preview tab.

© Copyright 2000 to current year. 3:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.1.3 Bind a Report to Data


The main purpose of the Report Designer is to create and customise data-aware reports
which take data from an external data source (many types of which are supported), to which
the report is bound, with controls in the report linked to data fields in the data source.
To bind a report to data, proceed as follows:
• To bind the report to data, click its Smart tag. In the displayed actions list, expand the
Data Source dropdown menu and click Add New DataSource.

• A window appears allowing a name to be defined for the dataset being created.

© Copyright 2000 to current year. 3:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Click Next. On the next page, specify the database to be used. If it is absent in the
dropdown menu containing existing connections, click New Connection to display the
Data Link Properties window.

© Copyright 2000 to current year. 3:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

In Provider tab of this window, choose a data provider (the database). Then switch to
the Connection tab to specify the data source. Click OK, then Next.

© Copyright 2000 to current year. 3:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• The next page allows tables to be selected and obtained from the database. Select the
required table and click Finish.

© Copyright 2000 to current year. 3:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Note: If several tables are chosen, the Report Designer creates a data relationship
between them (if possible), which is used to create master-detail reports.

• After performing the steps above the report is now bound to the data source and the
report's Data Source, Data Member and Data Adapter properties are set.

After binding a report to a data source, each data-aware report control must be bound
to a data field from that source. Refer to Display Values from a Database (Bind Report
Elements to Data) for further details.

3.1.4 Controls Positioning


Two facilities are provided in the Report Designer to precisely align elements to each other:
• Snap Grid
• Snap Lines
Choose which mode to use for controls alignment within a report by setting its Snapping
Mode.

Snap Grid
When a report is being designed, it is lined up by the Snap Grid. This helps to establish the
distance between report elements, and to precisely align them to each other.

© Copyright 2000 to current year. 3:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

To quickly align a control to the report's Snap Grid, right click the control, and in the Context
Menu, click Align To Grid.

Specify whether the Snap Grid should be visible by setting the Draw the Grid option in the
Property Grid of the report.

© Copyright 2000 to current year. 3:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The Snap Grid Size, which is measured in the measurement units set for your report, can
also be adjusted.
The Snap to Grid option specifies whether controls are snapped to the grid when they are
moved as usual (with no additional keys being held down). When the Snap to Grid option is
enabled, the default move behavior works as follows:
• For controls to be aligned to the Snap Grid while being moved:
• Using the keyboard: move them using the ARROW keys.
• Using the mouse: move them as usual.
• For controls to ignore the Snap Grid while being moved:
• Using the keyboard: move them using ARROW keys while hold down CTRL.
• Using the mouse: move them while hold down ALT.
Disabling the Snap to Grid option swaps the default manipulation to its opposite (i.e. press
CTRL or ALT, to enable the grid snapping).
Snap Lines
Instead of the Snap Grid for control positioning and alignment, Snap Lines may be used.
These are guide lines that appear when a control is being moved, and indicate the distance
to other report elements (bands and controls).

Users can modify its default Snap Line spacing for each report element (padding for bands
and panels, and margins for other controls) using the Property Grid.

© Copyright 2000 to current year. 3:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.2 Report Types


The Report Types provide instructions on how to create reports of different types with the
Report Designer and consists of the following:
• Static Reportt
• Table Report
• Label Report
• Master-Detail Report (Detail Report Bands)
• Multi-Column Report
• Cross-Tab Report
• Parameterised Report
• Chart with Static Series
• Chart with Dynamic Series.

3.2.1 Static Report


A static report is a report that is not be bound to a data source. In the following example, a
one-page announcement will be created which will then be repeated 20 times in a report.
To create a static report, follow the steps.
• Drop the Rich Text control from the Toolbox onto the Detail band.

© Copyright 2000 to current year. 3:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Select the created control and click its Smart tag. In the displayed actions list, click
Load File.

In the window then displayed, define the path to the RTF or TXT file containing the text
of the announcement, and click Open.

Note: Additional text formatting can be performed using the Formatting Toolbar.

• To repeat the content of the report 20 times, select the Detail band and in the Property
Grid set its Repeat Count when Data Source is Empty property to 20.
Also, to make the announcement print on separate pages (so that each instance of the
announcement is on a separate page), set the band's Page Break property to After
the Band.

© Copyright 2000 to current year. 3:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The static report is now complete. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.2.2 Table Report


To create a table report, follow these steps:
• Add two Table controls, one to the Page Header band and one to the Detail band of
the report.
To do this, click Table in the Toolbox. Then, in the Page Header band's content area,
click and hold down the left mouse button while dragging the mouse cursor across the
Detail band.

As a result, two tables are created. The one placed in the Page Header band will be
used as a header, while the other one will contain the report's detail information.
• Type the headers into the upper table's cells, and bind the cells in the detail section to
the appropriate data fields. This can be done by dropping these fields from the Field
List onto the cells.

© Copyright 2000 to current year. 3:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Various properties of the tables can be customised. For example the Property Grid can
be used to define Borders property and the Background Color. Text appearance can
be customised using the Formatting Toolbar and an odd-even page style can be
applied to the table.
The table report is now complete. Switch to the Preview tab to view the result.

3.2.3 Label Report


To create a label report, follow these steps.
In this example a label report containing employee badges will be created using the Report
Wizard.
To start the Report Wizard, click the report's Smart tag and in the actions list, click Design
in Report Wizard.

© Copyright 2000 to current year. 3:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Refer to Label Report Wizard for further details.


• Finally, bind the report to a data source containing the required information, drop the
required fields from the Field List onto the available Detail band's area and customise
the layout.

The label report is now complete Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.2.4 Master-Detail Report (Detail Report Bands)


To create a master-detail report (report with hierarchically linked data) using the Detail
Report band, follow these steps.
• Bind the report to a data source containing a data relationship.

To do this, on the Reports Wizard's last page, select the data tables.

© Copyright 2000 to current year. 3:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

If it is possible to link these tables (e.g. by the common key field). The relations section
is displayed in the Field List.
• To add a Detail Report band, right-click the Report Designer, and in the displayed
Context Menu, point to Insert Detail Report. If the bound data source contains a data
relationship, the submenu will contain an item with the name of that relationship. Select
this item to create a Detail Report band, already bound to the detail table.

• Drop the required data fields from the Field List onto the report's Detail and Detail
Report bands.
Regarding the Detail Report band, note that only items from the relation section (in this
example it is the Categories Products section) should be dropped, or there will be
incorrect output in the report.

© Copyright 2000 to current year. 3:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The master-detail report is now complete. Switch to the Preview tab to view the result.

3.2.5 Multi-Column Report


To create a multi-column report, follow these steps.

© Copyright 2000 to current year. 3:21 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Select the Detail band, and in the Property Grid, expand the Multi-Column Options
section. First, set the required Mode. It determines whether the number of columns is
manually specified, or it depends on the fixed column width.

• Then, if Use Column Count was chosen, set the Column Count to the required number
of columns (e.g. 3), and Column Spacing as required (e.g. 6).

• The Layout determines the order in which records of the same group are processed.

© Copyright 2000 to current year. 3:22 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The multi-column report is now ready. Switch to the Preview Tab, and view the result.

3.2.6 Cross-Tab Report


Cross-tab reports are created using a Pivot Grid control, using the following steps.

Create a Pivot Grid and Bind it to Data


• Create a new report.
• Drag a Pivot Grid control from the Toolbox onto the report's Detail band.

• To bind the grid to a data source, click its Smart tag, and in the XRPicotGrid Tasks
menu, expand the Data Source dropdown menu and click Add New DataSource. The
Report Wizard window is displayed.
The wizard will guide the user through the process of assigning a data source to the
grid. For detailed instructions on the wizard's steps, refer to Bind a Report to Data, as
this process is similar.

© Copyright 2000 to current year. 3:23 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• The specified data source is then assigned to the grid's Data Source property. The
Data Member property is also set, which specifies which table or view of the dataset
the grid should obtain data from, as is the Data Adapter property.

Note: The report's Data Source property must be set to None. Otherwise, the grid will be
blank when it is previewed.

Manage the Grid's Fields


• Click the grid's Smart tag, and in the displayed actions list, click Run Designer. The
Property Editor is displayed.
• In this window, click Retrieve Fields and switch to the Layout section in the navigation
bar on the left.
• Drag and drop the required fields to the Row Fields, Column Fields and Data Items
areas.
• Click Apply and close the Property Editor.

© Copyright 2000 to current year. 3:24 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The cross-tab report is now complete. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:25 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.2.7 Parameterised Report


To create a report with parameters, proceed as follows.
In this example a parameter will be added to filter the report by an ISA Location specified by
the user when the report is run.
• In the Field List window, right-click on the Parameters section, and in the displayed
menu, click Add Parameter.

Repeat this action to create the second parameter.


• Set the properties of the parameter as required. For example:

Note: Every time a report is previewed, the user will be asked to enter the values of any
parameters. The following instructions explain how to use these values to filter a
report's data.

• Select the report (by clicking anywhere on the blank space of the report), and in the
Property Grid, locate the Filter String property and click the ellipsis. The FilterString
Editor is displayed.

© Copyright 2000 to current year. 3:26 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

In this window, define the required expressions for the parameters. Construct an
expression where a data field (e.g. ISA Location) is compared with the create
parameter. To access parameters, click the icon on the right until it turns into a question
mark. For example:

Note: Make sure that the report's Request Parameters property is set to Yes. Otherwise,
the parameters will not be requested when the report is previewed, and a blank
report will be the result.

The parameter filtered report is now ready. To view the results, switch to the Preview tab,
and in the Parameters section, define the required values and click Submit.

© Copyright 2000 to current year. 3:27 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.2.8 Chart with Static Series


To create a report with a Chart control bound to a data source, so that a particular series has
its own data source, proceed as follows.
This example describes how to construct a chart of products and their prices for a chosen
category using the data from the Northwind database (the sample nwind.mdb database).

Note: In this simple example, the series has a single data source. However, different data
sources can be used for different series if required.

• Create a new report.


• Drag the Chart control from the Toolbox onto the report's Detail band.

Note: The Chart Wizard may be displayed at this point (if its 'Show wizard every time a
new chart is added' option is enabled). Click Cancel to close the wizard's window
and manually customise the chart.

• To bind the chart to a data source, click its Smart tag, and in the displayed actions list,
expand the Data Source dropdown selector and click Add New DataSource. The
Report Wizard is displayed.

© Copyright 2000 to current year. 3:28 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The wizard guides the user through the process of assigning a data source to the chart.
For detailed instructions on the wizard's steps, refer to Bind a Report to Data, as this
process is similar.
• The specified data source is then assigned to the chart's Data Source property. The
Data Member property is also set, which specifies which table or view of the dataset
the chart should obtain data from, as is the Data Adapter property.

Note: The report's Data Source property must be set to None. Otherwise, the chart will be
blank when previewed.

• To add a series to the chart and specify its data binding properties, use the Series
Collection Editor. It can be displayed either via the Property Grid, or via the Series
link in the chart's Smart tag.
In the editor, create a series by clicking Add and selecting the Bar view.
Switch to the Properties tab.

© Copyright 2000 to current year. 3:29 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Set the series' Data Source property to the created dataset, define the Argument Data
Member and Value Data Members properties.
Click Copy to create another series with the same properties, and set its View property
to Point.
To save the changes and close the editor, click Close.
Note: After this step, there are maybe too many data points, making the chart difficult to
interpret. The chart's Data Filters property is used to limit the number of data points
shown by applying a filtering criterion. Click Series1 in the chart to select it, then in
the Property Grid locate the Data Filters item and click the ellipsis to display the
Data Filter Collection Editor.

• Click Add to add a criterion, and define its properties as shown in the following image:

© Copyright 2000 to current year. 3:30 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

To save the changes and close the editor, click Close.


Repeat the same actions for Series2, i.e. choose its Data Filters property, add a filter
and define its Column Name and Value.
• To improve a chart's appearance a number of changes can be made, for example:
• Remove the chart's legend, as it shows the same data for the series, select the
legend item in the chart, and in the Property Grid, set its Visible property to No.
• The point labels for Series1 are unnecessary, so select the label and set its Visible
property to No.
• Customise the Series2 marker's appearance. Replace the default circle with the
upside-down triangle by the View.Point Marker Options.Kind property and set its
Size to 12.
• Rotate the X-axis labels for better readability. Click the AxisX item in the chart to
select it, and the adjust properties for its labels (via the Label property). In this
example, setting the Angle property is 20 and the Antialiasing property set to Yes,
improves the appearance of the labels.
It is possible to customise many other properties for the chart, which are not described
here.
The chart is now complete. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:31 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

For details of another method of binding a chart to data, refer to Chart with Dynamic Series.

3.2.9 Chart with Dynamic Series


To create a report with a Chart control bound to data, in which the all series will be auto-
created using the series template specifying common data binding properties for all series,
proceed as follows.
The data for all series (the series names along with series points' arguments and values)
must be stored in the same data table. Also, the series view type and certain other settings
should be the same for all the created series.
In this example the 'GSP' table of the sample gsp.mdb database will be used. This table
contains the Gross State Product (GSP) statistics for some US regions.

The main steps of the procedure are:


• Create a chart and bind it to data
• Specify a series data member and adjust a series template
• Customise the chart

© Copyright 2000 to current year. 3:32 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• View the result

Create a Chart and Bind it to Data


• Create a new report.
• Drag Chart from the Toolbox onto the report's Detail band.

Note: At this point, the Chart Wizard may be displayed (if its Show wizard every time a
new chart is added option is enabled). Click Cancel to close the wizard's window
and manually customise the chart.

• To bind the chart to a data source, click its Smart tag, and in the displayed actions list,
expand the Data Source dropdown selector and click Add New DataSource. The
Report Wizard is displayed.

The wizard will guide the user through the process of assigning a data source to the
chart. For detailed instructions on the wizard's steps, refer to Bind a Report to Data, as
this process is similar.
• The specified data source is then assigned to the chart's Data Source property. The
Data Member property is also set, which specifies which table or view of the dataset
the chart should obtain data from, as is the Data Adapter property.

© Copyright 2000 to current year. 3:33 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Note: The report's Data Source property must be set to None. Otherwise, the chart will be
blank when previewed.

Specify a Series Data Member and Adjust a Series Template


In this example, all series will be created using a series template which is common to all of
them.
• To specify the data field which is to provide data for the series names, the Series Data
Member property value must be set.

• Next, set the Argument Data Member property.

© Copyright 2000 to current year. 3:34 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Define the value of the Value Data Members property, specifying the data fields from
which the series obtains the data values of its points.

Customise the Chart


• Adjust the Series Name Template
By default, the name for every series automatically generated by the chart using its
Series Data Member property's value is obtained directly from a data field in the bound
data source. However, it may be necessary to add prefixes or suffixes to these names.
The user may therefore customise the Series Name Template object returned by the
Series Name Template property to add some text to the beginning or to the end of the
series names. For instance, set the Series Name Template.Begin Text property to
GSP in.
• Customise Series Labels
Set the Series Template.Label.Visible property to No, to hide labels for all series
points, and prevent the chart from being crowded with numerous overlapping labels.

© Copyright 2000 to current year. 3:35 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Customise Axis Labels


Initially, all axis labels (which in this example show the names of the US regions) are
lined up and overlap. To avoid this, select the X-Axis (which is also accessed via the
Chart Control.Diagram.Axis X property) and set its Label.Staggered property to Yes.
It is possible to customise many other properties for the chart, which are not described
here.
View the Result
The chart is now complete. Switch to the Preview tab to view the result.

For details of another method of binding a chart to data, refer to Chart with Static Series.

3.3 Styles and Conditional Formatting


The appearance of reports is controlled by styles and conditional formatting. For detailed
information refer to:
• Styles Concepts
• Use of Odd and Even Styles
• Store and Restore Style Sheets
• Conditionally Change a Control's Appearance
• Conditionally Hide Bands.
• Conditionally Change a Label's Text

3.3.1 Styles Concepts


Each report element (band and control) and the report itself, has a group of properties
specifying the element's appearance, such as Background Color, Borders, Border Color,
Border Width, Font, Foreground Color, Padding and Text Alignment. By default, these
properties are set to no value, meaning that their values are obtained from their parent
element control or band. In turn, this means that these appearance-related properties,
defined for a parent, are inherited by their child elements.

© Copyright 2000 to current year. 3:36 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

If required, the default inherited appearance properties of a child element can be overridden
and set to difference properties, independent of parent element appearance properties.

© Copyright 2000 to current year. 3:37 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

If it is subsequently required to reset a child element’s appearance property to that of the


parent, right-click the property in the Property Grid, and in the displayed menu, click Reset.

© Copyright 2000 to current year. 3:38 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Note: Some of these properties are only applicable to certain controls. For example, the
Text Alignment properties of Line container bands are ignored and not inherited by
Line controls.

Additionally, there can be styles created in a report. A report's styles are stored in the
report's Style Sheet collection. A style stored within this collection has a set of the same
appearance properties as a control or a band has.
There are two ways to store a report's style sheets. The first approach is to save them to
external files (with the REPSS extension), and then load them into a report using its Style
Sheet Path property in read-only mode (this is described at Store and Restore Style
Sheets). The second is to store the style sheets within the report (using the Style Sheet
property), so that they can be modified, if required, and saved with the report itself.
Finally, the styles can be assigned to a report's bands and controls. A band or control can
therefore obtain its appearance either from a style assigned to it, or from the control's own
appearance properties. In this case, the control's Style Priority property allows the user to
define the required behaviour of the control's final appearance.
By default, all the Style Priority's options (Style Priority.Use Background Color, Style
Priority.Use Border Color, etc.), which follow the structure of the style and appearance
properties, are set to Yes (except the Use Text Alignment). Which means that if any style
is assigned to a control via its Styles property, all its properties will have a higher priority
than the properties stored in the control or in its parent. If some of the properties are to be
determined by a control, rather than its style, set the corresponding Use* property to No.

Note: If styles contained in a style sheet loaded in the Style Sheet Path property have the
same names as styles already contained in a report, the latter ones are overriden.

The following image demonstrates how the Style Priority property works.

© Copyright 2000 to current year. 3:39 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Note: When conditional formatting is used, the appearance defined by the conditional
formatting has a higher priority than the properties described above.

Another commonly used feature is odd-even styles. These allow the user to visually delimit
alternating data fields in a report, for better readability. More information about this can be
found in Use of Odd and Even Styles.

© Copyright 2000 to current year. 3:40 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.3.2 Use of Odd and Even Styles


Use of Odd and Even Styles describes how to create a report using odd and even styles.
For more information on using styles in the Report Designer, refer to Styles Concepts.
• Select the reportDetail band, and in the Property Grid, expand the Styles property.
Display the dropdown list for the Even Style property and click (New).

The controlStyle1 will be assigned to the Even Style property.


• Expand the Even Style property and set, for example, the Background Color property
to a colour as required.

© Copyright 2000 to current year. 3:41 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Repeat the last two steps for the Odd Style property, i.e. create a new style and set its
Background Color property to different colour.
• Expand the Style Priority property and set Background Color to Yes.

© Copyright 2000 to current year. 3:42 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• If the report is previewed using the Preview tab at this stage, something like the
following will be displayed:

© Copyright 2000 to current year. 3:43 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

As displayed, the created styles are applied to all the controls contained in the
reportDetail band.
• If a different style is required for one of the fields. Select the required field, and in the
Property Grid, expand its Styles property and open the dropdown list for the Style
property. Click (New).
Expand the Style property, and for the created controlStyle3, set the Background
Color property to the required colour.

• Make sure the Style Priority property for Background Color is set to Yes so that the
style of this control has priority over the reportDetail band's styles. Switch to the
Preview tab to view the result.

© Copyright 2000 to current year. 3:44 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.3.3 Store and Restore Style Sheets


It is possible to store a report's style sheet (containing all the report's styles) in an external
REPSS file and to restore a report's appearance from this file. For more information on
using styles in Report Designer, refer to Styles Concepts.
To store and restore report style sheets, follow these steps:
• Create a new report.
• Bind the report to a data source.
• Click the report's Smart Tag, and in the displayed actions list, locate the Style Sheet
property and click the ellipsis.

© Copyright 2000 to current year. 3:45 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• In the Styles Editor that is then displayed, click , to create new styles. Define their
properties and click Save.
In the Save File window, define a name for the style sheet file (.REPSS) and click the
Save button.

© Copyright 2000 to current year. 3:46 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• In the Styles Editor window, click to delete the created styles, and close the window.
• Select the report by clicking anywhere on the blank area around its bands. In the
Property Grid, locate the Style Sheet Path property and click the ellipsis. Using the
Open File window, select and load the created REPSS file.
Click the Style Sheet properties ellipsis. In the Styles Editor, observe that the
properties of the styles are read-only. This is because the Style Sheet Path property is
being used to define the styles.

© Copyright 2000 to current year. 3:47 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

If the Style Sheet Path property is subsequently set to None, and a style sheet is
loaded into a report using the Style Sheet property, all the styles loaded from the style
sheet file will still be stored in the report, but will become editable.
• Next, assign the styles to the report controls by using their Styles properties. In this
example, the created styles are assigned to the control's Odd Style and Even Style
properties. For more information, refer to Use of Odd and Even Styles.
Note: The styles loaded from a style sheet file have a higher priority than the styles which
exist in a report's style sheet, returned by the Style Sheet property. This means that
if the styles stored in the report have the same names as the styles loaded from a
style sheet file, then the styles in the file will substitute for their namesakes. The
styles loaded from a file cannot be edited in a report. For more information, refer to
Styles Concepts.

3.3.4 Conditionally Change a Control's Appearance


To conditionally change a control's appearance, follow these steps.
For more information on using styles in the Report Designer, refer to Styles Concepts.

© Copyright 2000 to current year. 3:48 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Select the report by clicking anywhere on the blank area around its band. In the
Property Grid, locate the Formatting Rules Sheet property and click the ellipsis. The
Formatting Rule Sheet Editor is then displayed. This is used to manage and
customise formatting rules, which then can be applied to the report's bands and
controls.
In this window, create a new formatting rule (click ), locate its Condition property and
click the ellipsis.

• In the displayed Condition Editor, define the required condition.

© Copyright 2000 to current year. 3:49 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

To save the condition and close the window, click OK.


• Now, define the formatting to be applied.

© Copyright 2000 to current year. 3:50 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Select the band or control to which the formatting rule must be applied (in this example
it is the reportDetail band), and in the Property Grid, locate the Formatting Rules
property and click the ellipsis. In the Formatting Rules Editor that is then displayed,
move the formatting rule from the Available Rules list to the Applied Rules list (using
the > button) in order to apply the rule to the control.

It is possible to customise the precedence of formatting rules by using the up and down
arrow icons at the right of the window. Rules are applied in the order that they appear in the
list, with the last rule in the list having the highest priority.
Switch to the Preview tab to view the result.

3.3.5 Conditionally Hide Bands


Bands may be conditionally hidden.
In this example a report with a Group Header band will be used. The report will be set to
hide both the Group Header and Detail band where the Loop number that instruments are
grouped by has been set, i.e. only instruments not assigned to a loop will be displayed.
• Select the Group Header's strip, and in the Property Grid, locate the Formatting
Rules property, and click the ellipsis.
In the Formatting Rules Editor, click Edit Rule Sheet.

© Copyright 2000 to current year. 3:51 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• In the Formatting Rule Sheet Editor, click , to create a new rule. Then set its
Visible property to No.

© Copyright 2000 to current year. 3:52 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• For the Condition property, click the ellipsis, construct the required boolean
expression to be met, and click OK.

Click Close to close the Formatting Rule Sheet Editor.

© Copyright 2000 to current year. 3:53 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• In the Formatting Rules Editor, move the rule from the Available Rules list to the
Applied Rules list (using the > button) to apply it to the Group Header band.

Do the same for the Detail band as well.


Switch to the Preview tab to view the result.

3.3.6 Conditionally Change a Label's Text


To conditionally format a label's text, follow these steps.
• To create a calculated field, in the Field List, right-click any item inside the dataset,
and from the menu, choose Add Calculated Field.

© Copyright 2000 to current year. 3:54 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• In the Property Grid, set the field's Field Type property to String. Locate its
Expression property and click the ellipsis. The Expression Editor is then displayed.

In this window, define the required condition for the calculated field (e.g. Iif([LoopNo]
== null, 'None', [LoopNo]), which means that if the LoopNo data field's value is null,
the appropriate control's text will be replaced with None).

© Copyright 2000 to current year. 3:55 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

To close the window, click OK.


• Drag the required data fields (and the created calculated field as well) from the Field
List onto the report's reportDetail band.

The report is now complete. Switch to the Preview tab to view the result.

3.4 Navigation
Navigation covers the navigation-related features of Report Designer and consists of the
following topics:
• Add Bookmarks
• Create Hyperlinks
• Add a Cross-Reference

3.4.1 Add Bookmarks


Reports may be created with bookmarks (or a Document Map). The feature enables users
to navigate through the report during its print preview.

Define Bookmarks
• Add a Group Header band to the report if not already included and place the required
label in it.
• Click the label in the Report Header band to select it, and in the Property Grid set its
Bookmark property to the same value as its text (i.e. Products by Categories).

© Copyright 2000 to current year. 3:56 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Select the label in the report's Group Header band. As this control is bound to data, its
Bookmark property will be bound to the same data field, using the (Data Bindings)
property.

© Copyright 2000 to current year. 3:57 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Set the Parent Bookmark property for the field to the Report Header's label, to define
the document map's hierarchy.

© Copyright 2000 to current year. 3:58 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The report with bookmarks is now complete. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:59 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.4.2 Create Hyperlinks


The following example demonstrates how to create a hyperlink in a report.

Note: A label will behave as a hyperlink both in a report's Print preview, HTML preview and
when the report is exported to PDF, HTML, MHT, RTF and XLS formats.

• Drop a label onto the report and change its Text to that which is required for the link.
Apply the formatting to it that will indicate that it is a hyperlink (i.e. blue colour and
underlined text).
• In the Property Grid, set its Navigation Target property to the required value (either
_blank, _parent, _search, _self, or _top), and for the Navigation URL property, define
the URL.

The hyperlink is now ready. Switch to the Preview tab to view the result.

3.4.3 Add a Cross-Reference


Cross-references are links the targets of which are located within the current document and
are used to help navigation through a report.
In this example, a link is created at the bottom of each page, linking to the beginning of the
report.
• In the Property Grid of a label in the ReportHeader, set its Name property to
reportTop.

© Copyright 2000 to current year. 3:60 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Drop a label onto the pageFooter band. As it will be the link, change its text to Top of
Report (for example), and apply the formatting to it that will indicate that it is a
hyperlink (i.e. blue colour and underlined text).
Finally, set its Navigation Target property to _self. Click the dropdown menu of the
Navigation URL property to view the controls available in the report, and select
reportTop.

© Copyright 2000 to current year. 3:61 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The cross-reference is now set up. Switch to the Preview tab to view the result.

3.5 Miscellaneous
Miscellaneous covers Report Designer features which do not fall into other categories:
• Handle Events via Scriptss
• Show the Current Row Index
• Count the Number of Records in a Report or a Group
• Add Page Numbers for Groups
• Sort Groups by a Summary Function Result
• Cancel Printing If a Report Does Not Contain any Records
• Limit the Number of Records per Page

3.5.1 Handle Events via Scripts


Report Designer includes a scripting feature to handle the events of report controls, report
bands, or reports themselves. The basic principles of scripting are described in this topic.

Overview
Scripting enables the user to insert scripts into a report, and execute them when the report
is previewed, printed or exported. Script commands should be placed within the event
handlers of the report objects. When the corresponding event occurs (e.g. a mouse click),
the script code runs.

© Copyright 2000 to current year. 3:62 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Generally scripts are used for data-aware report formatting. Though Report Designer
enables users to perform such tasks without any scripting (see Conditionally Change a
Control's Appearance, Conditionally Change a Label's Text and Conditionally Hide Bands),
sometimes it may be required to use scripts, for example to achieve more specific results.
The report's layout can be fully customised using of scripting.
Scripting also is the only way to calculate custom summaries.
Every report object has a set of events that can result in a script being run. The set of events
depends on a particular element type. For example, the Label control's events are shown in
the following image:

To add a script for an event, select New from the drop-down lost for that event. Once a
script is added for an event it will be added to this drop-down list. To select and edit an
existing script for an event, select it from the drop-down list for that event.
The Scripts tab is then displayed:

© Copyright 2000 to current year. 3:63 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The tab displays a script template in the language specified by the Script Language
property of the report (C#, Visual Basic or JScript .NET).
Insert or amend the script code with the help of this simple editor. Use the Validate button to
check for any errors. If there are any, they will be displayed in the Script Errors tab.

If there are errors in the script, an error message will also be displayed on previewing the
report.

The drop-down lists at the top of the Scripts tab are used to select other report elements
and to select and add other event scripts.
The scripts are saved along with the report layout to a file (for details on this, refer to Back
up the Current Layout before Modification).

Note: Assembles do not usually need including, because most standard assemblies that
may be required in scripts are already referenced by the Report Designer.

© Copyright 2000 to current year. 3:64 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.5.2 Show the Current Row Index


To show the current row index in a report, follow these instructions.
• Select the field for which the current row index will be displayed by clicking on it. Then
hold down CTRL and drag the field to create an exact copy of the Label, which will
display the index.

• Select the created Label, and in the Property Grid, locate the Summary property and
click the ellipsis. The Summary Editor is displayed.
In this window, the Bound field is already set to the required data field. So for the
Summary function select RecordNumber and check Ignore NULL values to avoid
these data fields from affecting the calculation.
Next, set the Summary Running option to Report, Group or Page as required and
click OK.

© Copyright 2000 to current year. 3:65 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:66 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.5.3 Count the Number of Records in a Report or a Group


To count the number of records in a report or a group, follow these instructions:
• Add a report or group footer band to the report if one is not already included.
• Click the field for which the number of records will be calculated to select it. Then hold
down Ctrl and drag the field onto the footer area to create an exact copy of the label,
which will display the number of records for a group or report.

• Select the Label in the footer area, and in the Property Grid, expand the Summary
property.

© Copyright 2000 to current year. 3:67 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Set the Summary Running property to Group or Report as appropriate, the Function
property to Count and (if required) the Ignore Null Values property to Yes.
The report is now complete. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:68 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.5.4 Add Page Numbers for Groups


To add page numbers for each group in a report, follow these instructions:
1. From the Standard Controls toolbar, drop the Page Info control onto the
GroupFooter band.

2. Select the control and set its Running Band setting to GroupHeader1:

© Copyright 2000 to current year. 3:69 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

If required, specify its Format property (e.g. Page {0} of {1}).


3. Set each new group to start on a separate page. Otherwise, group page numbers will
be calculated incorrectly.
To do this, select the Group Footer, and set its Page Break property to After the
Band.

4. Finally, set the Repeat Every Page property of the Group Footer to Yes.

© Copyright 2000 to current year. 3:70 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

The report is now complete. Switch to the Preview tab to view the result.

The same procedure may be carried out for the Group Header, as well if required.

3.5.5 Sort Groups by a Summary Function Result


To sort groups based on the result of a function summary specified for them:
1. Select the GroupHeader band and click its Smart Tag. In the invoked actions list, click
the ellipsis button for the Sorting Summary option.

© Copyright 2000 to current year. 3:71 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

2. In the Group Sorting Summary Editor, check the Enabled option, and specify a field
and summary function against which the group should be sorted.

If required, can change the sorting order (descending or ascending), and choose to
ignore null values.
The report is now complete. Switch to the Preview tab to view the result.

© Copyright 2000 to current year. 3:72 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.5.6 Cancel Printing If a Report Does Not Contain any Records


To cancel printing when a report does not contain any records, uncheck the Print when
Data Source is Empty property of the report:

© Copyright 2000 to current year. 3:73 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

3.5.7 Limit the Number of Records per Page


The number of records shown in a report can be limited by means of conditional formatting.
In particular, a formatting rule is applied to the Visible property of the Page Break control. In
this example, the number of data rows is passed to the report as a parameter.
To limit the number of records per page, follow these instructions.
• To add a parameter to the report, in the Field List, right-click the Parameters section,
and in the dropdown menu, choose Add Parameter.

© Copyright 2000 to current year. 3:74 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• Set the (Name) property of the parameter to rowsNumber, the Parameter Type
parameter to Int32 and the Description property to Rows per Page:.

• Drag the Page Break control from the Standard Controls toolbar onto the report's
reportDetail band and place it at the top of the detail table.

• For the created control, set the Visible property to No, and for its Formatting Rules
property, click the ellipsis to display the Formatting Rules Editor.

© Copyright 2000 to current year. 3:75 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

In this window, click Edit Rule Sheet. The Formatting Rule Sheet Editor is then
displayed.
• Click , to create a new formatting rule. Set its Visible property to Yes, and for the
Condition property, click the ellipsis, to display the Condition Editor.

© Copyright 2000 to current year. 3:76 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

• In this editor, define the following expression for the rule:


([DataSource.CurrentRowIndex] % [Parameters.rowsNumber] == 0) And
([DataSource.CurrentRowIndex] != 0).

© Copyright 2000 to current year. 3:77 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Edit Reports

Click OK to save the changes and close the window. Then click Close to close the
Formatting Rule Sheet Editor.
• In the Formatting Rules Editor, the created rule is displayed. Move it to the list of
applied rules on the right, use the > button.

To close the editor, click OK.


The report is now complete. Switch to the Preview tab, and in the Parameters section,
define the required value and then click Submit.

© Copyright 2000 to current year. 3:78 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4 Reference

A report is built from controls (text labels, images, charts, etc) in report sections called
bands (various headers, footers and content sections). The main interface elements for
managing these building blocks are the Standard Controls toolbar, data field list and
property grid. These elements enable users to add controls to a report, bind them to data
and change their appearance and behaviour settings, respectively. To learn more about
these and other elements and features in the Report Designer, use the following links:
• User Interface
Describes how to use the Standard Controls toolbar, data field list, property grid and
other UI elements.
• Report Settings
Details settings that affect the entire report.
• Report Bands
Details different kinds of bands and their settings.
• Report Controls
Details which controls are available, and how to change their appearance and
behaviour.
• Report Wizard
Describes the Report Wizard, used to easily create reports based on built-in templates.
• Preview, Print and Export Reports
Describes how to preview, print and export reports.

4.1 User Interface


The Report Designer User Interface consists of the following important elements:
• Component Tray
• Context Menu
• Standard Controls Toolbar
• Design Panel
• Designer Tab
• Preview Tab
• HTML View Tab
• Scripts Tab
• Group and Sort Panel
• Scripts Errors Panel
• Field List
• Report Explorer

© Copyright 2000 to current year. 4:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Property Grid
• Main Menu
• Main Toolbar
• Formatting Toolbar
• Layout Toolbar
• Zoom Toolbar
• Smart Tag
• Status Bar.

4.1.1 Component Tray


The Component Tray shows components (non-visual report helpers) the primary purpose
of which is to bind a report to data. The user can click them to display and edit their settings
using the Property Grid.

Note: Component management and data binding configuration are usually performed by
system administrators or a application vendors, since these areas require advanced
knowledge of database connectivity. A user will rarely, if ever, need to access
component settings when modifying existing reports.

4.1.2 Context Menu


A Context Menu can be displayed by the right-clicking a report or its elements. This menu
provides quick access to frequently used commands such as zooming, clipboard
operations, inserting bands and displaying the Property Grid, etc. The available action set
varies, depending on the element for which the context menu is displayed.

© Copyright 2000 to current year. 4:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.1.3 Standard Controls Toolbar


The Standard Controls toolbar lists all available controls and allows the user to add them
to a report.

© Copyright 2000 to current year. 4:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

To add a control from the Standard Controls toolbar, do one of the following:
• Double-click an item in the Standard Controls toolbar for the appropriate control to be
created in the top left corner of the currently selected band, or in the top left corner of
the reportDetail band if no band is selected.
• Drag and drop an item from the Standard Controls toolbar onto the required location
within a report.

© Copyright 2000 to current year. 4:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Select an item in the Standard Controls toolbar, and then click the required location
within a report.
• Select an item in the Standard Controls toolbar, and then indicate the bounding
rectangle by holding the left mouse button and dragging the cursor from one corner of
the rectangle to the opposite corner.

Select to perform selection, re-positioning or resizing operations. It is automatically


selected after a control is dropped onto a report.

Note: If the Standard Controls toolbar is not displayed, select View > Toolbars >
Standard Controls in the main menu to display it.

4.1.4 Design Panel


The Design Panel provides the following four tabs (switched at the bottom):
• Designer Tab
Enables uses to modify a report.
• Preview Tab
Shows a print preview, and enables users to print out a report or export it to a file.
• HTML View Tab
Shows the report output in HTML format.

© Copyright 2000 to current year. 4:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Scripts Tab
Shows scripts assigned to the current report element and enables users to add and
edit such scripts.

4.1.5 Designer Tab


The Designer Tab of the Design Panel enables users to customise a report, manage its
bands and controls, and define their properties.

© Copyright 2000 to current year. 4:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.1.6 Preview Tab


The Preview Tab of the Design Panel is used to check the print output of a report and
customise additional options. To learn more about print preview capabilities, refer to
Preview, Print and Export Reports.

© Copyright 2000 to current year. 4:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.1.7 HTML View Tab


The HTML View Tab of the Design Panel enables users to preview the HTML output of a
report.

4.1.8 Scripts Tab


The Scripts Tab of the Design Panel shows scripts assigned to the current report element
and enables users to add and edit such scripts.

4.1.9 Group and Sort Panel


The Group and Sort Panel enables users to quickly apply grouping and sorting to report
data.

© Copyright 2000 to current year. 4:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

To create a new grouping or sorting criterion, simply click Add a Group or Add a Sort.
Then, to control whether the corresponding Group Header or Footer band should be seen,
use the Show Header and Show Footer checkboxes.
An ascending or descending grouping (sorting) mode is specified via the Sort Order drop-
down list.
Change the order in which multiple grouping and sorting criteria are to be performed, via the
Move Up and Move Down buttons.
To remove a grouping or sorting criterion, select it, and click Delete.

Note: If the Group and Sort Panel is not displayed, select View > Windows > Group and
Sort from the main menu to display it.

4.1.10 Scripts Errors Panel


The Scripts Errors Panel displays the result of scripts validation after it's triggered in the
Scripts Tab.
If errors are located, they are listed in this panel. To go to the corresponding line of code in
the Scripts Tab, click the corresponding item in the panel's list.

© Copyright 2000 to current year. 4:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: If the Script Errors Panel is not displayed, select View > Windows > Scripts
Errors from the main menu to display it.

4.1.11 Field List


The Field List window serves the following purposes:
• Displays the list of all available data fields (attributes that can be shown in a report) and
enables users to create report elements that will show information from these fields.
• Enables users to create calculated fields by building expressions based on the values
of data fields, report parameter values, etc.
• Shows existing report parameters, and enables users to add parameters to a report.

© Copyright 2000 to current year. 4:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: If the Field List window is not displayed, select View > Windows > Field List from
the main menu to display it.

4.1.12 Report Explorer


The Report Explorer shows a report's structure in a tree form, providing easy access to
report elements. Once an element has been selected in the Report Explorer, it's settings
can be changed using the Property Grid window.

© Copyright 2000 to current year. 4:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: If the Report Explorer is not displayed, select View > Windows > Report Explorer
from the main menu to display it.

4.1.13 Property Grid


The Property Grid enables users to change the settings of the currently selected report
element.

© Copyright 2000 to current year. 4:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

To select an element and show its properties within the Property Grid, do one of the
following:
• Click the required element on the Report Designer surface.
• Select an element using the Report Explorer window.
• Select an element from the Property Grid's box.
• Right-click on the element and select Properties from the Context Menu.
Note: If the Property Grid is not displayed, select View > Windows > Property Grid from
the main menu to display it.

4.1.14 Main Menu


The Main Menu contains various commands grouped in five sub-menus. These menu items
duplicate various commands available in the Report Designer's Toolbars, and enables
users to switch between different Tabs, and hide or show the available Toolbars and
Panels.

© Copyright 2000 to current year. 4:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.1.15 Main Toolbar


The Main Toolbar contains icons which provide the capability to create new reports, save
and load report layouts, cut, copy and paste report elements, and undo-redo actions in the
Report Designer.

© Copyright 2000 to current year. 4:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: If the Formatting Toolbar is not displayed, select View > Toolbars > Toolbar from
the main menu to display it.

4.1.16 Formatting Toolbar


The Formatting Toolbar enables users to customise an element's font, colour and
alignment settings.

© Copyright 2000 to current year. 4:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: If the Formatting Toolbar is not displayed, select View > Toolbars > Formatting
Toolbar from the main menu to display it.

4.1.17 Layout Toolbar


The Layout Toolbar enables users to easily align report elements to one another, change
their size to match one another and customise spacing and z-order.

Note: If the Formatting Toolbar is not displayed, select View > Toolbars > Layout Toolbar
from the main menu to display it.

4.1.18 Zoom Toolbar


The Zoom Toolbar enables user to zoom a report in and out, providing easier control over
report's layout.

© Copyright 2000 to current year. 4:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: If the Zoom Toolbar is not displayed, select View > Toolbars > Zoom Toolbar from
the main menu to display it.

4.1.19 Smart Tag


Most report elements have smart tags that provide easy access to the most frequently used
settings. Clicking an element's smart tag displays a popup window with action links and
editors, enabling users to customise this element.
• Report Smart Tag
A report's smart tag icon is located at the top left corner of the Design Panel.

© Copyright 2000 to current year. 4:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Band Smart Tag


A band's smart tag icon is located on the band strip right next to its caption. For
instance, the smart tag for the reportDetail band is shown in the following image:

• Control Smart Tag


A control's smart tag icon is located in the top right corner of the control. For instance,
the smart tag for the Label control is shown in the following image:

© Copyright 2000 to current year. 4:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Picture Box Control Smart Tag


A Picture Box control’s smart tag icon is located in the top right corner of the control.
The smart tag for a Picture Box control is shown in the following image:

4.1.20 Status Bar


The Status Bar is located at the bottom of the Report Designer, and displays hints about
currently selected commands in the Main Menu or toolbars.

© Copyright 2000 to current year. 4:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.2 Report Settings


A typical report is shown in the following image (as it looks in Designer Tab and Preview
Tab):

© Copyright 2000 to current year. 4:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

While the main report's properties can be accessed via the report's Smart Tag, the
complete settings list is available in the Property Grid, where all the report's properties are
divided into the following groups:
• Appearance
• Behaviour
• Data
• Design
• Navigation
• Page Settings
• Parameters
• Printing
• Structure

© Copyright 2000 to current year. 4:21 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.2.1 Appearance
• Background Color
Specifies the background colour of report elements. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for report elements.
• Font
Specifies the font settings for report elements. Some of these settings are available on
the Formatting Toolbar.
• Foreground Color
Specifies the text colour for report elements. This option is also available on the
Formatting Toolbar ( ).
• Formatting Rule Sheet
Displays the Formatting Rule Sheet Editor, enabling users to manage and customise
formatting rules, which can then be defined for a report's bands and controls. For more
information, refer to Conditionally Change a Control's Appearance.

• Formatting Rules
Displays the Formatting Rules Editor, enabling users to choose which rules should
be applied to a report during report generation, and define the precedence of the
applied rules. For more information, refer to Conditionally Change a Control's
Appearance.

© Copyright 2000 to current year. 4:22 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Padding
Specifies indent values used to render the contents of a report's controls.
• Page Color
Specifies the background colour of the report page.
• Style Sheet
Enables users to display the Styles Editor, which is used to manage and customise a
report's style sheets. For more information, refer to Store and Restore Style Sheets.

© Copyright 2000 to current year. 4:23 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Style Sheet's Path


Enables users to define a path to the style sheet contained in a report style sheet file
(.REPSS). For more information, refer to Store and Restore Style Sheets.
• Text Alignment
Enables users to change the alignment of a report controls' text. This option is also
available on the Formatting Toolbar.
• Watermark
Enables users to customise a report's watermark options. For more information, refer
to Create or Modify Watermarks of a Report.

4.2.2 Behaviour
• Display Name
Determines a report's name, by which it can be accessed in the Report Explorer,
Property Grid or via scripts.
• Export Options
Enables users to set the export options for each file type (PDF, XLS, TXT, etc.). These
options vary with the Report Designer file type.
• Measure Units
Enables users to choose units of measurement for a report (one hundredth of an inch
or a tenth of a millimeter).
• Script Language
Enables users to choose the programming language to be used in scripting (C#, Visual
Basic or JScript .NET).

© Copyright 2000 to current year. 4:24 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Script References
Enables users to manage the collection of strings that represent the paths to the
assemblies used by the scripts in a report.
• Scripts
This property contains events which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts in Chapter Edit Reports.
• Show Margin Lines in Preview
The page margin lines are dotted lines shown on the currently selected page in a
report's preview. Use this property to change the visibility of these lines.
• Vertical Content Splitting
Enables users to choose whether report controls outside the right page margin should
be split across pages, or moved in their entirety to the next page.
• Visible
Specifies whether or not a report should be created in print preview.

4.2.3 Data
• Calculated Fields
Enables users to access a report's calculated fields collection editor.

• Data Adapter
Specifies the report's data adapter, used to populate the report's data source. It is
created automatically when the Data Member property is defined. For more
information, refer to Bind a Report to Data in Chapter Edit Reports.
• Data Member
Specifies the specific list (database table) in a report's Data Source, from which Report
Designer objects display data. For more information, refer to Bind a Report to Data in

© Copyright 2000 to current year. 4:25 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Chapter Edit Reports.


Note: It is not usually necessary to specify the Data Member property when binding a
report to data. This property should only be set if the Data Source dataset contains
more than one table.

• Data Source
Determines a report's Data Source. For more information, refer to Bind a Report to
Data in Chapter Edit Reports.
• Filter String
Used to display the Filter String Editor, which is intended to easily define a filtering
condition for a report's data. For more information, refer to Change or Apply Data
Filtering to a Report.

• Tag
This property is used to add some additional information to a report; for example its id,
by which it can then be accessible via scripts.
• XML Data Path
Used to define a path to data contained in an external XML file. The data contained in
the file will then be used as a report's data source.

4.2.4 Design
• (Name)
Determines a report's name, by which it can be accessed in the Report Explorer,
Property Grid or via scripts.
• Data Source's Schema
Enables users to load an XML/XSD file, containing the schema of a report's data
source.
• Designer's Options
These options control whether or not designer hints, export warning and printing
warnings are displayed:
• Show Designer’s Hints

© Copyright 2000 to current year. 4:26 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

The designer hints are intended to provide tooltips, both describing the purpose of
certain report elements for inexperienced users, and describing the reasons and
solutions for possible export or printing warnings. This property is used to turn these
hints on or off.

• Show Export Warnings


This setting controls whether or not export warnings are displayed when report
controls are overlapped, indicating that a report layout may be incorrect when
exporting to certain table-based formats (such as XLS, HTML or RTF).

• Show Printing Warnings


This setting controls whether printing warnings are displayed. Printing warnings
indicate that some of a report's controls are placed outside the right page margin,
so that the report contains unnecessary pages.

• Draw the Grid


Determines whether or not the grid is displayed when a report is being designed.

© Copyright 2000 to current year. 4:27 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Snap Grid Size


Determines the size of the grid that may be displayed when a report is being designed,
depending on the Draw the Grid setting.
• Snap to Grid
This property controls whether or not controls snap to the grid when they are positioned
on a report or resized.
• Snapping Mode
Determines the snapping mode: Snap to Grid or Snap to Lines.

4.2.5 Navigation
• Bookmark
Used to define how a report is named in a document map when report bookmarks are
implemented. By default, it will be the same as the report's Name property.

4.2.6 Page Settings


• Landscape
Determines whether the page orientation is Landscape (when set to Yes) or Portrait
(when set to No).
• Margins
Determines the width of a report's margins (measured in report units).
Note: The report's Margins.Top and Margins.Bottom properties are tied to the Height
property of the Page Margin Bands. Therefore changing these values will change the
appropriate bands' Height value as well, and vice versa.

• Page Height
Specifies page height, in report units. This property can only be set if the Paper Kind
property is set to Custom.
• Page Width
Specifies page width, in report units. This property can only be set if the Paper Kind
property is set to Custom.
• Paper Kind
Determines the type of paper that a report will be printed on. Setting this property to
any value other than Custom will prevent the Page Height, Page Width and Paper
Name properties from being customised.
Note: If the Paper Kind property is set to Custom, then the printer paper will be selected
according to the Paper Name property's value. In this case, it is also necessary to
set the Page Width and Page Height properties to the values of the paper selected.

• Paper Name
Determines the name of the custom paper used in the printer on which the report will
be printed.

© Copyright 2000 to current year. 4:28 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

The Paper Name property's value applied only when the Paper Kind property is set to
Custom. If this property is used, it is also necessary to set the Page Width and Page
Height properties to the values of the selected paper. If the printer on which a
document is printed doesn't support the paper type specified by the Paper Name
property's value, then it will default to the Letter paper size.
• Printer Name
Determines the name of the printer to use when printing a report.
• Using Settings of the Default Printer
Specifies which of the default printer's settings should be used when printing a report.

4.2.7 Parameters
• Parameters
Enables access a report's parameters collection.

• Request Parameters
Enables users to define whether the values of a report's parameters are to be
requested when generating a report.

4.2.8 Printing
• Report Print Options
• Detail Count
Specifies how many times the Detail band should be printed when a data source is
defined for the report, and it is not empty.
• Detail Count at Design Time
Specifies how many times the Detail band is printed when a report is being
previewed at design time.

© Copyright 2000 to current year. 4:29 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Detail Count when Data Source is Empty


Specifies how many times the Detail band should be printed when no data source is
defined for the report.
• Print when Data Source is Empty
Specifies whether or not a report should be printed if its data source is empty.
• Show Print Margin Warnings
Specifies whether or not a warning is displayed when page margins are outside the
printable area.
• Show Print Status Dialog
Specifies whether or not a print status dialog is displayed when the report is printed.

4.2.9 Structure
• Bands
Used to display the Report Editor, used to manage and customise a report's bands.

Refer to Manage Bands for details.

© Copyright 2000 to current year. 4:30 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.3 Report Bands


The Report Designer creates banded reports. Bands are report sections that can be printed
once in a report (report header and footer), or on each report page (page header and
footer), or for each data entry (detail band), or for each data group (group header and
footer), etc.

4.3.1 Manage Bands


Users can manage a report's bands using the Report Editor, which may be displayed either
using the Edit and Reorder Bands context link of a report's Smart Tag actions list:

... or via any band's Smart Tag:

© Copyright 2000 to current year. 4:31 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

The Report Editor enables users to easily add, remove and reorder a report's bands, and
to define their properties.

Another method of adding a band to a report is to display the Context Menu by right-clicking
anywhere on the report's.

© Copyright 2000 to current year. 4:32 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.3.2 Band Types


Report Designer uses the following band types:
• reportDetail Band
• Group Header and Footer Bands
• Report Header and Footer Bands
• Page Header and Footer Bands
• Page Margin Bands
• Detail Report Bands (for Master-Detail Reports).

4.3.3 reportDetail Band


The reportDetail Band is the central part of a report. Unlike other report bands, this band
cannot be deleted - the report structure includes the reportDetail band as its core. The
contents of the reportDetail band are repeated for every data entry. If a report listing, for
example, instruments is being built, it will be rendered for each instrument in the database.

© Copyright 2000 to current year. 4:33 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

In the Property Grid, a reportDetail band's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color

© Copyright 2000 to current year. 4:34 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor which enables users to choose which rules
should be applied to the band during report generation, and define the precedence of
the applied rules. For more information, refer to Conditionally Change a Control's
Appearance.

• Padding
Specifies the indent values which are used to render the contents of the controls
contained within the band.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the controls contained within the
band, as well as to assign an existing style to them (or a newly created one). For more
information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the band. This
option is also available on the Formatting Toolbar.
Behaviour
• Keep Together
As stated above, the reportDetail band is printed for every data entry. When the Keep
Together option is on, Report Designer attempts to keep sequential reportDetail band
entries together. This option makes sense only when data is grouped or in the case of a
master-detail report. The report engine tries to keep group contents on one page. If a
group does not fit and would start in the middle of a page, the report moves this group
to a new page, thus reducing the number of page breaks in continuous data.

© Copyright 2000 to current year. 4:35 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Multi-Column Options
This property is used to arrange the printout of the band's content in several columns.
For more information, refer to Multi-Column Report.
• Page Break
Use this property if the current report design requires that the detail section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many cases,
this property may be used instead of the Page Break control.
• Scripts
This property contains events, which can be handled by the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Sort Fields
Displays the Group Field Collection Editor, which enables users to specify the fields
for sorting the records within the band, the sorting order (Ascending/Descending) for
each field and the order sequence. For more information, refer to Change or Apply
Data Sorting to a Report.
• Tag
This property enables users to add additional information to the band; for example its
Id, by which it can then be accessed by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Height
Specifies the band's height, in report units. The default height for a newly created
reportDetail band is 100.
• Snap Line Padding
Specifies the inner indents to be maintained when report elements are aligned with the
band’s edges using snap lines.
Misc
• Keep Together with Detail Reports
When this option is on, the reportDetail band will be always printed on the same page
as its child Detail Report Band, or multiple bands.

4.3.4 Group Header and Footer Bands


The Group Header and Group Footer bands are shown above and below each group. See
Change or Apply Data Sorting to a Report for additional information.

© Copyright 2000 to current year. 4:36 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Group Header bands may be used for grouping by multiple data fields in one of the
following ways:
1. Add several Group Header bands. Specify one group field for each of these bands.
This results in nested grouping of the report's data.
2. Specify several group fields for the Group Fields property of the Group Header band.
The data will be grouped by certain combinations of field values.
The Group Footer band is unnecessary without the corresponding Group Header band.
When present, it allows customisation by providing a set of properties similar to those of the
Group Header.
In the Property Grid, the properties of these bands are divided into the following groups.
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.

© Copyright 2000 to current year. 4:37 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor which enables users to choose which rules
should be applied to the band during report generation, and define the precedence of
the applied rules. For more information, refer to Conditionally Change a Control's
Appearance.

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the controls contained within the
bands, as well as to assign an existing style to them (or a newly created one). For more
information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available on the Formatting Toolbar.
Behaviour
• Group Fields
This property is available for the Group Header band only. It displays the Group Field
Collection Editor, enabling users to add and remove grouping fields, define a data
field to be used as a grouping criteria and the grouping order (ascending or
descending).

© Copyright 2000 to current year. 4:38 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

This property is also accessible via the band's Smart Tag.


• Group Union
Determines whether group rows can be printed on different pages (in this case both
Group Union and Group Footer Band.Group Union are set to None), or the entire
group will be printed on a single page.
Also, if a group can be split across pages, but if Group Headers are not to be printed
on a page if there is no data row below it (in case a group starts at the bottom of the
page and there is enough room for only a Group Header), set the Group Union to
With First Detail property. In this case, if a Group Header is alone on a page, it will be
moved to the beginning of the next page.
The same option can be applied to Group Footers. To prevent them being printed
alone on a page, set the Group Union to With Last Detail property. The last group
row from the previous page will be moved to the next page to be printed together with a
Group Footer.
This property is also accessible via the band's Smart Tag.
• Keep Together
When this option is on, Report Designer attempts to fit the band contents entirely on
one page, not allowing it to split across several pages. In general, if the contents are
too large to fit on a single page, then the band is started on a new page, and continues
on the following page.
• Level
Specifies the nesting level of a group band. The lower the level number, the closer the
group band is to the reportDetail band. The lowest setting is zero. This is the
parameter that identifies the Group Header / Group Footer band pairs.
This property is also accessible via the band's Smart Tag.

© Copyright 2000 to current year. 4:39 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Page Break
Use this property if the current report design requires that the band's section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many
cases, this property may be used instead of the Page Break control.
• Print at Bottom
This property is available for the Group Footer band only. It determines whether the
band should be printed at the bottom of a page, or immediately after the last group's
details.
If a report contains several Group Footers with their Print at Bottom properties set to
different values, then the outer Group Footer has the highest priority.
This feature is helpful when the Page Break property of the Group Header band is set
to After the Band. In this instance each group starts a new page, and the Group
Footer has two distinct places to reside - after the last row, or at the bottom of the
page.
• Repeat Every Page
This property improves the readability of reports with group contents that are several
pages long. Without a repeated group header at the top of the page, the report may be
difficult to read.
This property is also accessible via the band's Smart Tag.
• Scripts
This property contains events, which can be handled with the required scripts. For
more information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or via scripts
Layout
• Height
Specifies the band's height, in report units.
• Snap Line Padding
Specifies the inner indents to be maintained when report elements are aligned with the
band’s edges using snap lines.

4.3.5 Report Header and Footer Bands


The Report Header and Report Footer are the only types of report bands rendered once
per report.

© Copyright 2000 to current year. 4:40 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• The Report Header is the first band of a report on the first page, not counting margins
as they are 'out-of-page' zones. The Report Header precedes even the Page Header
band. It is the best place for the report's name, company logo, date of creation, author's
name and miscellaneous information. If a chart that visualises the report's data is to be
included, then drop the Chart control onto this band.
• The Report Footer finalises the informative part of the report. It is placed before the
Page Footer and Bottom Margin bands on the report's last page. Use the Report
Footer for report grand totals or conclusions.
In the Property Grid, the properties of these bands are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

© Copyright 2000 to current year. 4:41 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property enables users to define odd and even styles for the controls contained
within the bands, as well as to assign an existing style to them (or a newly created
one). For more information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available in the Formatting Toolbar.
Behaviour
• Keep Together
When this option is on, the Report Designer attempts to fit the band contents entirely
on one page, not allowing it to split across several pages. In general, if the contents are
too large to fit on a single page, then the band is started on a new page, and continues
on the following page.
• Page Break
Use this property if the current report design requires that the band's section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many
cases, this property may be used instead of the Page Break control.
• Print at Bottom
This property is available for the Report Footer band only, and determines whether
this band should be printed at the bottom of the last page, or immediately after the last

© Copyright 2000 to current year. 4:42 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

report's details. The Report Footer has priority over the Group Footer's Print at
Bottom property, so the Group Footer can never be placed after the Report Footer.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts
Layout
• Height
Specifies the band's height, in report units.
• Snap Line Padding
Specifies the inner indents to be maintained when report elements are aligned with the
band’s edges using snap lines.

4.3.6 Page Header and Footer Bands


The Page Header and Page Footer bands are located at the top and bottom of every page
in a report.

The Page Header/Footer bands are the best place for information that should be printed on
every page. For example, use them to display the header of a table which is continued from
the previous page (refer to Table Report for an example).

Note: If a page break is inserted immediately after the Report Header (by setting its Page
Break property value to After the Band), the Page Footer and Page Header bands
will not be printed on the first page.

In the Property Grid, the properties of these bands are divided into the following groups:
Appearance
• Background Color

© Copyright 2000 to current year. 4:43 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property enables users to define odd and even styles for the controls contained
within the bands, as well as to assign an existing style to them (or a newly created
one). For more information on style inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available in the Formatting Toolbar.

© Copyright 2000 to current year. 4:44 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Behaviour
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
• Snap Line Padding
Specifies the inner indents to be maintained when report elements are aligned with the
band’s edges using snap lines.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Height
Specifies the band's height, in report units.
• Snap Line Padding
Specifies the inner indents to be maintained when report elements are aligned with the
band’s edges using snap lines.
Misc
• Print On
This property specifies whether the band should be printed on the same page as the
Report Header and Report Footer bands.

4.3.7 Page Margin Bands


The Top Margin and Bottom Margin bands represent the top and bottom page margins.
They are intended for displaying page numbers, or some sort of supplementary information
(e.g. current system time or the user name).

© Copyright 2000 to current year. 4:45 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

In the Property Grid, the properties of these bands are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.
• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the bands.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property enables users to define odd and even styles for the controls contained
within the bands, as well as to assign an existing style to them (or a newly created
one). For more information on style inheritance, refer to Styles Concepts.

© Copyright 2000 to current year. 4:46 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Text Alignment
Used to change the text alignment of the controls contained within the bands. This
option is also available in the Formatting Toolbar.
Behaviour
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
• Snap Line Padding
Specifies the inner indents to be maintained when report elements are aligned with the
band’s edges using snap lines.
Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Height
Specifies the band's height, in report units.
Note: That this property is tied to the report's Margins.Top (or Margins.Bottom) property, so
that changing this property's value will cause the appropriate Margin value to be
changed, and vice versa.

• Snap Line Padding


Specifies the inner indents to be maintained when report elements are aligned with the
band’s edges using snap lines.

4.3.8 Detail Report Bands (for Master-Detail Reports)


The Detail Report Band is a type of band used to incorporate one report into another in
master-detail reports.
The Detail Report Band is quite different from the reportDetail band since it holds the
whole detail report in a master-detail report layout.
There can be an unlimited number of Detail Report Bands nested inside one another, and
every new group of bands is coloured differently in the Report Designer, as illustrated
below:

© Copyright 2000 to current year. 4:47 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

The Detail Report Band cannot be added to a report via the Report Editor like other band
types. To add a Detail Report Band, right-click the report and in the Context menu, point to
Insert Detail Report. If the bound data source contains a data relationship, the submenu
will contain an item with the name of that relationship. Select this item to create a Detail
Report Band already bound to a detail table. Otherwise, add an unbound detail report and
specify its properties later.

In the Property Grid, the properties of this band are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the controls contained within the band. This option
is also available on the Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the controls contained within the band.
• Font
Specifies the font settings for the controls contained within the band. Some of these
settings are available on the Formatting Toolbar.

© Copyright 2000 to current year. 4:48 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Foreground Color
Specifies the text colour for the controls contained within the band. This option is also
available on the Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the band during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

• Padding
Specifies indent values which are used to render the contents of the controls contained
within the band.
• Text Alignment
Used to change the text alignment of the controls contained within the band. This
option is also available in the Formatting Toolbar.
Behaviour
• Page Break
Use this property if the current report design requires that the band's section should be
separated from previous sections or follow-ups. Specify the Before the Band or After
the Band values to insert a page break before or after the current band. In many
cases, this property may be used instead of the Page Break control.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the band should be visible when the report is previewed.
Data
• Data Adapter
Determines the data adapter that provides the detail data for the report. For more
information, refer to Master-Detail Report (Detail Report Bands).
• Data Member
Determines a name of the data relationship established within the bound data source.
For more information, refer to Master-Detail Report (Detail Report Bands).

© Copyright 2000 to current year. 4:49 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Data Source
Determines the data source that provides the detail data for the report. If this property is
not defined, the detail report gets data from the master report's data source. For more
information, refer to Master-Detail Report (Detail Report Bands).
• Filter String
Used to display the Filter String Editor, used to define a filtering condition for a detail
report's data. For more information, refer to Change or Apply Data Filtering to a Report.

• Tag
This property is used to add additional information to the band; for example its Id, by
which it can then be accessible by scripts.
• XML Data Path
Used to define a path to data contained in an XML file. The data contained in the file will
then be used as the Detail Report Band's data source.
In this case, the Data Member property will specify the bound list in the XML data
source.
Note: Note that a detail report uses the XML Data Path property value only when the Data
Source property is set to None. The XML Data Path property has a lower priority
than the Data Source property.

Design
• (Name)
Determines a band's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Misc
• Bands
Used to display the Report Editor for managing and customising a report's bands.
• Level
Specifies the order of several Detail Report Band objects in a report. It enables the
reordering of different Detail Report Bands at the same level of master-detail
relationships.
• Print when Data Source is Empty
Specifies whether or not a Detail Report Band should be printed if its data source is
empty.

4.4 Report Controls


A Report Control is an element showing information in a report (e.g. static or bound text,
line, picture, check box, etc.).

© Copyright 2000 to current year. 4:50 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Available Controls
The following controls are available in the Standard Controls toolbar panel:
• Label
• Check Box
• Rich Text
• Picture Box
• Panel
• Table (including Table Row and Table Cell)
• Line
• Shape
• Bar Code
• Zip Code
• Chart
• Pivot Grid
• Page Info
• Page Break
• Cross-band Line
• Cross-band Box
• Subreport.
Add Controls to a Report
To create a control, drag it from the Standard Controls toolbar panel onto the report's
area.

To automatically create a control bound to data, drag a field from the Field List panel, and
drop it onto a report's surface. When dropping a field onto an existing control, this control
will be bound to the data field.

© Copyright 2000 to current year. 4:51 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If a field is dragged with the right mouse button, when the button is released the context
menu is displayed. Use this menu to specify which control should be created.

© Copyright 2000 to current year. 4:52 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

For more information on data binding for report controls, refer to Display Values from a
Database (Bind Report Elements to Data).

Note: When the controls overlap, the report may be shown incorrectly when exported to
HTML, XLS or RTF formats. A red tint to the controls and a tooltip indicate this
situation. The red warning marks may be switched off using the report's Show
Export Warnings property.

Useful Key Combinations


To change a control's size and position, the following key combinations can be used:

© Copyright 2000 to current year. 4:53 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Key Combinations Actions


ARROW keys Snaps the control to the grid and moves it up, down, left or
right by one grid step, defined by a report's Grid Size
property.
CTRL + ARROW Moves the control up, down, left or right by one report unit.
SHIFT + ARROW Increases or decreases the control's width or height by one
grid step, defined by a report's Grid Size property.
CTRL + SHIFT + ARROW Increases or decreases the control's width or height by one
report unit.
TAB Selects the next control in tab order.
SHIFT + TAB Selects the previous control in tab order.

4.4.1 Label
The Label control is used to display textual information in a report. For example, the Label
may be used to show static text, as well as data from the bound data source. In addition, it
can be used to calculate a summary function for the specified data field, or to extend its
usual functionality by writing scripts for the available events.

After a Label is added to a report, its text, appearance and other properties can be
customised using the Property Grid panel. Frequently used properties are also available
via a control's Smart Tag and Formatting Toolbar, which makes it easy to perform common
operations.
In the Property Grid, the Label control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.

© Copyright 2000 to current year. 4:54 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

For more information, refer to Conditionally Change a Control's Appearance.


• Padding
Specifies indent values which are used to render the contents of a Label.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available in the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of a Label, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for
data-bound Labels located between upper and lower controls, which are able to resize
depending on their contents.
Note: If the Anchor Vertically property is set to Bottom or Both, the Can Grow and Can
Shrink property (see below) values are ignored, and are not considered when
calculating a final height value of a control.

• Angle
Specifies the rotation angle of the text. The measurement unit is a degree, and the
orientation is counterclockwise. Since standard HTML does not support text
orientation, this parameter is ignored when a report is displayed within a web page.
• Can Grow
When this property is set to Yes, a Label's height can be automatically increased, if
required, to fit the text. If there are other controls below the current Label, they will be
pushed down to prevent them from overlapping. Note that if a control overlaps the
grown Label by even one pixel, it will not be pushed down by the expanded Label.
• Can Shrink
When this property is set to Yes, and the text does not completely fill a Label, then the
Label's height will be decreased to the height of its text. If there are other controls
below the current Label, they will be moved up to fill the gap. Note that if a control
overlaps a shrunk Label by even one pixel, it will not be pushed up by the shrinking
Label.
• Keep Together
Specifies whether the contents of a Label can be horizontally split across pages. In
other words, if a Label occupies more space than remains on the page, this property
specifies whether this Label should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a label will not fit on the next page
either, then the Label will be split, regardless of this property's value.
• Multiline
When this property is set to Yes, a Label processes newline characters found in the
text to start a new line. For example, when editing a Label’s text, a new line can be
inserted by pressing ENTER, and in this case, the Multiline property will be
automatically set to Yes.
• Process Duplicates

© Copyright 2000 to current year. 4:55 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Determines the control's behaviour when its data source contains consecutive
repeating records. They can be processed as is (when the property is set to Leave),
suppressed except for the first entry (Suppress) and suppressed with blank space
printed instead of the repeated records (Suppress and Shrink).
• Process Null Values
Determines whether to process Null (blank) values if they appear in the control's data
source. They can be processed as is (when the property is set to Leave), suppressed
(Suppress) and suppressed with blank space printed instead of the blank records
(Suppress and Shrink).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into the multiline Label is wrapped to the
next line if it does not fit the line or is interrupted by a newline character. If the property
is set to No, text entered into the multiline Label will be displayed on the same line
except where forced on a new line by a newline character.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Navigation URL, Tag and Text) to a data field obtained from
the report's data source, and to apply a format string to it. For more information, refer to
Display Values from a Database (Bind Report Elements to Data).
• Lines
Provides access to the Text property of a Label in the Multiline mode.
• Null Value Text
Used to specify the default text that is automatically placed in a label if the label control
is empty.
• Summary
Used to perform calculations (summary, max, min, average, etc.) over a data field. For
more information on calculating summaries, refer to Add Totals to a Report or Group.
Note: Summarisation is possible for a single data column only. To perform calculations with
several data fields, use calculated fields.

• Tag
This property is used to add additional information to the control; for example its Id, by
which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to define a line of static text to be displayed. To type several lines of text, click the
control's Smart Tag, and in the displayed actions list, click Edit Text, or use the Lines
property.
Note: That when a Label is selected in the designer, a user may start typing the text, and it
will be automatically entered into the in-place editor.

© Copyright 2000 to current year. 4:56 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Text.Binding dropdown list, select the required data field. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
• Xlsx Format String
Specifies the native Xlsx format to be imported to the control’s content after the report
is exported to Xlsx.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field, obtained from the data source. To do this, expand the (Data Bindings) property,
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the Label. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://'). Cross-references can be
created within the report by assigning the name of the target control to the
Navigation URL property, and setting the Navigation Target property to ‘_self'. For
more information, refer to Create Hyperlinks.

If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property, and in the Navigation URL.Binding dropdown selector, select the required
data field.

4.4.2 Check Box


The Check Box control is used to indicate True/False or Checked/Unchecked/
Indeterminate states in a report, by displaying a check mark and adjacent text.

© Copyright 2000 to current year. 4:57 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

In the Property Grid, the Check Box control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Check Box.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available in the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for
data-bound Check Boxes located between upper and lower controls, which are able to
resize depending on their contents.
• Keep Together
Specifies whether the contents of a Check Box can be horizontally split across pages.
In other words, if a Check Box occupies more space than remains on the page, this
property specifies whether this Check Box should be split between the current page
and the next, or whether it will be printed entirely on the next page. If a check box does
not fit on the next page either, then the Check Box will be split despite this property's
setting.

© Copyright 2000 to current year. 4:58 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into a Check Box is wrapped to the next
line if it does not fit the line.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Check State, Navigation URL, Tag and Text) to a data field
obtained from the report's data source, and to apply a format string to it. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
• Check State
This property is used to specify the Checked/Unchecked/Indeterminate state of a
Check Box (the Indeterminate state is displayed as a greyed out checked box.) Note
that if only Checked and Unchecked states are to be used, use the Checked property
instead.
• Checked
This property is used to define whether a Check Box is checked or not.
• Tag
This property is used to add additional information to the control; for example its Id, by
which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to define a line of static text to be displayed.
Note: That when a Check Box is selected in the designer, a user may start typing the text,
and it will be automatically entered into the in-place editor.

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and
from the Text.Binding dropdown list, select the required data field. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
• Xlsx Format String
Specifies the native Xlsx format to be imported to the control’s content after the report
is exported to Xlsx.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout

© Copyright 2000 to current year. 4:59 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are intended for the creation of a hierarchical structure within a report
called a document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks a Check Box. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

A crossReport reference within the report can be created by assigning the name of the
target control to the Navigation URL property, and setting the Navigation Target
property to '_self'. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown list, select the required data
field.

4.4.3 Rich Text


The Rich Text control enables users to display, enter, and manipulate formatted text.
The control has functionality similar to the Label control, but formatting can be applied to
any part of the text. The formatting options include font face, font styles and sizes, and font
colour.

Rich text files (RTF) can be loaded to this control via its Smart Tag.

© Copyright 2000 to current year. 4:60 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

In the Property Grid, the Rich Text control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for

© Copyright 2000 to current year. 4:61 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

data-bound controls located between upper and lower controls, which are able to
resize depending on their contents.
Note: That if the Anchor Vertically property is set to Bottom or Both, the Can Grow and
Can Shrink properties (see below) values are ignored, and do not participate in
calculating a final height value of this control.

• Can Grow
When this property is set to Yes, the control's height can be automatically increased, if
required, to fit the text. If there are other controls below the current control, they will be
pushed down to prevent them from overlapping. Note that if a control overlaps the
growing Rich Text by even one pixel, it will not be pushed down by the growing Rich
Text.
• Can Shrink
When this property is set to Yes, and the text does not completely fill a Rich Text, then
the control's height will be decreased to the height of its text. If there are other controls
below the current one, they will be moved up to fill the gap. Note that if a control
overlaps the shrinking Rich Text by even one pixel, it will not be pushed up by the
shrinking Rich Text.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's setting.
• Process Duplicates
Determines the control's behaviour when its data source contains consecutive
repeating records. They can be processed as is (when the property is set to Leave),
suppressed except for the first entry (Suppress) and suppressed with a blank space
printed instead of the repeated records (Suppress and Shrink).
• Process Null Values
Determines whether to process Null (blank) values if they appear in the control's data
source. They can be processed as is (when the property is set to Leave), suppressed
(Suppress) and suppressed with a blank space printed instead of the blank records
(Suppress and Shrink).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL, Rtf and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Lines
Provides access to the Text property of the control, enabling users to input multiple
lines of static text.
• Tag
This property enabling users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.

© Copyright 2000 to current year. 4:62 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and
from the Tag.Binding dropdown list, select the required data field.
• Null Value Text
Used to specify the default text that is automatically placed in a label if the label control
is empty.
• Text
Used to define a line of static text to be displayed. To type several lines of text, use the
Lines property. Note that when the control is selected, the user may start typing the
text, and it will be automatically entered into the in-place editor.

If the current report has a data source, the Rtf property (instead of Text) can be bound
to a data field obtained from the data source. To do this, expand the (Data Bindings)
property and in the Rtf.Binding dropdown menu, select the required data field. For
more information on this, refer to Display Values from a Database (Bind Report
Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report, called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: That a URL should have an appropriate prefix (e.g. 'http://').

Users can create cross references within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
'_self'. For more information, refer to Create Hyperlinks.

© Copyright 2000 to current year. 4:63 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property, and from the Navigation URL.Binding dropdown list, select the required
data field.

4.4.4 Picture Box


The Picture Box control is used to display images in a report. Typically, an image is loaded
from an image file, or from the bound data source. In addition, an image can be loaded from
a web location from a specified URL. The following image formats are supported by the
Picture Box control: BMP, GIF, JPEG, PNG, TIFF, EMF and WMF.

In the Property Grid, the Picture Box control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the control.
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both. The property setting is useful for
data-bound controls located between upper and lower controls, which are able to
resize depending on their contents.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.

© Copyright 2000 to current year. 4:64 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Sizing
Defines the sizing mode of a contained image. The image sizing settings are briefly
described in the following table:

Mode Description
Normal The image is placed in the upper-left corner of the control.
The image is clipped if it is larger than the Picture Box which
contains it.
Stretch Image The image within the control is stretched or shrunk to fit the
size of a Picture Box.
Auto-Size The Picture Box size is adjusted to that of the image it
contains.
Center Image The image is displayed in the center of the control. If the
image is larger than the Picture Box, the outer edges are
clipped.
Zoom Image The image is sized proportionally (without clipping) for best fit
into the control.
Squeeze If the dimensions of a Picture Box exceed that of the image it
contains, the image is centred and shown full-size.
Otherwise, the image is resized to fit into the Picture Box's
dimensions.

• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Image, Image URL, Navigation URL and Tag) to a data field
obtained from the report's data source, and to apply a format string to it. For more
information, refer to Display Values from a Database (Bind Report Elements to Data).
• Image
Specifies an image to display in the Picture Box control.
When the ellipsis is clicked, the Open File window enables the user to specify the file
to load. This image is then embedded into a report and saved within this report, so it is
always available.
Note: Use of this property increases the size of a saved report definition.To save only the
image path, and not the image itself, use the Image URL property instead.

• Image URL
Specifies the URL of the image to display in the Picture Box control. It supports both
absolute and relative paths. A relative path may be related to the Web site or to the
current Web page. In the second case, the path to the image must start with the '~'
symbol. Setting a relative path makes it easier to move the entire application to another
directory on the server without having to update the code.
• Tag
This property is used to add additional information to the control; for example its Id, by
which it can then be accessed by scripts.

© Copyright 2000 to current year. 4:65 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown list, select the required data
field.

4.4.5 Panel
The Panel control is used to group individual report controls.

© Copyright 2000 to current year. 4:66 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

The Panel control is a container used to keep together any number of report controls. When
controls are placed into a Panel, they can be moved, copied and printed as a whole. There
are some limitations on Panel usage. One of them is that the Panel control does not have
the Can Shrink property, and so cannot suppress the white space that appears when the
controls inside are shrunk or collapsed. Also, the Panel cannot be used in different bands,
unlike a cross-band control.
The Panel can also be used for page decoration, e.g. to create borders around the report
elements or add a uniform colour background.
In the Property Grid, the Panel control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control.
• Border Color, Border Dash Style, Border Width and Borders
Specify border settings for the control.
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.

© Copyright 2000 to current year. 4:67 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: If the Anchor Vertically property is set to Bottom or Both, the Can Grow property
setting (see below) is ignored, and is not considered when calculating a final height
value of this control.

• Can Grow
When this property is set to Yes, the control's height can be automatically increased, if
required, to fit the text. If there are other controls below the current control, they will be
pushed down to prevent them from overlapping. That if a control overlaps the growing
Panel by even one pixel, it will not be pushed down by the expanded Panel.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
• Snap Line Padding
Specifies the inner indents to be maintained when report elements are aligned with the
panel’s edges using snap lines.

© Copyright 2000 to current year. 4:68 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

4.4.6 Table
The Table control is used to arrange the report information in a tabular layout.

When a Table control is dropped onto a report's band from the Standard Controls toolbar,
it becomes a table of one row and three columns. If the user clicks and drags over several
bands, the resulting table will be split by the bands into several tables. This enables the
creation of a table header in the header band and the table's body, with one mouse move.

© Copyright 2000 to current year. 4:69 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

A Table control bound to data is created automatically when a data table is dragged and
dropped from the Field List window.
Manage a Table's elements by using its Context Menu.

A Table control consists of Table Row controls, each representing one table row. Each
Table Row consists in turn of Table Cell controls, each representing one table cell. They
can be selected and customised individually (see Table Row and Table Cell).
To select the Table control in the Report Designer, use the Report Explorer or the
dropdown menu of the Property Grid.
In the Property Grid, the Table control's properties are divided into the following groups:

© Copyright 2000 to current year. 4:70 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of Table text. This option is also available on the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of a Table, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.

© Copyright 2000 to current year. 4:71 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Navigation URL, Tag and Text) to a data field obtained from
the report's data source, and to apply a format string to it. For more information, refer to
Display Values from a Database (Bind Report Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.

4.4.7 Table Row


The Table Row control represents a single row within a Table.

This control is used for changing the layout of an entire row. Although in this document, a
Table Row is described as a separate control, most of its properties are actually applied to
the cells contained within the selected row.
In the Property Grid, the Table Row control's properties are divided into the following
groups:

© Copyright 2000 to current year. 4:72 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar.
Behaviour
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the control will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.

© Copyright 2000 to current year. 4:73 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.

4.4.8 Table Cell


The Table Cell control represents an individual cell within a Table.

In general, the Table Cell control's properties are similar to the properties of the Label
control.
In the Property Grid, the Table Cell control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.

© Copyright 2000 to current year. 4:74 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar.
Behaviour
• Angle
Specifies the rotation angle of Table Cell text. The measurement unit is a degree, and
the orientation is anticlockwise. Since standard HTML does not support text orientation,
this parameter is ignored when a report is displayed within a web page.
• Can Grow
When this property is set to Yes, a Table Cell’s height can be automatically increased,
if required, to fit the text. If there are other controls below the current Table Cell, they
will be pushed down to prevent them from overlapping. That if a control overlaps the
growing Table Cell by even one pixel, it will not be pushed down by the expanded
Table Cell.
• Can Shrink
When this property is set to Yes, and the text does not completely fill a Table Cell, then
the Table Cell’s height will be decreased to the height of its text. If there are other
controls below the current Table Cell, they will be moved up to fill the gap. That if a
control overlaps the shrinking Table Cell by even one pixel, it will not be pushed up by
the shrunk Table Cell.
• Keep Together
Specifies whether the contents of a Table Cell can be horizontally split across pages.
In other words, if a Table Cell occupies more space than remains on the page, this
property specifies whether this Table Cell should be split between the current page
and the next, or whether it will be printed entirely on the next page. If it does not fit on
the next page either, then the Table Cell will be split despite this property's setting.
• Multiline
When this property is set to Yes, a Table Cell processes newline characters found in
the text to start a new line. For example, when editing a Table Cell’s text, a new line
can be inserted by pressing ENTER, and in this case, the Multiline property will be
automatically set to Yes.
• Process Duplicates
Determines the control's behaviour when its data source contains consecutive
repeating records. They can be processed as is (when the property is set to Leave),
suppressed except for the first entry (Suppress) and suppressed with blank space
printed instead of the repeated records (Suppress and Shrink).
• Process Null Values
Determines whether to process Null (blank) values if they appear in the control's data
source. They can be processed as is (when the property is set to Leave), suppressed
(Suppress) and suppressed with blank space printed instead of the blank records
(Suppress and Shrink).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.

© Copyright 2000 to current year. 4:75 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Word Wrap
When this property is set to Yes, text entered into the multiline Label is wrapped to the
next line if it does not fit the line or is interrupted by a newline character. If the property
is set to No, text entered into the multiline Label will be displayed on the same line
except where forced onto a new line by a newline character.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of a Table
Cell’s properties (Bookmark, Navigation URL, Tag and Text) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Lines
Provides access to the Text property of a Table Cell in the Multiline mode.
• Null Value Text
Used to specify the default text that is automatically placed in a label if the label control
is empty.
• Summary
Used to perform calculations (summary, max, min, average, etc.) over a data field. For
more information on calculating summaries, refer to Add Totals to a Report or Group.
Note: Summarization is possible for a single data column only. To perform calculations with
several data fields, use calculated fields.

• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to define a line of static text to be displayed. To type several lines of text, click the
control's Smart Tag and in the displayed actions list, click Edit Text, or use the Lines
property.
Note: When a Table Cell is selected in the designer, a user may start typing the text, and it
will be automatically entered into the in-place editor.

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and
from the Text.Binding dropdown list, select the required data field. For more
information on this, refer to Display Values from a Database (Bind Report Elements to
Data).
• Xlsx Format String
Specifies the native Xlsx format to be imported to the control’s content after the report
is exported to Xlsx.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.

© Copyright 2000 to current year. 4:76 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Layout
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
• Width
Specifies the control's width, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks a Table Cell. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross-references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown list, select the required data
field.

4.4.9 Line
The Line control is used for decoration and the visual separation of a report's sections.

In the Property Grid, the Line control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control.
• Border Color, Border Dash Style, Border Width and Borders
Specify border settings for the control.
• Foreground Color
Specifies the Line's colour.
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

© Copyright 2000 to current year. 4:77 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Line Direction
The line can be drawn vertically, horizontally and diagonally across a Line control
rectangle from one corner to the other by selecting from the Vertical, Horizontal, Slant
and Back Slant direction types.
• Line Style
Users can select the solid (the default), dashed, dotted or mixed style for the Line.
• Line Width
Specifies the Line's width, in report measurement units.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this control should be split between the current page and the next, or
whether it will be printed entirely on the next page.
If a control does not fit on the next page either, then the control will be split despite this
property's setting.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of the control's
properties (Bookmark, Navigation URL, Tag and Text) to a data field obtained from
the report's data source, and to apply a format string to it. For more information, refer to
Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer, the
Property Grid and via scripts.

© Copyright 2000 to current year. 4:78 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.

4.4.10 Shape
The Shape control is typically used for adding simple graphics to a report.

In the Property Grid, the Shape control's properties are divided into the following groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Borders
Specifies border settings for the control.
• Fill Color
Specifies the colour to fill the contour of a Shape, if applicable. They are transparent by
default.
• Foreground Color
Determines the colour of a Shape's contour. This option is also available on the
Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Line Width
Used to set the width of the line used to draw a Shape, expressed in the measure units
defined by the report's Measure Units property. For more information, refer to Change
Measurement Units for a Report.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.

© Copyright 2000 to current year. 4:79 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Angle
The value in degrees specifies the rotation angle of a Shape. Rotation is anticlockwise.
A user can hold CTRL while pressing the left mouse button to rotate a Shape within the
control's borders.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Shape
Determines which of the various built-in shapes to use within the control.
A certain shape has its own unique set of properties. The following list is intended to
give a brief overview of these special properties specific to a certain shape:

Property Description Supported by Shapes


Fillet This property specifies how much a Arrows, Polygons, Stars
Shape's corners are rounded. It and Cross
enables display of rounded boxes and
triangles.
Number of Sides This property allows users to set the Polygons
number of sides.
Count of Star Points This property allows users to set the Stars
number of star points.
Concavity Defines the level of inward-curve for Stars
the lines connecting the vertices of a
Star. It may be an integer in the range
of 0 - 100.
Tip's Length This property specifies the length of Bracket and Brace
the Bracket's ends.
Tail's Length This property specifies the tail length Brace
of a Brace.

• Stretch
If a Shape is rotated to some degree (that is, its Angle property is not zero), the
Stretch property may also be used. The Shape image will be stretched to cover
maximum space within the control's borders.
• Visible
Specifies whether or not the control should be printed on report generation.

© Copyright 2000 to current year. 4:80 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

4.4.11 Bar Code


The Bar Code control is used to add bar code into a report.

© Copyright 2000 to current year. 4:81 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: The barcode quality can degrade when the report is exported to formats other than
PDF. To ensure reliable barcode recognition, print the report directly from an
application using the native printing methods.
The Module and Auto-Module properties of a control should be used with care.

In the Property Grid, the Bar Code control's properties are divided into the following
groups.
Appearance
• Alignment
Determines the alignment of the barcode image within the control. To define the text
alignment, use the Text Alignment property.
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Border
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text and image colour for the bar code. This option is also available in the
Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Bar Code.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.

© Copyright 2000 to current year. 4:82 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar. To define the alignment of the barcode image, use the Alignment
property.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Auto-Module
When this property is set to Yes, the Barcode image is stretched to fit the entire
control's width. When this option is set to No, this behaviour is determined by the
Module property.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this Bar Code should be split between the current page and the next,
or whether it will be printed entirely on the next page. If a control does not fit on the next
page either, then the Bar Code will be split despite this property's setting.
• Module
Specifies the width of the narrowest bar or space in the barcode, in report
measurement units. Set this property to Yes for automatic adjustment of its value when
the control is resized.
Note: If the Module property is set too low, the barcode output may be unreadable by a
barcode scanner.

If the Auto-Module property is set to No, the barcode image could be generated with
the setting of Module property is larger than the control itself. In this case, the control
displays a warning, as illustrated below:

Increase the dimensions of the control to resolve this.


• Orientation
The barcode image within the control can be rotated using the Orientation property to
specify one of four possible orientations (Normal, Upside Down, Rotate to the Left and
Rotate to the Right).
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Show Text
Determines whether to display the numerical value, or only the Barcode within the
control.

© Copyright 2000 to current year. 4:83 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Symbology
The Symbology property defines the mapping between Barcode text and an image.
The Bar Code control supports only linear 1D symbologies. They are listed in the
following table:

Symbology Description
Codabar The Codabar is an old format that uses discrete, self-checking
symbology, capable of encoding 16 different characters, plus an
additional 4 start/stop characters. Users should also specify the
Start and Stop Symbols and Wide Narrow Ratio properties.
Code11 Code 11, also known as USD-8, was developed as a high-density
numerical-only symbology. The symbology is discrete, and is able
to encode the numbers 0 through to 9, the dash symbol (-), and
start/stop characters.
Code128 Code 128 has been widely implemented. It is a high-density
symbology which permits encoding messages of arbitrary lengths
of any character of the ASCII character set. The symbology
includes a checksum digit for verification. Users should also specify
the Character Set. The recommended setting is Auto Charset.
Code39 Code 39 is also known as 3 of 9 Code and USD-3. It can encode
uppercase letters (A through Z), digits (0 through 9) and several
special characters like the $ sign. The Calculate a Checksum and
Wide Narrow Ratio (which should be in a range of 2.2 -3) properties
can also be specified.
Code39Extended This is an extension of Code 39, also known as Full ASCII Code 39
. It is capable of encoding all 128 ASCII characters. The Calculate a
Checksum and Wide Narrow Ratio (which should be in a range of
2.2 -3) properties can be specified.
Code93 Code 93 was designed to supplement and improve Code 39. It is
an alphanumeric, variable length symbology, providing higher
reliability and density than Code 39. The Calculate a Checksum
property can be specified.
Code93Extended It enables encoding of all 128 ASCII characters using Code 93's
Full ASCII Mode . This is accomplished by using the ($), (/), (%),
and (+) symbols as shift characters. The Calculate a Checksum
property can be specified.
CodeMSI MSI symbology, also known as Modified Plessey, is a low-density,
numerical only symbology. To specify the checksum, use the MSI
Checksum property. It can be set to None, Modulo 10 and Double
Modulo 10.
DataMatrix Data Matrix ECC200 code is a two-dimensional matrix barcode
consisting of black and while cells arranged in a square or a
rectangular pattern. The encoded information can be text or raw
data.

© Copyright 2000 to current year. 4:84 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Symbology Description
EAN128 UCC/EAN-128 symbology has the newer name GS1-128. It is
based on the Code128 standard, additionally specifying the
Application Identifiers for data sections within the code. It includes
best before dates, batch numbers, quantities, weights and other
attributes. The Character Set property can be specified (Auto
Charset is the recommended value). The FNC1 Functional
Character property defines a symbol that is not included in a bar
code when met in text, but used to generate the application
identifiers. The Human-Readable Text property, when set to Yes,
inserts parentheses into the text below the bar code for better
readability.
EAN13 The EAN-13 barcode contains 13 digits, no letters or other
characters. The first two or three digits represent the country. The
leading zero actually signifies the USA, and UPC-A coding. The last
digit is the checksum digit. The control calculates it automatically
and it should not be present in the control's text string. So, make
sure that the text for this symbology contains no more than 12
digits. If fewer digits are supplied, the string is padded with zeroes
on the left.
EAN8 EAN-8 is a shortened version of the EAN-13 code. It includes a 2 or
3 digit country code, 4 of 5 data digits (depending on the length of
the country code), and a checksum digit. The control calculates the
checksum digit automatically and it should not be present in the
control's text string. So, make sure that the text for this symbology
contains no more than 7 digits. If fewer digits are supplied, the
string is padded with zeroes on the left.
Industrial2of5 The Industrial (or non-interleaved) 2 of 5 code is a numerical, low-
density symbology, based on two-out-of-five code. The Calculate a
Checksum and Wide Narrow Ratio (which should be greater than or
equal to 2.5) properties can be specified.
Intelligent Mail The Intelligent Mail (IM) code is a 65-bar code for use on mail in the
United States. The Intelligent Mail barcode is a height-modulated
barcode that encodes up to 31 decimal digits of mail-piece data into
65 vertical bars.
Interleaved2of5 The Interleaved 2 of 5 code is a higher-density numerical
symbology, based on two-out-of-five code. The Calculate a
Checksum and Wide Narrow Ratio (which should be greater than or
equal to 2.5) properties can be specified.
Matrix2of5 A variant of non-interleaved 2 of 5 code. It is a numerical only
symbology. The Calculate a Checksum and Wide Narrow Ratio
(which should be greater than or equal to 2.5) properties can be
specified.

© Copyright 2000 to current year. 4:85 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Symbology Description
PDF417 This Portable Data File symbology is used in a variety of
applications, and can also be used to generate postage accepted
by the United States Postal Service. It consists of a variable
number of rows, each of which is like a small linear bar code.
Among other options, the Error Correction Level specifies the
amount of redundancy, to protect a barcode's legibility.
PostNet This symbology is used by the United States Postal Service to
assist in directing mail. The code usually contains the zip-code and
delivery point number. Unlike most other barcodes, PostNet
actually encodes data in the height of the bars.
QR Code QR (Quick Response) Code is a popular two-dimensional matrix
barcode that consists of black modules arranged in a square
pattern on a white background.
UPCA The UPC-A barcode contains 12 digits, no letters or other
characters. The first digit is the prefix signifying the product type.
The last digit is the check digit . The check digit is calculated using
the first eleven figures when the barcode is constructed. So, for a
correct UPC-A, make sure that the text contains no more than 11
digits. If there are fewer than 11, the string is padded with zeroes on
the left.
UPCE0 This symbology is a variation of UPC-A which allows for a more
compact barcode by eliminating extra zeros. The first digit is always
zero; the last digit is a checksum digit of the original UPC-A code.
Not every UPC-A code can be transformed into UPC-E0. E.g., the
control's text string 4210000526 is displayed by UPC-E0
symbology as 04252614 and represents the 042100005264 UPC-A
code (check digit included).
UPCE1 This symbology is a variation of UPC-A, which allows for a more
compact barcode by eliminating extra zeros. The first digit is always
1, and the last digit is a checksum digit of the original UPC-A code.
Not every UPC-A code can be transformed into UPC-E1. E.g., the
control's text string 4210000526 is displayed by UPC-E1
symbology as 14252611 and represents the 142100005261 UPC-A
code (check digit included).
UPCSupplemental2 This is a supplemental two-digit barcode. Make sure that the
control's text string contains two digits.
UPCSupplemental5 This is a supplemental five-digit barcode, usually used to indicate
the suggested retail price of a book. Make sure that the control's
text string contains five digits.

• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,

© Copyright 2000 to current year. 4:86 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

refer to Display Values from a Database (Bind Report Elements to Data).


• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to define a string to be encoded as a barcode. Whether or nor this value is
displayed within the control is specified using the Show Text property.
Note: When a control is selected in the designer, the user may start typing the text, and it
will be automatically entered into the in-place editor.

If the content does not conform to the rules of the specified symbology (determined by
the Symbology property), the control may display a warning, as in the picture below, or
automatically correct the input string by padding it with zeroes or only accepting an
acceptable number of characters for display.

If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and in
the Text.Binding dropdown menu, select the required data field. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.

© Copyright 2000 to current year. 4:87 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

4.4.12 Zip Code


The Zip Code control is used to add a zip code a report.

In the Property Grid, the Zip Code control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Border
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text and image colour for the bar code. This option is also available in the
Formatting Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of a Bar Code.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.

© Copyright 2000 to current year. 4:88 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this Zip Code should be split between the current page and the next,
or whether it will be printed entirely on the next page. If the control does not fit on the
next page either, then the Zip Code will be split despite this property's value.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Segment Width
This property setting specifies the width of the lines (in pixels) used to draw the
numbers in the zip boxes of the control.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
• Text
Used to enter the text of the Zip Code. Enter digits and dashes only. Other characters
will not be displayed.
If the current report has a data source, the Text property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property, and in
the Text.Binding dropdown menu, select the required data field. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.

© Copyright 2000 to current year. 4:89 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

4.4.13 Chart
The Chart control is used for data visualisation in reports. It is used to graphically represent
a series of points using 2D or 3D chart types.

There are many built-in Chart view types to choose from, such as Bar, Point, Line, Pie and
Doughnut, Area, Radar and Polar, Range Bar, Gantt, Candle Stick and Stock.

© Copyright 2000 to current year. 4:90 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

A Chart control contains multiple elements (diagram, series, series points, axes, legend,
titles, labels, strips, constant lines, etc.). When any of these elements is selected, the
Property Grid shows only the properties for the selected item. Visual Chart elements which
can be highlighted or selected, are described in Chart with Static Series.
The Chart control is data-aware in a different manner than the other report controls.
Consider three common report scenarios:
• Static data for a Chart's series is provided manually. It can be done using the Series
Collection Editor accessed from the Chart's Series property. It is used to manually
define values and arguments for each series point.
• A Chart's series is created automatically, taking data from the Chart's Data Source
and dependent on the rules defined by the Series Template property. This approach is
described in Chart with Dynamic Series.
• Each series is created and customised manually and each has a separate Data
Source. This approach is described in Chart with Static Series.
A created chart can be customised using both the Property Grid and the Chart Wizard. To
display the Chart Wizard, click a Chart's Smart Tag, and in the displayed actions list, click
the Run Wizard.

The Chart Wizard will guide the user through the process of customising the Chart, from
defining its view type to providing its data and customising its appearance.
In the Property Grid, the Chart's properties are divided into the following groups:
Appearance
• Appearance Name
Used to choose one of the chart appearance options, defining how a Chart's elements
(Diagram, Axes, Legend, etc.) are drawn.
• Background Color
Specifies the background colour for a Chart.
• Background Image
Used to load a background image to a Chart (or define its URL), and also define
whether it should be stretched to fit the entire Chart's area or not.
• Borders, Border Color and Border Width
Specifies border settings for the control.
• Fill Style
Used to specify the fill style of a Chart's background (Empty, Solid, Gradient or Hatch)
and define other fill options if required.

© Copyright 2000 to current year. 4:91 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Image Type
Used to specify whether a Chart should be internally rendered as a metafile in a report
(in which case the quality of the rendered image will be good, but in some cases some
details of the control may be lost), or as a bitmap (in which case the quality of the
rendered image will sometimes be poor, but control will be drawn more precisely).
• Palette Name
Used to choose one of the built-in palettes to be used to draw a Chart's series.
• Palette's Base Color Number
Used to define an integer index determining the base colour for the palette defined by
the Chart's Palette Name property.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• (Data Bindings)
If the current report is bound to data, this property is used to bind some of a Chart's
properties (Bookmark, Navigation URL and Tag) to a data field obtained from the
report's data source, and to apply a format string to it. For more information, refer to
Display Values from a Database (Bind Report Elements to Data).
• Data Adapter
Specifies the data adapter that will populate a Chart's data source assigned using the
Data Source property. It is automatically set to the appropriate value when the Data
Member property is defined. For more information, refer to Chart with Static Series.
• Data Member
Specifies the data source member which supplies data to a Chart. For more
information, refer to Chart with Static Series.
Note: It is not usually necessary to specify the Data Member property when binding a
Chart to data. This property should only be set directly if the data source dataset
contains more than one table.

• Data Source
Determines a Chart's data source. For more information, refer to Chart with Static
Series.
• Series Data Member

© Copyright 2000 to current year. 4:92 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Determines the name of the data field values of which are to be used to automatically
generate and populate a Chart's series. For more information, refer to Chart with
Dynamic Series.
When Chart binding is used to automatically generate series within a chart control
based upon the data obtained from the selected data source (defined by the Data
Source property), a rule must be defined to enable the Chart recognise the data
records values of which are used to construct individual series objects. To do this, the
Series Data Member property, which specifies the data field whose values are taken
into account when series objects are automatically created and populated, can be
used.
Each automatically generated series derives its name from the data field specified by
the Series Data Member property. For example, a name is used to identify a series
within the chart control's legend. The names of all automatically generated series can
be supplemented with the same prefix and suffix defined by settings which are
accessible from the Series Name Template property.
The template settings for the dynamically created series are defined by the specific
properties which are available from Series Template property of a Chart. In particular,
the Argument Data Member and Value Data Members properties specify the data
fields from which the arguments and data values of the series data points are obtained.
Note: If the Series Data Member property is not set for a Chart, the Chart control cannot
automatically generate series even if the Argument Data Member and Value Data
Members properties are defined.

• Series Name Template


Determines the settings used to name data bound series defining the prefix and suffix
texts for the names of series which are dynamically created as a result of binding a
Chart to data (using the Data Source, Series Data Member, Argument Data Member
and Value Data Members properties). The series names, to which these prefixes and
suffixes are added, are derived by each series from the data field defined by the Series
Data Member property. For more information, refer to Chart with Dynamic Series.
Note: The settings available via the Series Name Template property are not applied to the
data bound series which are contained within the Series collection of a Chart.

• Series Sorting
Used to define the sort mode of a Chart's series: None (default), Descending or
Ascending).
• Series Template
Used to customise a template for series which are created dynamically as a result of
binding a Chart to data (via the Data Source and Series Data Member properties).
The settings which are available via the Series Template property are common to all
such data bound series. These settings enable users to provide centralised
customisation of all dynamically created data bound series. For more information refer
to Chart with Dynamic Series.
Note: The settings which are customised using the Series Template property do not apply
to the series contained within the Series collection of a Chart.

• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design

© Copyright 2000 to current year. 4:93 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• (Name)
Determines a control's name, by which it can be accessed in the Property Grid, the
Report Explorer and by scripts.
Elements
• Diagram
Used to customise a Chart's diagram elements: main and secondary axes and panes.
By default, a Chart is displayed in the Default pane, but if necessary, each Chart's
series can be displayed in a separate pane. To do this, click pane's ellipsis to display
the Pane Collection Editor, enabling users to manage and customise panes. Then
select the required series within the Chart and set its View.Pane property to the
required pane.
• Legend
Used to customise a Chart's legend, by defining such properties as text alignment and
antialiasing, font style, background colour or image, border options, markers' size and
visibility, shadow options, etc.
• Series
Displays the Series Collection Editor, used to manage and customise a Chart's
series.
Note: Series which are bound to data at the level of a chart control (in particular, using the
Data Source, Series Data Member and both the Argument Data Member and
Value Data Members properties) are created dynamically, based upon the data
obtained from the specified data source, and they are not presented within the Series
collection. To perform a centralised customisation of such series, use the settings
available from the Series Template property.

• Titles
Displays the Chart Title Collection Editor, used to manage and customise a Chart's
titles.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.

© Copyright 2000 to current year. 4:94 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

4.4.14 Pivot Grid


A Pivot Grid control presents data from a data source in a cross-tabulated form to create a
crosstab report. It calculates summaries and summary totals against specific fields, and
displays the summary values within data cells.
A designer is used to customise the Pivot Grid. It can be displayed using the control's
Smart Tag.

The Pivot Grid displays data in a manner similar to Pivot Tables in Microsoft Excel. Column
headers display unique values from one data field, for example car models. Row headers
display unique values from another field, for example dates. Each cell displays a summary
for the corresponding row and column values. By specifying different data fields, the report
can display, for example, the total number of cars sold on a particular date, or the total
number of deals, etc. In this way, a compact layout for data analysis can be created.
A tutorial on how to use the Pivot Grid control can be found at Cross-Tab Report.
In the Property Grid, the Pivot Grid control's properties are divided into the following
groups:
Appearance
• Appearance
Used to define the appearance properties (such as Background Color, Foreground
Color, Font, etc.) for the Pivot Grid's elements (Cell, Field Value, Filter Separator,
Header Group Line, etc.).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Styles
Used to display the Styles Editor, which is used to manage and customise the
control's styles, which then can be assigned to the Pivot Grid's elements.

© Copyright 2000 to current year. 4:95 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the Pivot Grid, so that after page rendering it
stays attached to the top control, bottom control, or both.
• Keep Together
Specifies whether the contents of the control can be horizontally split across pages. In
other words, if the control occupies more space than remains on the page, this property
specifies whether this Pivot Grid should be split between the current page and the
next, or whether it will be printed entirely on the next page. If a control does not fit on
the next page either, then the Pivot Grid will be split despite this property's setting.
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Data Adapter
Determines the data adapter that will populate the Pivot Grid's data source specified
by the Data Source property. It is automatically set to the appropriate value, when the
Data Member property is defined. For more information, refer to Cross-Tab Report.
• Data Member
Specifies the data source member which supplies data to a Pivot Grid. For more
information, refer to Cross-Tab Report.
Note: It is not usually necessary to specify the Data Member property when binding a
Pivot Grid to data. This property should only be set directly if the dataset contains
more than one table.

• Data Source
Determines a Pivot Grid's data source. For more information, refer to Cross-Tab
Report.
• Fields
Displays the Pivot Grid Field Collection Editor, used to manage and fully customise
a Pivot Grid's fields.
• OLAP Connection String
Specifies a connection string to a cube in an Microsoft Analysis Services database. A
sample connection string is shown below:
OLAPConnectionString='Provider=msolap;Data Source=localhost;Initial
Catalog=Adventure Works DW;Cube Name=Adventure Works;Query Timeout=100;'
A connection string can be built via the Connection String Editor. To display it, click
the ellipsis for the OLAP Connection String property.
To represent information from the bound cube, create specific Pivot Grid fields, and
bind them to the required fields in the data source.
If the OLAP Connection String property is set to a valid string, the value of the Data
Source property is cleared. Setting the Data Source property to a valid object clears
the OLAP Connection String property.
• Prefilter
When this property is expanded in the Property Grid, its Enabled property can be set
to Yes, and the Pivot Grid Prefilter window accessed from the Criteria property.

© Copyright 2000 to current year. 4:96 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

This window enables users to build complex filter criteria with an unlimited number of
filter conditions, combined by logical operators. It provides a set of logical operators
that significantly simplify the process of creating filters for text, numeric and date-time
fields.
Note: The Prefilter property is not supported in OLAP mode.

Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For more information, refer to Add Bookmarks.
Options
• Data Field Options
Used to customise the options which control the presentation of the data fields.
• Data Options
Used to specify whether a Pivot Grid's fields are case sensitive or not.
• Print Options
Used to customise the Print options of a Pivot Grid.
• View Options
Used to customise the Pivot Grid's display options.

4.4.15 Page Info


The Page Info control is used to insert page numbers, current date and time, and the name
of the current user into a report.

In the Property Grid, the Page Info control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Border
Specifies border settings for the control.

© Copyright 2000 to current year. 4:97 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Padding
Specifies indent values which are used to render the contents of the control.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.
• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Format
This property is used to specify the format string for the text displayed in the control.
When the ellipsis button is clicked, the Format String Editor window is displayed, in
which the predefined format can be selected and customise as needed. For more
information, refer to Change Value Formatting of Report Elements.
• Page Information
Used to select the type of information displayed in the control:

Type Description
None Displays an empty control.
Page Number The string, specified by the Format property, is displayed.
The {0} combination in the string is replaced with the current
page number.
Current of Total Page The string, specified by the Format property, is displayed.
Numbers The {0} combination in the string is replaced with the current
page number, the {1} combination - with a total number of
pages in the report. To display the typical Page 1 of 11 text,
use the format string Page {0} of {1}.
Page Number (Roman, The current page number is displayed using Roman
Lowercase) numerals in lowercase.

© Copyright 2000 to current year. 4:98 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Type Description
Page Number (Roman, The current page number is displayed using Roman
Uppercase) numerals in uppercase.
Current Date and Time The string, specified by the Format property, is displayed.
The {0:[format]} combination is replaced with the current
system date and time formatted according to the [format]
string. Use the Format String Editor of the Format property
(see below) to select or construct the proper string.
User Name The name of the current user, which was used to log into the
operating system, is displayed.

• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Start Page Number
Used to set the start number for page numbering.
• Visible
Specifies whether the control should be visible when the report is previewed.
• Word Wrap
When this property is set to Yes, text entered into the control is wrapped to the next line
if it does not fit the line or is interrupted by a newline character. If the property is set to
No, text entered into the control will be displayed on the same line except where forced
onto a new line by a newline character
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Property Grid and by
scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.

© Copyright 2000 to current year. 4:99 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Navigation
• Bookmark and Parent Bookmark
These properties are used to create a hierarchical structure within a report called a
document map. For an explanation and help, refer to Add Bookmarks.
If the current report has a data source, the Bookmark property can be bound to a data
field obtained from the data source. To do this, expand the (Data Bindings) property
and from the Bookmark.Binding dropdown list, select the required data field.
• Navigation URL and Navigation Target
Use the Navigation URL property to specify a URL for web browser navigation when a
user clicks the control. The web browser displays a page in a window or a frame as
specified by the Navigation Target property.
Note: A URL should have an appropriate prefix (e.g. 'http://').

Cross references can be created within the report by assigning the name of the target
control to the Navigation URL property, and setting the Navigation Target property to
_self. For more information, refer to Create Hyperlinks.
If the current report has a data source, the Navigation URL property can be bound to a
data field obtained from the data source. To do this, expand the (Data Bindings)
property and from the Navigation URL.Binding dropdown menu, select the required
data field.

4.4.16 Page Break


The Page Break control is used to insert a page delimiter. It can be placed at any point
within a report.
This control is visually represented by a dashed line, as shown in the image below:

The Page Break control is useful when a user needs to insert a page break between
controls within a band, for example to divide subreports, so that the second subreport starts
printing on a new page.
When a user needs a page break before or after printing a certain band, instead of using the
Page Break control, its Page Break property may be set to Before the Band or After the
Band.
In the Property Grid, the Page Break control's properties are divided into the following
groups:
Appearance
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.

© Copyright 2000 to current year. 4:100 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Behaviour
• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be visible when the report is previewed.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.

4.4.17 Cross-band Line


A Cross-band Line control is used to draw a line through several bands.
This can be useful if it is required to visually emphasise a part of a report that covers
multiple band areas. In other aspects, this control is similar to the Line control.

The Report Designer supports one more cross-band control. Refer to Cross-band Box.
In the Property Grid, the Cross-band Line control's properties are divided into the
following groups:
Appearance
• Foreground Color

© Copyright 2000 to current year. 4:101 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Specifies the colour of the control's line. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Line Style
Used to select the line style: solid (the default), dashed, dotted or mixed.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• End Band
Specifies the band in which the line ends.
• End Point
Specifies the end point of the line (from upper left corner of the band specified by the
End Band property).
• Location
Specifies the control's location, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
• Start Band
Specifies the band in which the line starts.
• Start Point
Specifies the start point of the line (from upper left corner of the band specified by the
Start Band property).
• Width
Specifies the line's width in report measurement units.

4.4.18 Cross-band Box


The Cross-band Box control is used to draw a rectangle through several bands.
This can be useful if it is required to visually emphasise a section that covers multiple band
areas by surrounding it with a rectangle.

© Copyright 2000 to current year. 4:102 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

The Report Designer supports one more cross-band control. Refer to Cross-band Line.
In the Property Grid, the Cross-band Box control's properties are divided into the following
groups:
Appearance
• Border Color, Border Dash Style, Border Width and Border
Specify border settings for the control.
• Formatting Rules
Displays the Formatting Rules Editor used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
Behaviour
• Anchor Vertically
Specifies the vertical anchoring style of the control, so that after page rendering it stays
attached to the top control, bottom control, or both.
• Visible
Specifies whether the control should be visible when the report is previewed.
Data
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• End Band
Specifies the band in which the box ends.

© Copyright 2000 to current year. 4:103 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• End Point
Specifies the end point of the box (from upper left corner of the band specified by the
End Band property).
• Location
Specifies the control's location, in report measurement units.
• Snap Line Margin
Specifies the control’s margins that are maintained when the control is aligned using
snap lines.
• Start Band
Specifies the band in which the box starts.
• Start Point
• Specifies the start point of the box (from upper left corner of the band specified by the
Start Band property).
• Width
Specifies the box's width, in report measurement units.

4.4.19 Subreport
The Subreport control enables users to include other reports in a report. For example,
when creating of master-detail reports (reports with hierarchically linked data).

In the Property Grid, the Subreport control's properties are divided into the following
groups:
Appearance
• Background Color
Specifies the background colour for the control. This option is also available on the
Formatting Toolbar ( ).
• Border Color, Border Dash Style, Border Width and Border
Specifies border settings for the control.
• Font
Specifies the font settings for the control. Some of these settings are available on the
Formatting Toolbar.
• Foreground Color
Specifies the text colour for the control. This option is also available on the Formatting
Toolbar ( ).
• Formatting Rules
Displays the Formatting Rules Editor, used to choose which rules should be applied
to the control during report generation, and define the precedence of the applied rules.
For more information, refer to Conditionally Change a Control's Appearance.
• Style Priority
Used to define the priority of various style elements (such as background colour, border
colour, etc.). For more information on style inheritance, refer to Styles Concepts.

© Copyright 2000 to current year. 4:104 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Styles
This property is used to define odd and even styles for the control, as well as to assign
an existing style to the control (or a newly created one). For more information on style
inheritance, refer to Styles Concepts.
• Text Alignment
Used to change the alignment of the control's text. This option is also available on the
Formatting Toolbar.
Behaviour
• Can Shrink
Determines whether a Subreport's height should be decreased to fit its contents if its
contents do not completely fill the control.
Use this property to specify whether the height of the Subreport control should be
taken into account when generating a report. This may be required, because usually
the mutual location of report controls is considered when generating a report
document. But, as the Subreport control actually represents a report itself, the height
of a Subreport normally should not be taken into account in the generated report
document.
Note: That there is no Can Grow option for the Subreport control, as it always increases
its height to fit its contents.

• Scripts
This property contains events, which can be handled with the scripts. For more
information on scripting, refer to Handle Events via Scripts.
• Visible
Specifies whether the control should be printed on report generation.
• Word Wrap
When this property is set to Yes, text entered into the control is wrapped to the next line
if it does not fit the line or is interrupted by a newline character. If the property is set to
No, text entered into the control will be displayed on the same line except where forced
onto a new line by a newline character
Data
• (Data Bindings)
If the current report is bound to data, this property enables users to bind some of the
control's properties (Bookmark, Navigation URL and Tag) to a data field obtained
from the report's data source, and to apply a format string to it. For more information,
refer to Display Values from a Database (Bind Report Elements to Data).
• Report Source
Specifies the report to be included as a subreport.
If the report classes of the application from which Report Designer was accessed are
compiled into one assembly, then they are available as items in this dropdown menu.
• Report Source Url
Defines an URL of a report definition file (*.REPX), to be used as a report source.
• Tag
This property enables users to add additional information to the control; for example its
Id, by which it can then be accessed by scripts.
If the current report has a data source, the Tag property can be bound to a data field
obtained from the data source. To do this, expand the (Data Bindings) property and
from the Tag.Binding dropdown list, select the required data field.

© Copyright 2000 to current year. 4:105 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Text
Overrides the control’s text property.
Design
• (Name)
Determines a control's name, by which it can be accessed in the Report Explorer,
Property Grid or by scripts.
Layout
• Location
Specifies the control's location, in report measurement units.
• Size
Specifies the control's size, in report measurement units.
The Subreport is not limited by the visible size of the control. The size of its actual
content is taken into account when rendering a subreport on the page.
Note: A Subreport’s width is unlimited and its height is increased to fit its contents.

4.5 Report Wizard


The Report Wizard is a tool that used to easily create reports based on built-in templates.
by editing an existing report created in AVEVE Instrumentation or Electrical.

Note: Note that the initial report layout will be lost after completing the wizard.

To start the Report Wizard, click the report's Smart tag and in the actions list, click Design
in Report Wizard.

© Copyright 2000 to current year. 4:106 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

The Report Wizard provides two different ways to setup a report:


• Standard Report Wizard
Using this wizard, a user can create a banded report displaying data in a tabular
format. While setting up a report using this wizard, a user will be able to group data,
add totals to the report, apply one of the predefined report styles, etc.
• Label Report Wizard
This wizard is useful when labels need to be printed. In this case, it is likely that label
paper that meets particular requirements is to be used. Depending on paper supplier
and label type, the report will need to generate labels with a specific size and location
within paper sheets. With the Label Report Wizard, it will not be necessary to adjust
these settings manually, since the wizard provides a wide choice of paper suppliers
and products. When a paper type is selected the report is adjusted automatically. After
the wizard is completed, an empty report is generated that clearly indicates label
boundaries and positions the labels within the sheets.

4.5.1 Standard Report Wizard


To create a standard report, display the Report Wizard window and choose the Standard
Report option on the Welcome page.

© Copyright 2000 to current year. 4:107 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

After completing the Standard Report Wizard, a tabular banded report will be generated.
Depending on how many wizard steps are completed (not all the pages must be completed),
data grouping can be applied, totals displayed, one of the predefined style sheets can be
selected, etc.
Use the links below to for more information on the steps of the Standard Report Wizard.
• Choose Columns to Display in the Report
• Add Grouping Levels
• Summary Options
• Choose Report Layout
• Choose Report Style
• Enter a Report Title.

• Choose Columns to Display in the Report


Purpose
Choose fields (attributes) whose data will be displayed in the report. The selected fields and
corresponding captions will be automatically added to the report, arranged one under
another.
Page Interface
The list on the left-hand side shows all available fields (attributes). To select the required
fields, double-click them or drag them to the list box on the right-hand side. Another way to
select fields is to use arrow buttons to move them back and forth.

© Copyright 2000 to current year. 4:108 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Note: Move multiple fields may be moved in a single action. To do this, first select them by
clicking while holding CTRL or SHIFT, or by using SHIFT+UP ARROW or
SHIFT+DOWN ARROW shortcuts.

Note: To continue or finish report creation, at least one field must be selected.

Result
To stop the wizard at this step click Finish. In this case, the report will look similar to the
image below.

© Copyright 2000 to current year. 4:109 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

To customise the report further, click Next to proceed to Add Grouping Levels.

• Add Grouping Levels


Purpose
This page is used to group data in a report. For instance, in the case of a report displaying
car sales information, records corresponding to the same model may need to be kept
together. Each set of records with the same model will become a 'group' with its own header.

© Copyright 2000 to current year. 4:110 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Nested grouping and grouping against multiple fields are fully supported.
If grouping is not required, click Next to skip this step.
Page Interface
The list on the left-hand side displays data fields that can be used to group data. To apply
grouping, use one of the following methods:
• Select columns and click right arrow (>).
• Drag required columns to the box on the right-hand side.
• Double-click columns.
Note: Grouping fields on the right-hand side can be selected by clicking them. This is
useful if they need to be removed or their order changed. To accomplish the latter,
use the up arrow ( ) and down arrow ( ) buttons.

Result
To stop the wizard at this step click Finish. In this case, the report will look similar to the
image below:

© Copyright 2000 to current year. 4:111 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

To customise the report further, click Next. If data grouping has been applied on this page,
the next step displayed will be Summary Options. If not, the Summaries step will be skipped
and the next step will be Choose Report Layout.

• Summary Options
Note: This step is only displayed if data grouping has been applied in the previous step
(Add Grouping Levels).

© Copyright 2000 to current year. 4:112 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Purpose
Use this page to specify totals to be displayed for each data group and grand totals for the
entire report. For instance, to display the sum of values in a particular field, the average
value, etc. Specified totals will be displayed after corresponding groups, and in the report
footer.
Page Interface
This page displays all available numerical and date-time fields that are not used to group
data. Use the check box table to specify which functions should be calculated for these
fields.
Some data fields may contain empty values (this is different from, say, zero in a numeric
field). If these values are not to be taken into account when calculating totals, check Ignore
NULL values. Otherwise, these values will be treated as zeros for numeric fields and the
earliest system date for date-time fields.

Result
To stop the wizard on this step click Finish. In this case, the report will look similar to the
image below:

© Copyright 2000 to current year. 4:113 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

To customise a report further, click Next to proceed to Choose Report Layout.

• Choose Report Layout


Purpose
This page sets the layout of elements in a report. If data grouping has not been applied, this
page can be used to specify how data field values are arranged - into a table, one under
another, etc. If report data is grouped, a user can choose one of the available indentation
styles for nested elements.
Additionally, this page can be used to specify the page orientation for a report.
Page Interface
The following options are available if data grouping has been applied:

© Copyright 2000 to current year. 4:114 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If data has not been grouped, the following report layout options will be displayed instead:

To customise a report further, click Next to proceed to Choose Report Style. Otherwise, click
Finish to complete report customization.

• Choose Report Style


Purpose
Apply a predefined style sheet to a report.
Page Interface
Select one of the predefined styles from the list:

© Copyright 2000 to current year. 4:115 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

To customise a report further, click Next to proceed to Enter a Report Title. Otherwise, click
Finish to complete report customization.

• Enter a Report Title


Purpose
Specify the report title.
Page Interface
Enter a title string into the editor and click Finish to complete report creation.

© Copyright 2000 to current year. 4:116 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

© Copyright 2000 to current year. 4:117 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.5.2 Label Report Wizard


To create a label report, display the Report Wizard window and choose the Label Report
option on the Welcome page.

After completing the Label Report Wizard, a blank report will be that generated for labels of
the specified size. The label area will be clearly indicated, so that this area can be populated
with the required content.
Use the links below to learn more about the Label Report Wizard steps:
• Select a Label Type
• Customise Label Options.

• Select a Label Type


Purpose
When stickers or, say, water-proof labels need to be printed out, the appropriate paper must
be used. Every supplier will provide it's own specific label size or label position within a
paper sheet. To make it easier for labels to be produced, this wizard step lists several label
paper suppliers and their products. Once a supplier has been selected and a product (paper
and label type), the report will change its settings so that the labels will be printed exactly in
the required position, without the user having to adjust the label position and size manually.
Page Interface
On this page, select the supplier from the Label Products drop down menu and a particular
product from the Product Number list. The box on the left-hand side will be updated to
display the label dimensions for the selected product.

© Copyright 2000 to current year. 4:118 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

If no further customisation is required, click Finish to complete the report adjustment. If


manual correction of label or paper size is required, click Next. The Customise Label
Options page is displayed.

• Customise Label Options


Purpose
This page is used to manually adjust the settings that were automatically specified in the
previous step, based on the choice of supplier and product.
Page Interface
This page enables free customisation of all parameters specified on the previous page. The
pane on the left-hand side provides a label dimensions preview based on current values.

© Copyright 2000 to current year. 4:119 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Click Finish to complete report setup.

4.6 Preview, Print and Export Reports


Preview and Print a Report
To switch a report to the print preview mode, click the Preview Tab. The report populated
with data and broken down into pages as specified will then be displayed. When in the Print
Preview mode, the report can be printed using the appropriate menu and toolbar
commands.
Export a Report
In the Preview Tab, a user can export a report to files in different formats. The resulting files
can either be saved or sent by e-mail.
The following describe the basics of report exporting and format-specific export options:
• Exporting from Print Preview
• PDF-Specific Export Options
• HTML-Specific Export Options
• MHT-Specific Export Options
• RTF-Specific Export Options
• XLS and XLSX-Specific Export Options
• CSV-Specific Export Options
• TXT-Specific Export Options
• Image-Specific Export Options

© Copyright 2000 to current year. 4:120 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.6.1 Exporting from Print Preview


There are two options available for a document being exported to.
• Export Document to a File on Disk
• Send Exported File via E-Mail
Export Document to a File on Disk
To export a document and save the resulting file on a hard drive, on the toolbar click the
arrow next to the Export Document... button and choose the required format from the list.

Users may then be prompted to define format-specific options. See corresponding help
topics in this documentation for details, e.g. PDF-Specific Export Options.
Once the exporting options have been specified, the Save As dialog appears, enabling
users to enter the file name. The following message will then be displayed.

Click Yes to preview the exported file.


Send Exported File via E-Mail
To send the resulting PDF file via e-mail, on the toolbar click the arrow next to the Send via
E-Mail... button and choose the required format in the list.

© Copyright 2000 to current year. 4:121 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Users may then be prompted to define format-specific options. See corresponding help
topics in this documentation for details, e.g. PDF-Specific Export Options.
Once exporting options have been specified , the Save As dialog appears, enabling users
to enter the file name.
Finally, the created document will be attached to a new empty message, created in the
default mail program.

4.6.2 PDF-Specific Export Options


When exporting a document, define PDF-specific exporting options using the following
dialog.

© Copyright 2000 to current year. 4:122 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

General Options
• Page range
Define the pages which will be included in the complete file. Separate the pages with a
comma, set a range of pages with a dash.
• Don't embed these fonts
Define the fonts that will not be embedded in the complete file, to reduce the file size.
Separate the fonts with a semicolon.
• Images quality
Choose the required document's image quality level. The higher the quality, the bigger
the file, and vice versa.
• Compressed
Check this to enable compression.
• Show print dialog on open
Check this if required.

© Copyright 2000 to current year. 4:123 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

Password Security Options

These options enable users to adjust the security options of the resulting PDF file (e.g.
enable open document, editing, printing and copying protection, and specify which changes
are allowed).
Additional Options
Complete the Application, Author, Keywords, Subject, and Title fields as required.

4.6.3 HTML-Specific Export Options


When exporting a document, define HTML-specific exporting options using the following
dialog.

© Copyright 2000 to current year. 4:124 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Export mode
The following modes are available.
• The Single file mode allows export of a document to a single file, without
preserving the page-by-page breakdown.
• The Single file page-by-page mode allows export of a document to a single file,
while preserving page-by-page breakdown. In this mode, the Page range, Page
border color and Page border width options are available.
• The Different files mode allows export of a document to multiple files, one for each
document page. In this mode, the Page range, Page border color and Page
border width options are available.
• Page range
Specify the pages which will be included in the resulting file. Separate page numbers
with commas; set page ranges using hyphens.
• Page border color
Choose the color for the page border from the available palettes.
• Page border width
Define the page border width.
• Title
Enter the required document title.
• Character set
Define the character set for your HTML document.
• Also, using the appropriate check box, users can choose whether to remove carriage
returns and embed images.

4.6.4 MHT-Specific Export Options


When exporting a document, define MHT-specific exporting options using the following
dialog.

© Copyright 2000 to current year. 4:125 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Export mode
The following modes are available.
• The Single file mode allows export of a document to a single file, without
preserving the page-by-page breakdown.
• The Single file page-by-page mode allows export of a document to a single file,
while preserving page-by-page breakdown. In this mode, the Page range, Page
border color and Page border width options are available.
• The Different files mode allows export of a document to multiple files, one for each
document page. In this mode, the Page range, Page border color and Page
border width options are available.
• Page range
Specify the pages which will be included in the resulting file. Separate page numbers
with commas; set page ranges using hyphens.
• Page border color
Choose the color for the page border from the available palettes.
• Page border width
Define the page border width.
• Title
Enter the required document title.
• Character set
Define the character set for your HTML document.
• Also, using the appropriate check box, users can choose whether to remove carriage
returns.

4.6.5 RTF-Specific Export Options


When exporting a document, define RTF-specific exporting options using the following
dialog.

© Copyright 2000 to current year. 4:126 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Export mode
The following modes are available.
• The Single file mode allows export of a document to a single file, without
preserving the page-by-page breakdown.
• The Single file page-by-page mode allows export of a document to a single file,
while preserving page-by-page breakdown. In this mode, the Page range, Page
border color and Page border width options are available.
• The Different files mode allows export of a document to multiple files, one for each
document page. In this mode, the Page range, Page border color and Page
border width options are available.
• Page range
Specify the pages which will be included in the resulting file. Separate page numbers
with commas; set page ranges using hyphens.
• Also, using the check box, choose whether or not the exported document should
include watermarks.

4.6.6 XLS and XLSX-Specific Export Options


When exporting a document, define XLS and XLSX-specific exporting options using the
following dialog.

• Export mode
Choose one of the available modes to export a document.

© Copyright 2000 to current year. 4:127 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• The Single file mode allows export of a document to a single file, without dividing it
into pages.
• The Single file page-by-page mode (available for XLSX format only) allows export
of a document to a single file, with each shown in a separate sheet.
• The Different files mode allows export of a document to multiple files, one for each
document page.
• Page range
Define the pages which will be included in the result. Separate page numbers with
commas; set page ranges using hyphens.
• Sheet name
Define the sheet name.
• Text export mode
Choose whether value formatting should be converted to the native XLS or XLSX
format string (if it is possible), or embedded into cell values as plain text.
• Show grid lines
Check if it's required to show grid lines in the resulting XLS or XLSX file.
• Export hyperlinks
Check if it is required to export hyperlinks.

4.6.7 CSV-Specific Export Options


When exporting a document, define CSV-specific exporting options using the following
dialog.

• Encoding
Define the encoding used in the exported document.
• Text export mode
Choose whether to use the formatting of the data fields in the bound dataset for the
cells in the exported document. Note that if this property is set to Text, all data fields are
exported to the CSV file as strings, with the corresponding formatting embedded into
those strings.
• Text separator
Define a text separator (comma by default).
• Users can also specify whether to quote strings with separators.

© Copyright 2000 to current year. 4:128 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

4.6.8 TXT-Specific Export Options


When exporting a document, define TXT-specific exporting options using the following
dialog.

• Encoding
Define the encoding used in the exported document.
• Text export mode
Choose whether to use the formatting of the data fields in the bound dataset for the
cells in the exported document. Note that if this property is set to Text, all data fields are
exported to the TXT file as strings, with the corresponding formatting embedded into
those strings.
• Text separator
Define a text separator (TAB by default).
• Users can also specify whether to quote strings with separators.

4.6.9 Image-Specific Export Options


When exporting a document, define image-specific exporting options using the following
dialog.

© Copyright 2000 to current year. 4:129 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide
Reference

• Image format
Choose one from the available image formats to export a document: BMP, EMF, WMF,
GIF, JPEG, PNG or TIFF.
• Resolution (dpi)
Define the required image resolution.
• Export mode
Choose one from the available modes to export a document.
• The Single file mode allows export of a document to a single file, without dividing
the output into pages.
• The Single file page-by-page mode allows export of a document to a single file,
divided into pages. In this mode, the Page range, Page border color and Page
border width options are available.
• The Different files mode allows export of a document to multiple files, one for each
document page. In this mode, the Page range, Page border color and Page border
width options are available.
• Page range
Defines the pages which will be included in the result. Separate page numbers with
commas; set page ranges using hyphens.
• Page border color
Specifies page border color.
• Page border width
Sets page border width.

© Copyright 2000 to current year. 4:130 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide

Index

A MHT-Specific Export Options . . . 4:126


PDF-Specific Export Options . . . . 4:123
Appearance . . . . . . . . . . . . . . . . . . . . . . 4:71 RTF-Specific Export Options . . . . 4:127
Available Controls . . . . . . . . . . . . . . . . . 4:51 TXT-Specific Export Options . . . . 4:130
XLS and XLSX-Specific Export Options
B 4:128

Bar
Status . . . . . . . . . . . . . . . . . . . . . . . 4:19 G
Grid
C Property . . . . . . . . . . . . . . . . . . . . . 4:12
Guide Structure . . . . . . . . . . . . . . . . . . . 1:1
Component Tray . . . . . . . . . . . . . . . . . . . 4:2
Context Menu . . . . . . . . . . . . . . . . . . . . . 4:2
Current Layout before Modification I
Back Up . . . . . . . . . . . . . . . . . . . . . . 2:1 Introduction . . . . . . . . . . . . . . . . . . . . . . 1:1

D L
Database (Bind Report Elements to Data) List
Display Values . . . . . . . . . . . . . . . . . 2:6 Field . . . . . . . . . . . . . . . . . . . . . . . . 4:10
Field List . . . . . . . . . . . . . . . . . . . 2:7
Property Grid . . . . . . . . . . . . . . . 2:9
Smart Tag . . . . . . . . . . . . . . . . . 2:9
M
Menu
E Main . . . . . . . . . . . . . . . . . . . . . . . . 4:13
Miscellaneous . . . . . . . . . . . . . . . . . . . 3:62
Editing Basics Current Row Index
Report . . . . . . . . . . . . . . . . . . . . . . . . 2:1 Show . . . . . . . . . . . . . . . . . . . . 3:65
Explorer Handle Events via Scripts . . . . . . . 3:62
Report . . . . . . . . . . . . . . . . . . . . . . . 4:11 Limit the Number of Records per Page 3:74
Exporting from Print Preview Number of Records in a Report or a Group
CSV-Specific Export Options . . . . 4:129 Count . . . . . . . . . . . . . . . . . . . . 3:67
HTML-Specific Export Options . . . 4:125 Report with no records
Image-Specific Export Options . . . 4:130 Cancel Printing . . . . . . . . . . . . 3:73

© Copyright 2000 to current year. Index page i 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide

N Detail Band . . . . . . . . . . . . . . . . . . 4:33


Appearance . . . . . . . . . . . . . . . 4:34
Navigation . . . . . . . . . . . . . . . . . . . . . . . 3:56 Behaviour . . . . . . . . . . . . . . . . 4:35
Bookmarks Data . . . . . . . . . . . . . . . . . . . . . 4:36
Add . . . . . . . . . . . . . . . . . . . . . . 3:56 Design . . . . . . . . . . . . . . . . . . . 4:36
Define . . . . . . . . . . . . . . . . . . . . 3:56 Layout . . . . . . . . . . . . . . . . . . . 4:36
Cross-Reference Misc . . . . . . . . . . . . . . . . . . . . . 4:36
Add . . . . . . . . . . . . . . . . . . . . . . 3:60 Detail Report Band
Hyperlinks Master-Detail Reports . . . . . . . 4:47
Create . . . . . . . . . . . . . . . . . . . 3:60 Detail Report Band Master-Detail Reports
Appearance . . . . . . . . . . . . . . . 4:48
O Data . . . . . . . . . . . . . . . . . . . . . 4:49
Design . . . . . . . . . . . . . . . . . . . 4:50
Overview . . . . . . . . . . . . . . . . . . . . . . . . 3:62 Misc . . . . . . . . . . . . . . . . . . . . . 4:50
Group Header and Footer . . . . . . . 4:36
P Grouping Bands
Appearance . . . . . . . . . . . . . . . 4:37
Page Info . . . . . . . . . . . . . . . . . . . . . . . . 4:98 Behaviour . . . . . . . . . . . . . . . . 4:38
Page Numbers Data . . . . . . . . . . . . . . . . . . . . . 4:40
Add . . . . . . . . . . . . . . . . . . . . . . . . . 2:25
Design . . . . . . . . . . . . . . . . . . . 4:40
Panel
Layout . . . . . . . . . . . . . . . . . . . 4:40
Design . . . . . . . . . . . . . . . . . . . . . . . 4:5
Page Header and Footer . . . . . . . . 4:43
Group and Sort . . . . . . . . . . . . . . . . . 4:8
Appearance . . . . . . . . . . . 4:43, 4:46
Scripts Errors . . . . . . . . . . . . . . . . . . 4:9
Behaviour . . . . . . . . . . . . 4:45, 4:47
Preview, Print and Export Reports . . . 4:121
Data . . . . . . . . . . . . . . . . . 4:45, 4:47
Export a Report . . . . . . . . . . . . . . 4:121
Design . . . . . . . . . . . . . . . 4:45, 4:47
Exporting from Print Preview . . . . 4:122
Layout . . . . . . . . . . . . . . . 4:45, 4:47
Preview and Print a Report . . . . . 4:121
Misc . . . . . . . . . . . . . . . . . . . . . 4:45
Page Margin Bands . . . . . . . . . . . . 4:45
R Report Header and Footer . . . . . . . 4:40
Appearance . . . . . . . . . . . . . . . 4:41
Reference . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Behaviour . . . . . . . . . . . . . . . . 4:42
Report
Data . . . . . . . . . . . . . . . . . . . . . 4:43
Add Information . . . . . . . . . . . . . . . . 2:4
Design . . . . . . . . . . . . . . . . . . . 4:43
Add Totals . . . . . . . . . . . . . . . . . . . 2:20
Layout . . . . . . . . . . . . . . . . . . . 4:43
Calculated Fields
Report Controls . . . . . . . . . . . . . . . . . . 4:50
Add . . . . . . . . . . . . . . . . . . . . . . 2:28
Add Controls . . . . . . . . . . . . . . . . . 4:51
Change Element Layout . . . . . . . . . . 2:3
Bar Code . . . . . . . . . . . . . . . . . . . . 4:81
Change or Apply Data Filtering . . . 2:15
Appearance . . . . . . . . . . . . . . . 4:82
Change or Apply Data Grouping . . 2:17
Behaviour . . . . . . . . . . . . . . . . 4:83
Change or Apply Data Sorting . . . . 2:13
Data . . . . . . . . . . . . . . . . . . . . . 4:86
Page Numbers and System Information
Design . . . . . . . . . . . . . . . . . . . 4:87
Add . . . . . . . . . . . . . . . . . . . . . . 2:25
Chart . . . . . . . . . . . . . . . . . . . . . . . 4:90
User Name, Add . . . . . . . . . . . 2:27
Appearance . . . . . . . . . . . . . . . 4:92
Parameters
Behaviour . . . . . . . . . . . . . . . . 4:93
Add . . . . . . . . . . . . . . . . . . . . . . 2:31
Data . . . . . . . . . . . . . . . . . . . . . 4:93
Static Information
Elements . . . . . . . . . . . . . . . . . 4:94
Add or Modify . . . . . . . . . . . . . . . 2:3
Layout . . . . . . . . . . . . . . . . . . . 4:95
Watermarks
Navigation . . . . . . . . . . . . . . . . 4:95
Create or Modify . . . . . . . . . . . 2:23
Check Box . . . . . . . . . . . . . . . . . . . 4:57
Report Bands . . . . . . . . . . . . . . . . . . . . 4:31
Appearance . . . . . . . . . . . . . . . 4:58
Band Types . . . . . . . . . . . . . . . . . . 4:33
Behaviour . . . . . . . . . . . . . . . . 4:58
Bands
Data . . . . . . . . . . . . . . . . . . . . . 4:59
Manage . . . . . . . . . . . . . . . . . . 4:31
Design . . . . . . . . . . . . . . . . . . . 4:59

© Copyright 2000 to current year. Index page ii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide

Layout . . . . . . . . . . . . . . . . . . . 4:59 Layout . . . . . . . . . . . . . . . . . . . 4:97


Navigation . . . . . . . . . . . . . . . . 4:60 Navigation . . . . . . . . . . . . . . . . 4:98
Cross-band Box . . . . . . . . . . . . . . 4:103 Options . . . . . . . . . . . . . . . . . . 4:98
Appearance . . . . . . . . . . . . . . 4:104 Rich Text . . . . . . . . . . . . . . . . . . . . 4:60
Behaviour . . . . . . . . . . . . . . . . 4:104 Appearance . . . . . . . . . . . . . . . 4:61
Data . . . . . . . . . . . . . . . . . . . . 4:104 Behaviour . . . . . . . . . . . . 4:61, 4:64
Design . . . . . . . . . . . . . . . . . . 4:104 Data . . . . . . . . . . . . . . . . . . . . . 4:62
Layout . . . . . . . . . . . . . . . . . . 4:104 Design . . . . . . . . . . . . . . . . . . . 4:63
Cross-band Line . . . . . . . . . . . . . . 4:102 Layout . . . . . . . . . . . . . . . . . . . 4:63
Appearance . . . . . . . . . . . . . . 4:102 Navigation . . . . . . . . . . . . . . . . 4:63
Behaviour . . . . . . . . . . . . . . . . 4:102 Shape . . . . . . . . . . . . . . . . . . . . . . 4:79
Data . . . . . . . . . . . . . . . . . . . . 4:103 Appearance . . . . . . . . . . . . . . . 4:79
Design . . . . . . . . . . . . . . . . . . 4:103 Behaviour . . . . . . . . . . . . . . . . 4:80
Layout . . . . . . . . . . . . . . . . . . 4:103 Subreport . . . . . . . . . . . . . . . . . . . 4:105
Label . . . . . . . . . . . . . . . . . . . . . . . . 4:54 Appearance . . . . . . . . . . . . . . 4:105
Appearance . . . . . . . . . . . . . . . 4:54 Behaviour . . . . . . . . . . . . . . . 4:106
Behaviour . . . . . . . . . . . . . . . . . 4:55 Data . . . . . . . . . . . . . . . . . . . . 4:106
Data . . . . . . . . . . . . . . . . . . . . . 4:56 Design . . . . . . . . . . . . . . . . . . 4:107
Design . . . . . . . . . . . . . . . . . . . 4:57 Layout . . . . . . . . . . . . . . . . . . 4:107
Layout . . . . . . . . . . . . . . . . . . . 4:57 Table . . . . . . . . . . . . . . . . . . . . . . . 4:69
Navigation . . . . . . . . . . . . . . . . 4:57 Appearance . . . . . . . . . . . . . . . 4:71
Line . . . . . . . . . . . . . . . . . . . . . . . . . 4:77 Behaviour . . . . . . . . . . . . . . . . 4:71
Appearance . . . . . . . . . . . . . . . 4:77 Data . . . . . . . . . . . . . . . . . 4:71, 4:73
Behaviour . . . . . . . . . . . . . . . . . 4:78 Table Cell . . . . . . . . . . . . . . . . . . . . 4:74
Data . . . . . . . . . . . . . . . . 4:78, 4:81 Appearance . . . . . . . . . . . . . . . 4:74
Layout . . . . . . . . . . . . . . . . . . . 4:79 Behaviour . . . . . . . . . . . . . . . . 4:75
Page Break . . . . . . . . . . . . . . . . . . 4:101 Data . . . . . . . . . . . . . . . . . . . . . 4:76
Appearance . . . . . . . . . . . . . . 4:101 Design . . . . . . . . . . . . . . . . . . . 4:76
Behaviour . . . . . . . . . . . . . . . . 4:101 Layout . . . . . . . . . . . . . . . . . . . 4:77
Design . . . . . . . . . . . . . . . . . . 4:101 Navigation . . . . . . . . . . . . 4:72, 4:77
Layout . . . . . . . . . . . . . . . . . . 4:102 Table Row . . . . . . . . . . . . . . . . . . . 4:72
Page Info Appearance . . . . . . . . . . . . . . . 4:73
Appearance . . . . . . . . . . . . . . . 4:98 Behaviour . . . . . . . . . . . . . . . . 4:73
Behaviour . . . . . . . . . . . . . . . . . 4:99 Useful Key Combinations . . . . . . . 4:53
Data . . . . . . . . . . . . . . . . . . . . 4:100 Zip Code . . . . . . . . . . . . . . . . . . . . 4:88
Panel . . . . . . . . . . . . . . . . . . . . . . . 4:66 Appearance . . . . . . . . . . . . . . . 4:88
Appearance . . . . . . . . . . . . . . . 4:67 Behaviour . . . . . . . . . . . . . . . . 4:89
Behaviour . . . . . . . . . . . . . . . . . 4:67 Data . . . . . . . . . . . . . . . . . . . . . 4:89
Data . . . . . . . . . . . . . . . . . . . . . 4:68 Design . . . . . . . . . 4:90, 4:94, 4:100
Design .4:68, 4:72, 4:74, 4:78, 4:81 Report Element
Layout 4:68, 4:72, 4:74, 4:81, 4:87, Delete . . . . . . . . . . . . . . . . . . . . . . . 2:5
4:90, 4:100 Report Elements
Navigation 4:69, 4:81, 4:88, 4:90, 4:100 Change Fonts and Colours . . . . . . 2:12
Picture Box . . . . . . . . . . . . . . . . . . . 4:64 Change Value Formatting . . . . . . . 2:11
Appearance . . . . . . . . . . . . . . . 4:64 Use Mail Merge . . . . . . . . . . . . . . . 2:10
Data . . . . . . . . . . . . . . . . . . . . . 4:65 Report Output
Design . . . . . . . . . . . . . . . . . . . 4:66 Manually Update . . . . . . . . . . . . . . . 2:2
Layout . . . . . . . . . . . . . . . . . . . 4:66 Report Settings . . . . . . . . . . . . . . . . . . 4:20
Navigation . . . . . . . . . . . . . . . . 4:66 Appearance . . . . . . . . . . . . . . . . . . 4:22
Pivot Grid . . . . . . . . . . . . . . . . . . . . 4:95 Behaviour . . . . . . . . . . . . . . . . . . . . 4:24
Appearance . . . . . . . . . . . . . . . 4:96 Data . . . . . . . . . . . . . . . . . . . . . . . . 4:25
Behaviour . . . . . . . . . . . . . . . . . 4:96 Design . . . . . . . . . . . . . . . . . . . . . . 4:26
Data . . . . . . . . . . . . . . . . . . . . . 4:97 Misc . . . . . . . . . . . . . . . . . . . . . . . . 4:30
Design . . . . . . . . . . . . . . . . . . . 4:97 Navigation . . . . . . . . . . . . . . . . . . . 4:28

© Copyright 2000 to current year. Index page iii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Report Designer User Guide

Page Settings . . . . . . . . . . . . . . . . . 4:28 Pivot grid and bind it to data, create


Parameters . . . . . . . . . . . . . . . . . . . 4:29 3:23
Printing . . . . . . . . . . . . . . . . . . . . . . 4:29 Label . . . . . . . . . . . . . . . . . . . . . . . 3:17
Report Wizard . . . . . . . . . . . . . . . . . . . 4:107 Master-Detail Report (Detail Report Bands)
Label Report Wizard . . . . . . . . . . . 4:119 3:19
Customise Label Options . . . . 4:120 Measurement Units for a Report
Customise Label Options, Page Inter- Change . . . . . . . . . . . . . . . . . . . 3:1
face . . . . . . . . . . . . . . 4:120 Multi-Column . . . . . . . . . . . . . . . . . 3:21
Customise Label Options, Purpose Page Settings for a Report
4:120 Change . . . . . . . . . . . . . . . . . . . 3:2
Label Type . . . . . . . . . . . . . . . 4:119 Parameterised . . . . . . . . . . . . . . . . 3:26
Label Type, Page Interface . . 4:119 Report to Data
Label Type, Purpose . . . . . . . 4:119 Bind . . . . . . . . . . . . . . . . . . . . . . 3:6
Standard . . . . . . . . . . . . . . . . . . . . 4:108 Static . . . . . . . . . . . . . . . . . . . . . . . 3:13
Columns to Display in Report 4:109 Table . . . . . . . . . . . . . . . . . . . . . . . 3:16
Columns to Display in Report, Page In- Types . . . . . . . . . . . . . . . . . . . . . . . 3:13
terface . . . . . . . . . . . . 4:109
Columns to Display in Report, Purpose S
4:109
Columns to Display in Report, Result Static Information
4:110 Change . . . . . . . . . . . . . . . . . . . . . . 2:4
Grouping Levels Add . . . . . . . 4:111 Styles and Conditional Formatting . . . . 3:36
Grouping Levels Add, Page Interface Change a Control’s Appearance
4:112 Conditionally . . . . . . . . . . . . . . 3:48
Grouping Levels Add, Purpose 4:111 Change a Label’s Text
Grouping Levels Add, Result . 4:112 Conditionally . . . . . . . . . . . . . . 3:54
Report Layout . . . . . . . . . . . . 4:115 Hide Bands
Report Layout, Page Interface 4:115 Conditionally . . . . . . . . . . . . . . 3:51
Report Layout, Purpose . . . . . 4:115 Odd and Even Styles . . . . . . . . . . . 3:41
Report Style . . . . . . . . . . . . . . 4:116 Store and Restore Style Sheets . . 3:45
Report Style, Page Interface . 4:116 Styles Concepts . . . . . . . . . . . . . . . 3:36
Report Style, Purpose . . . . . . 4:116 System Date and Time
Report Title . . . . . . . . . . . . . . 4:117 Add . . . . . . . . . . . . . . . . . . . . . . . . 2:26
Report Title, Page Interface . . 4:117
Report Title, Purpose . . . . . . . 4:117 T
Summary Options . . . . . . . . . 4:113
Summary Options, Page Interface . Tab
4:114 Designer . . . . . . . . . . . . . . . . . . . . . 4:6
Summary Options, Purpose . . 4:114 HTML View . . . . . . . . . . . . . . . . . . . 4:8
Summary Options, Result . . . 4:114 Preview . . . . . . . . . . . . . . . . . . . . . . 4:7
Reports Scripts . . . . . . . . . . . . . . . . . . . . . . . 4:8
Basic Operations . . . . . . . . . . . . . . . 3:1 Tag
Chart Smart . . . . . . . . . . . . . . . . . . . . . . . 4:17
Dynamic Series . . . . . . . . . . . . 3:32 Toolbar
Static Series . . . . . . . . . . . . . . . 3:28 Formatting . . . . . . . . . . . . . . . . . . . 4:15
Chart Dynamic Series Layout . . . . . . . . . . . . . . . . . . . . . . 4:16
Chart and bind it to data, create 3:33 Main . . . . . . . . . . . . . . . . . . . . . . . . 4:14
Customise . . . . . . . . . . . . . . . . 3:35 Standard Controls . . . . . . . . . . . . . . 4:3
Result . . . . . . . . . . . . . . . . . . . . 3:36 Zoom . . . . . . . . . . . . . . . . . . . . . . . 4:16
Specify series data member and adjust
a series template . . . . . 3:34 U
Control Positioning . . . . . . . . . . . . . 3:10
Create . . . . . . . . . . . . . . . . . . . . . . . . 3:1 User Interface . . . . . . . . . . . . . . . . . . . . . 4:1
Cross-Tab . . . . . . . . . . . . . . . . . . . . 3:23

© Copyright 2000 to current year. Index page iv 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.

You might also like