Report Properties

Description

The report level configuration sets the parent configuration for all items in the report. All report items inherit their configuration from what is set at the report level. For more information see Configure Controls.

The report can be selected either by selecting the report item from the Report Items List, or by clicking outside the layout in the design area.

The Properties panel is organized as follows:

At the bottom of this page you will also find the Related Tutorials section. This section documents those tutorials related to the use of any of the properties at the report level.

Actions

Data Source

Defines the data connection for the report. If the report has been created using the Layer Report Wizard, this property is populated with the data source defined in the wizard. The report data source can be viewed by opening the Field List.

The data source name can be edited by selecting the data source from the Report Items List.

Data Member

Specifies the table to use from the data source as well as the fields to include.

Filter String

Specifies the criteria to filter data in a report.

Measure Units

Sets the unit of measurement that is used in the following locations:

  • Rulers that surround your report.
  • Units that define the size of a report item, such as margins, bands, and controls.
  • Units that define the location of a report item in the layout.

Language

Sets the language that is currently being configured for localization.

 

Appearance

Background Color

Type: Color

Can be configured in the Properties or Expressions panel.

Specifies the report item's background color.

Border Color

Type: Color

Can be configured in the Properties or Expressions panel.

Specifies the report item's border color.

Border Dash Style

Can be configured in the Properties or Expressions panel.

Specifies the dash style for the report item's border.

Border Width

Type: Single

Can be configured in the Properties or Expressions panel.

Specifies the width of the border(s) in pixels, using a floating point value.

Borders

Can be configured in the Properties or Expressions panel.

Applies a set of borders (top, right, bottom, left) to a control.

Font

Type: Font

Can be configured in the Properties or Expressions panel.

Sets the report item's font. Properties in this group include:

  • Font Name: The font type applied to the text.
  • Size: Size of the font measured in the units specified in the Unit property.
  • Unit: The unit of measure for the font.
  • Font Effects: Applies Bold, Italic, Strikeout, and/or Underline styling.

Foreground Color

Type: Color

Can be configured in the Properties or Expressions panel.

Specifies the report item's foreground color.

Padding

Can be configured in the Properties or Expressions panel.

Defines the location of a report item's contents within the control by specifying the number of pixels by which the contents are spaced from each border.

Page Color

Sets the fill color of report pages.

Text Alignment

Can be configured in the Properties or Expressions panel.

Specifies the alignment of the report item's text.

Watermark

This group of settings configures a watermark. Properties in this group include:

  • Font: This group of properties sets the font configuration for the watermark text.

  • Foreground Color: Specifies the color of the watermark text.

  • Text Transparency: Specifies the transparency of the watermark text as a percentage.

  • Text: Sets the text that appears in the watermark.

  • Text Direction: Sets the orientation of the text on the page.

  • Image Source: Sets an image as the watermark.

    The following formats are supported: bmp, jpg, gif, tif, png, ico, dib, rle, emf/wmf, svg.

    The following svg content is not supported: Text that uses textPath, animations, css styles, raster images embedded into svg.

    Transparency is not supported for svg watermarks.

  • Image Transparency: Specifies the transparency of the watermark as a percentage.

  • Image Tiling: Indicates whether the watermark image should be tiled.

  • Image Alignment: Sets the orientation of the image on the page.

  • Image View Mode: Specifies how the image is positioned within the control. Options include:

    • Clip: The image is placed in the upper-left corner of the control. the image is clopped if it's larger than the control which contains it.
    • Stretch: The image is stretched or shrunk, as needed, to fit the size of the control.
    • Zoom: The image is sized proportionately to fit the control, without any clipping.
  • Page Range: Defines the pages that contain a watermark.

  • Show Behind: Indicates whether the watermark should be printed behind or in front of the contents of a page.

Behavior

Measure Units

Sets the unit of measurement that is used in the following locations:

  • Rulers that surround your report.
  • Units that define the size of a report item, such as margins, bands, and controls.
  • Units that define the location of a report item in the layout.

Request Parameters

Specifies whether the report should print after it has received all parameters. Enabled by default.

If you wish to publish a report the does not use any parameters from the application running the report, disable this setting.

Vertical Content Splitting

Specifies how report items are split if they are partially positioned into the right page margin. Options include:

  • Exact: When part of a control is in the right page margin, the content that is in the right margin is published on a second page.
  • Smart: When part of a control is in the right page margin, the entire content of the control is published on a second page.

Visible

Type: Boolean

Can be configured in the Properties or Expressions panel.

Sets whether the control is visible at run-time.

Script Language

This property is only available with an on-premises installation.

Defines the scripting language used to write any scripts in the report.

Horizontal Content Splitting

Specifies how report items are split if they are partially positioned into the bottom page margin. Options include:

  • Exact: When part of a control is in the bottom page margin, the content that is in the right margin is published on a second page.
  • Smart: When part of a control is in the bottom page margin, the entire content of the control is published on a second page.

Script References

This property is only available with an on-premises installation.

Specifies the collection of files names of the assemblies used by the scripts in a report.

Scripts

This property is only available with an on-premises installation.

This group of properties defines the scripts used to run various events at the reporting level. These properties include:

  • After Print: Sets the name of the script used to handle the AfterPrint event.
  • Before Print: Sets the name of the script used to handle the BeforePrint event.
  • Band's Height Changed: Sets the name of the script used to handle the BandHeightChanged event.
  • Data Source: Sets the name of the script used to handle the DataSourceRowChanged event.
  • Data Source Demanded: Sets the name of the script used to handle the DataSourceDemanded event.
  • Fill Empty Space: Sets the name of the script used to handle the FillEmptySpace event.
  • Print Progress: Sets the name of the script used to handle the PrintProgress event.
  • Parameters Request Before Show: Sets the name of the script used to handle the XtraReport.ParametersRequestBeforeShow event.
  • Parameters Changed: Sets the name of the script used to handle the XtraReport.ParametersRequestValueChanged event.
  • Parameters Submitted: Sets the name of the script used to handle the XtraReport.ParametersRequestSubmit event.

Data

Data Source

Defines the data connection for the report. If the report has been created using the Layer Report Wizard, this property is populated with the data source defined in the wizard. The report data source can be viewed by opening the Field List.

The data source name can be edited by selecting the data source from the Report Items List.

Data Member

Specifies the table to use from the data source as well as the fields to include.

Filter String

Specifies the criteria to filter data in a report.

Tag

Type: Object

Can be configured in the Expressions panel.

Stores data that is closely associated with the control.

Calculated Fields

Defines the fields used to pre-process report input data based on an expression.

Once you have created a calculated field, it will also appear in the Fields List.

Parameters

Pass inputs to a report when the report runs.

Design

Name

Name assigned to the report.

Snap Grid Size

Specifies the dimensions of the designer's grid size. Measured in units specified at the report level.

Draw the Watermark

Type: Boolean

Sets whether the watermark is applied to the report.

Language

Sets the language that is currently being configured for localization.

Navigation

Bookmark

Type: String

Can be configured in the Properties or Expressions panel.

Specifies the text to appear in a bookmark.

Bookmark Duplicate Suppress

Type: Boolean

Specifies whether to suppress duplicated bookmarks in the final document.

Page Settings

Landscape

Type: Boolean

When enabled, sets the page orientation to landscape.

Roll Paper

Type: Boolean

When enabled, specifies that the report will be printed on roll paper.

Page Width

Specifies the width of the page. The width is determined by the Paper Kind. Measured in units set at the report level.

Page Height

Specifies the height of the page. The height is determined by the Paper Kind. Measured in units set at the report level.

Paper Kind

Sets the type of paper size used for the report layout. The type determines the height and width of the page.

Margins

This group of properties specifies the width of the page margins using the measurement unit set at the report level.

Printing

Right to Left

Specifies the layout of the content within a report.

The options include:

  • Inherit: The item inherits the printing configuration set at the parent level.
  • Yes: The content is aligned to the right.
  • No: The content is aligned to the left. This is the default.

Right to Left Layout

Specifies the position of controls within report bands. This property is in effect only when the Right to Left property is set to Yes.

When enabled, the page margins will be switched, and it will not be possible to place controls outside the right page margin. The controls' coordinates will be unchanged. However, the X coordinates will be calculated starting in the top right corner of the layout. The horizontal ruler direction will reflect this change.

Report Print Options

This group of options define how the Detail band is printed at runtime. Properties include:

  • Print when Data Source is Empty: Specifies whether the band should be printed if the data source is empty. This property is enabled by default.
  • Detail Count at Design Time: Specifies how many times the band is printed when a report is being previewed.
  • Detail Count when Data Source is Empty: Specifies how many times the band should be printed when no data source is defined.
  • Blank Detail Count: Specifies how many times an empty band is repeated before printing a band with populated data.
  • Detail Count: Specifies the maximum number of times the band is repeated and is not empty.

Related Tutorials

Refer to the following resources for additional help:

© 2020 VertiGIS North America Ltd. All Rights Reserved.

Documentation Version 5.10