[]
        
(Showing Draft Content)

Banded List

In Wyn Enterprise, Banded List is a collection of free-form bands where you can place other report controls. By default, the Banded List consists of three bands: a header, a footer, and a details band. You can add multiple numbers of bands to the Banded List.

A report control bound to the Banded List in the details band repeats itself for every row of data. The header and footer bands render data once at the beginning and end of the Banded List. The header and footer are used to place details such as titles and grand totals.


In this help article, you will find information on the following:

Structure

The Banded List control is described below,

Banded list structure

  • Header Band: The Header band appears at the beginning of the banded list. The Header band is generally used to display the title or logo on top of the report.

  • Details Band: The Details band appears in the middle of the banded list and repeats for each dataset record bound to the banded list. For example, when using the employee details in the banded list, the details band can display the name, title, email, phone number, and photo of each employee.

  • Footer Band: The Footer band appears at the end of the banded list. You can use the Footer band to display summary items like the grand total.

To add a Banded List control to a report, navigate to the Report Designer and follow the below instructions:

  1. Drag and drop the Banded List control onto the design area from the Designer Toolbar.

    Drag and drop banded list control on design area

  2. Using the Inspector Panel on the right side of your screen, customize the appearance of the Banded List control. See the Inspector Panel Properties section for more information on the properties of the Banded List control. You can also customize the properties of the Header, Details, and Footer bands using the Inspector Panel.

    Inspector Panel properties of Banded List

  3. In the below example, a Banded List is created for a product order summary. The header band has a textbox with a static value, Products, the details band has a table with Product ID, Product Name, and Units Ordered, and the footer band has the sum of total units ordered.

  • The banded list control on the report designer area is shown in the below image:

    Banded list on the report designer area

  • On preview, the banded list appears in the report as shown in the below image:

    Banded list on previewing the report

Grouping

Adding Groups

With the Banded List control, you can group the Details band. Use one of the following two methods to add groups to a banded list:

  • From the Groups editor, right-click on the option and select the Group >> Insert Group option from the context menu. Or,

    Right click on group editor to add a group

  • Drag and drop a field you wish to group by from the Data Panel onto the Group Editor.

    Drag and drop a field to add it as group

Group Configuration Settings

You can customize the name, group expressions, and other details of the groups by clicking the group and using the Inspector Panel. The Inspector Panel properties of a group are described in the below tables:

Inspector Panel properties of Groups in Banded List

Group

Property

Description

Name

Add a unique name to the group. Special characters such as period (.), space ( ), forward slash (/), backslash (\), exclamation marks (!), and hyphens (-) are not supported. You can use an underscore (_) in the name of the group.

Group Expressions

Enter a value or expression for the groups. Group Expressions are a collection of bound field references or advanced expressions. Distinct values of the group expressions generate optional group headers, details, and footer bands.

Page Break

Select a page break option (None, Start, End, StartAndEnd, or Between) for group instances.

Filters

Add filters to filter out the data from the report. See the Filter Data help article for more information.

Layout

Property

Description

Prevent Orphaned Header

To move the orphaned group headers to the next page, set the Prevent Orphaned Header option to True. By default, this option is set to False.

Prevent Orphaned Footer

To move the last Details band to appear on the next page with the orphaned group footer, set the Prevent Orphaned Footer setting to True. By default, this property is set to False.

Data

Property

Description

Sort Expressions

Set a sort expression using this property. See the Sort Data help article for more information.

Insert Parent or Child Groups

In a Banded List, you can arrange the data in nested groups. To insert a child group,

  • Right-click the parent group name in the Group Editor and select the Group >> Insert Group option from the context menu. Or,

    Right click on parent group to add child group

  • Drag and drop a field from the Data Panel onto the Group Editor. A new group will be added to the Group editor with the existing groups.

    Drag and drop a field to insert child group

Delete a Group

To delete or remove a group from the Banded List control, right click on the group name in the Group editor and click the Delete option from the context menu.

Delete a group from banded list

Inspector Panel Properties

BANDED LIST

Common

Property

Description

Name

Add a unique name to the Banded List control. Special characters such as period (.), space ( ), forward slash (/), backslash (\), exclamation marks (!), and hyphens (-) are not supported. You can use an underscore (_) in the name of the control.

Data

Property

Description

Data Set Name

Select a dataset from the dropdown to bind the data to the Banded List control.

Data Set Parameters

Add parameters to the dataset using the + button. Dataset parameters can be values or expressions.

Filters

Add filters to filter out the data from the report. See the Filter Data help article for more information.

Dimensions

Property

Description

Left

Set the left margin of the Banded List control.

Top

Set the top margin of the Banded List control.

Width

Set the width of the Banded List control.

Height

Set the height of the Banded List control.

Layout

Property

Description

Page Break

Select a page break option (None, Start, End, StartAndEnd, or Between) generated by banded list instances.

New Page

Select an option to start the content after a page break. The available options are Next, Odd, and Even.

Prevent Orphaned Header

To display the orphaned header on the next page, set this flag to True. By default, this flag is set to False.

Prevent Orphaned Footer

To display the orphaned footer on the next page, set this flag to True. By default, this flag is set to False.

Dimensions

Property

Description

Height

Enter the height of the header band.

Layout

Property

Description

Repeat on New Page

To repeat the header band on every page, set the Repeat on New Page flag to True. By default, this property is set to False.

Can Grow

To disable the data region to grow verticallyset this flag to False. By default, this option is set to True.

Can Shrink

To enable the data region to shrink when the data is not enough, set this flag to True. By default, this option is set to False.

Page Break

Select a page break option (None, Start, End, StartAndEnd, or Between) for the Header band.

Inspector Panel properties of Header band

DETAILS

Dimensions

Property

Description

Height

Enter the height of the details band.

Layout

Property

Description

Can Grow

To disable the data region to grow vertically, set this flag to False. By default, this option is set to True.

Can Shrink

To enable the data region to shrink when the data is not enough, set this flag to True. By default, this option is set to False.

Page Break

Select a page break option (None, Start, End, StartAndEnd, or Between) for the Details band.

Inspector Panel properties of Header band

Dimensions

Property

Description

Height

Enter the height of the footer band.

Layout

Property

Description

Print at Bottom

To print the footer band at the bottom of the page, set this option to True. By default, this option is set to False.

Repeat on New Page

To repeat the footer band on every page, set the Repeat on New Page flag to True. By default, this property is set to False.

Can Grow

To disable the data region to grow vertically set this flag to False. By default, this option is set to True.

Can Shrink

To enable the data region to shrink when the data is not enough, set this flag to True. By default, this option is set to False.

Page Break

Select a page break option (None, Start, End, StartAndEnd, or Between) for the Footer band.

Inspector Panel properties of Header band