ActiveReports 13
Banded List
ActiveReports 13 > ActiveReports User Guide > Concepts > Page Report/RDL Report Concepts > Toolbox > Banded List

The BandedList data region is a collection of free-form bands. By default, it is composed of three bands: a header, a footer and a detail band. Bound report controls in the detail band repeat for every row of data. The header and footer rows render once at the beginning and end of the BandedList, respectively, and are a good place for titles and grand totals.

Click inside each band to reveal its properties in the Properties window, or click the four-way arrow to select the entire data region and reveal its properties. Properties for this data region include the following.

Band Properties

Property Description
CanGrow Change to True to allow the data region to grow vertically to accommodate data.
CanShrink Change to True to allow the data region to shrink if there is not enough data to fill it.
KeepTogether Change to True to have ActiveReports attempt to keep all of the data in the band together on one page.
PageBreakAtEnd Change to True to insert a page break after rendering all of the data in the band.
PageBreakAtStart Change to True to insert a page break before rendering any of the data in the band.
RepeatOnNewPage With header and footer bands, repeats the band on every page when the related details span multiple pages.

BandedList Properties

Property Description
DataSetName Select the dataset to use in the data region.
DataSetParameters Specify the parameters for the data set.
KeepTogether Change to True to have ActiveReports attempt to keep all of the data in the data region together on one page.
NewSection Change to True to render the data region in a new section.
OverflowName Select the name of the OverflowPlaceHolder control in which to render data that exceeds the allowed space for the data region on the first page of the report.

You can add group header and group footer bands. Report controls in these bands repeat once for each group instance. You can also nest groups, plus, in RDL reports, you can nest other data regions in any header or footer band. Grouping in the BandedList is similar to grouping in the Table data region. You can provide a grouping expression for each group, and also sort the groups.

Caution: You cannot sort the detail data in a BandedList, so any sorting of this type must be done at the query level.

BandedList Dialog

Properties for the BandedList data region are available in the BandedList dialog. To open it, with the BandedList selected on the report, under the Properties Window, click the Property dialog link.

The BandedList dialog lets you set properties on the data region with the following pages.

Note: You can click <Expression...> in many of these properties to open the Expression Editor where you can create an expression to determine the value.

General

Name: Enter a name for the banded list that is unique within the report. You can only use underscore (_) as a special character in the Name field. Other special characters such as period (.), space ( ), forward slash (/), back slash (\), exclamation (!), and hyphen (-) are not supported.

Tooltip: Enter the value or expression you want to appear when a user hovers the cursor over the banded list in the viewer at run time.

Dataset name: Select a dataset to associate with the banded list. The combo box is populated with all of the datasets in the report's dataset collection.

Has own page numbering: Select to indicate whether this banded list is in its own section with regards to pagination.

Page Breaks: Select any of the following options to apply to each instance of the banded list.

Header and Footer: Select any of the following options.

Visibility

By default, the banded list is visible when the report runs, but you can hide it, hide it only when certain conditions are met, or toggle its visibility with another report control.

Initial visibility

Visibility can be toggled by another report control: Select this check box to display a toggle image next to another report control. This enables the drop-down box below where you can specify the TextBox control that toggles the visibility of the BandedList. The user can click the toggle item to show or hide this BandedList.

Navigation

Document map label: Enter an expression to use as a label to represent this item in the table of contents (document map).

Bookmark ID: Enter an expression to use as a locator for this BandedList. You will then be able to provide a bookmark link to this item from another report control using a Jump to bookmark action.

Groups

Click the plus sign button to add a new group to the BandedList, and delete them using the X button. Once you add one or more groups, you can reorder them using the arrow buttons, and set up information for each group on the following tabs.

General

Name: Enter a name for the group that is unique within the report. This property cannot be set until after a Group on expression is supplied.

Group on: Enter an expression to use for grouping the data.

Document map label: Enter an expression to use as a label to represent this item in the table of contents (document map).

Parent group: For use in recursive hierarchies. Enter an expression to use as the parent group.

Filters

You need to provide three values to add a new filter to the collection: Expression, Operator, and Value.

Expression: Enter the expression to use for evaluating whether data should be included in the group.

Operator: Select from the following operators to decide how to compare the expression to the left with the value to the right.

  • Equal Only choose data for which the value on the left is equal to the value on the right.
  • Like Only choose data for which the value on the left is similar to the value on the right.
    For more information on using the Like operator, see the MSDN Web site.
  • NotEqual Only choose data for which the value on the left is not equal to the value on the right.
  • GreaterThan Only choose data for which the value on the left is greater than the value on the right.
  • GreaterThanOrEqual Only choose data for which the value on the left is greater than or equal to the value on the right.
  • LessThan Only choose data for which the value on the left is less than the value on the right.
  • LessThanOrEqual Only choose data for which the value on the left is less than or equal to the value on the right.
  • TopN Only choose items from the value on the left which are the top number specified in the value on the right.
  • BottomN Only choose items from the value on the left which are the bottom number specified in the value on the right.
  • TopPercent Only choose items from the value on the left which are the top percent specified in the value on the right.
  • BottomPercent Only choose items from the value on the left which are the bottom percent specified in the value on the right.
  • In Only choose items from the value on the left which are in the array of values specified on the right.
    Selecting this operator enables the Values list at the bottom.
  • Between Only choose items from the value on the left which fall between the pair of values you specify on the right. Selecting this operator enables two Value boxes instead of one.

Value: Enter a value to compare with the expression on the left based on the selected operator. For multiple values used with the Between operator, the lower two value boxes are enabled.

Values: When you choose the In operator, you can enter as many values as you need in this list.

Sorting

Click the plus sign button to enter new sort expressions, and remove them using the X button.

Expression: Enter an expression by which to sort the data in the group.

Direction: Select Ascending or Descending.

Visibility

By default, the group is visible when the report runs, but you can hide a group, hide it when certain conditions are met, or toggle its visibility with another report control.

Initial visibility

  • Visible: The group is visible when the report runs.
  • Hidden: The group is hidden when the report runs.
  • Expression: Use an expression with a Boolean result to decide whether the group is visible. True for hidden, False for visible.

Visibility can be toggled by another report control: Select this check box to display a toggle image next to another report item. The user can click the toggle item to show or hide this band group. This enables the drop-down list where you can select the report control that users can click to show or hide this group.

Data Output

Element name: Enter a name to be used in the XML output for this group.

Collection: Enter a name to be used in the XML output for the collection of all instances of this group.

Output: Choose Yes or No to decide whether to include this group in the XML output.

Layout

Page break at start: Inserts a page break before the group.

Page break at end: Inserts a page break after the group.

Include group header: Adds a group header band (selected by default).

Include group footer: Adds a group footer band (selected by default).

Repeat group header: Repeats the group header band on each page.

Repeat group footer: Repeats the group footer band on each page.

Has own page numbering: Used in conjunction with the "Page Number in Section" and "Total Pages in Section" properties, tells the report that the group constitutes a new page numbering section.

Filters

You need to provide three values to add a new filter to the collection: Expression, Operator, and Value.

Expression: Enter the expression to use for evaluating whether data should be included in the group.

Operator: Select from the following operators to decide how to compare the expression to the left with the value to the right.

Value: Enter a value to compare with the expression on the left based on the selected operator. For multiple values used with the Between operator, the lower two value boxes are enabled.

Values: When you choose the In operator, you can enter as many values as you need in this list.

Data Output

The Data Output page of the BandedList dialog allows you to control the following properties when you export to XML.

See Also

How To