Property Reference

This section describes the properties of the report objects. The property is listed only once, even if it is a property of several objects. If the property can be set in a custom properties dialog box, the explanation notes the tab where this property appears.

Some properties serve as a summary of several properties in the Properties window. BackgroundImage and BorderColor are two examples of these summary properties. A plus (+) sign to the left of a property in the Properties window tells you it is a summary property and has several detail properties beneath it. Click the plus sign to expand the summary property, so you can view and change the value of the detail properties.

In this section, the Detail Properties: entry signals this property is a summary property, which contains several detail properties. The detail properties are explained in the Notes: entry for the summary property.

Properties

Action

Description: Specifies which type of hyperlink action this item will execute.

When to Use: The report item is to cause the Report Viewer to navigate to a bookmark in this report, to another report, or to a website.

Notes: Linking to a bookmark or to another report works only in the Report Viewer or in the HTML and MHTML rendering formats. Linking to a website works only in the Report Viewer and the HTML, MHTML, PDF, and Excel rendering formats.

Property Of: Chart Value, Image, Text Box

Custom Properties Dialog Box Location: Navigation tab (Action tab for a chart value)

Angle

Description: Adjusts the angle of the point labels on a chart.

When to Use: A chart is to include labels on each data point, and the labels need to be rotated to an orientation other than horizontal.

Notes: Rotating data point labels to a 90-degree angle or a −90-degree angle helps fit more information in a tight space.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value dialog box—Point Labels tab

Author

Description: Records the author of the report.

When to Use: The author’s name is to be stored with the report.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—General tab

AutoRefresh

Description: Sets the number of seconds for the report to automatically reexecute when being displayed in the Report Viewer.

When to Use: The report shows constantly changing information and is viewed in the Report Viewer.

Notes: AutoRefresh only works in the Report Viewer in Report Manager. AutoRefresh does not work on the Visual Studio Preview tab or in any of the export formats.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—General tab

BackgroundColor

Description: Sets the fill color for the item.

When to Use: An item is to have its own fill color.

Property Of: Body, Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Page Header, Page Footer, Rectangle, Table, Table Column, Table Row, Text Box

BackgroundImage

Description: Selects a graphic to fill the background of an item.

When to Use: An item is to have its own fill from a graphic.

Notes: The Source detail property specifies whether the image is embedded, external, in a database, or from a URL. The Value detail property contains the name of the image. The MIMEType detail property contains the MIME type of the image. The BackgroundRepeat detail property specifies how the image is repeated, if it does not fill the entire report object.

Property Of: Body, Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Page Header, Page Footer, Rectangle, Table, Table Column, Table Row, Text Box

Detail Properties: Source, Value, MIMEType, BackgroundRepeat

Bookmark

Description: Creates a named bookmark in a report.

When to Use: A Chart Value, Image, or Text Box is to serve as a hyperlink to this report item.

Notes: The Bookmark serves as the target for a hyperlink jump within the same report. Clicking a Chart Value, Image, or Text Box whose JumpToBookmark property matches this report item’s Bookmark property causes the Report Viewer to jump to this report item. Bookmarks work only in the HTML and MHTML rendering formats.

Property Of: Chart, Image, Line, List, Matrix, Rectangle, Subreport, Table, Text Box

Custom Properties Dialog Box Location: Navigation tab

BorderColor

Description: The color of the border around the outside of the report item

When to Use: A non-black border is to be around this report item.

Notes: The value in the Default detail property is used as the value for the Left, Right, Top, and Bottom detail properties, unless a value is specified for the detail property itself. The Left, Right, Top, and Bottom detail properties control the color for the individual sides of the report object.

Property Of: Body, Chart, Image, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Page Header, Page Footer, Rectangle, Subreport, Table, Table Column, Table Row, Text Box

Detail Properties: Default, Left, Right, Top, Bottom

BorderStyle

Description: The style (none, solid, dotted, dashed, and so forth) of the border around the outside of the report item

When to Use: A border is to be around this report item.

Notes: A border is displayed only when the BorderStyle property is set to a value other than None. Some of the more complex border styles, such as double and groove, are not clearly visible unless the corresponding BorderWidth property is set to a value larger than 1 point. The value in the Default detail property is used as the value for the Left, Right, Top, and Bottom detail properties, unless a value is specified for the detail property itself. The Left, Right, Top, and Bottom detail properties control the style for the individual sides of the report object.

Property Of: Body, Chart, Image, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Page Header, Page Footer, Rectangle, Subreport, Table, Table Column, Table Row, Text Box

Detail Properties: Default, Left, Right, Top, Bottom

BorderWidth

Description: The width of the border around the outside of the report item

When to Use: A border is to be around this report item with a width other than 1 point.

Notes: The value in the Default detail property is used as the value for the Left, Right, Top, and Bottom detail properties, unless a value is specified for the detail property itself. The Left, Right, Top, and Bottom detail properties control the width for the individual sides of the report object.

Property Of: Body, Chart, Image, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Page Header, Page Footer, Rectangle, Subreport, Table, Table Column, Table Row, Text Box

Detail Properties: Default, Left, Right, Top, Bottom

Calendar

Description: The calendar to use when dealing with date values in this report item

When to Use: A calendar other than the Gregorian calendar is to be used with date values in this report item.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

CanGrow

Description: Specifies whether a text box can grow vertically to display the entire contents of the Value property.

When to Use: The expected length of the Value property contents is not known or may vary.

Notes: Text boxes can grow in the vertical direction, but not in the horizontal direction.

Property Of: Text Box

Custom Properties Dialog Box Location: Text Box Properties—Format tab

CanShrink

Description: Specifies whether a text box can shrink vertically to remove any blank lines after the content of the Value property is displayed.

When to Use: The expected length of the Value property contents is not known or may vary.

Property Of: Text Box

Custom Properties Dialog Box Location: Text Box Properties—Format tab

CellDataElementName

Description: The name to be used for the element or attribute used to identify the cell data when exporting to the XML-rendering format.

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Matrix

Custom Properties Dialog Box Location: Matrix Properties—Data Output tab

CellDataElementOutput

Description: Specifies whether the cell data is output when exporting to the XML-rendering format.

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Matrix

Custom Properties Dialog Box Location: Matrix Properties—Data Output tab

ChartAreaBorderAndLineStyle

Description: The format of the line surrounding the entire chart item

When to Use: A line is to be around the entire chart item.

Notes: The Style detail property controls the style, the Width detail property controls the width, and the Color detail property controls the color of the line.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

Detail Properties: Style, Width, Color

ChartAreaFillStyle

Description: The fill behind the entire chart area

When to Use: The Chart item is to have its own fill color.

Notes: The fill can be a single color or a two-color gradient. The Color detail property contains the color of the area or is the first color in a two-color gradient when the Gradient detail property is true. The Gradient detail property specifies whether this is a single-color fill (false) or a two-color gradient (true). The EndColor detail property contains the second color in a two-color gradient.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

Detail Properties: Color, Gradient, End Color

Classes

Description: The classes (assemblies) referenced by this report, which include nonshared properties or methods.

When to Use: Nonshared properties or methods from an assembly are to be referenced by one or more expressions in the report.

Notes: The ClassName detail property contains a list of classes, contained in external assemblies, referenced by this report. The InstanceName detail property contains the name of an object (or instance) created from this class.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—References tab

Detail Properties: ClassName, InstanceName

Clustered

Description: Specifies that a series in a 3-D chart is to be shown front-to-back, rather than side-to-side.

When to Use: Depth is to be added to a 3-D chart to aid analysis or to add interest.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

Color

Description: The foreground color

When to Use: A foreground color other than black is to be used.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

Columns

Description: The number of columns in the report body

When to Use: The report body is to have multiple columns.

Property Of: Body

ColumnSpacing

Description: The amount of space between multiple columns

When to Use: The report body is to have multiple columns with a separation other than 0.5 inch.

Property Of: Body

CustomCode

Description: Visual Basic functions and subroutines to be embedded in the report

When to Use: The report requires Visual Basic code too complex to put in a property value.

Property Of: Report

Cylinder

Description: Specifies that bars and columns in a 3-D chart are to be cylinders, rather than rectangular solids.

When to Use: Interest and variety is to be added to a 3-D chart.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

DataElementCollection

Description: The name of the element to contain all instances of this group when exporting to the XML-rendering format.

When to Use: This group is to be included when exporting to the XML-rendering format.

Property Of: Chart Category Group, Chart Series Group, List Details Group, Matrix Column Group, Matrix Row Group, Table Details Group, Table Group

Custom Properties Dialog Box Location: Data Output tab

DataElementName

Description: The name to use for the element or attribute when exporting to the XML-rendering format.

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Chart, Chart Category Group, Chart Series Group, Chart Value, List, List Details Group, Matrix, Matrix Column Group, Matrix Row Group, Matrix Subtotal, Rectangle, Report, Subreport, Table, Table Details Group, Table Group, Text Box

Custom Properties Dialog Box Location: Data Output tab

DataElementOutput

Description: Specifies whether this item is output when exporting to the XML-rendering format

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Chart, Chart Category Group, Chart Series Group, Chart Value, List, List Details Group, Matrix, Matrix Column Group, Matrix Row Group, Matrix Subtotal, Rectangle, Subreport, Table, Table Details Group, Table Group, Text Box

Custom Properties Dialog Box Location: Data Output tab

DataElementStyle

Description: Specifies whether this item is output as an element or an attribute when exporting to the XML-rendering format

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Report, Text Box

Custom Properties Dialog Box Location: Data Output tab

DataInstanceElementOutput

Description: Specifies whether the list instances are output when exporting to the XML-rendering format.

When to Use: The report is to be exported using the XML-rendering format.

Property Of: List

Custom Properties Dialog Box Location: List Properties—Data Output tab

DataInstanceName

Description: The name to use for the element when exporting to the XML-rendering format

When to Use: The report is to be exported using the XML-rendering format.

Property Of: List

Custom Properties Dialog Box Location: List Properties—Data Output tab

DataLabel

Description: The label to be used for data points on the chart.

When to Use: The data points on the chart are to be labeled.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value—Point Labels tab

DataSchema

Description: The schema name used when exporting to the XML-rendering format.

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—Data Output tab

DataSetName

Description: The name of the dataset to be used with the data region.

When to Use: A dataset is to be used with a data region.

Property Of: Chart, List, Matrix, Table

Custom Properties Dialog Box Location: General tab (For chart, it is on the Data tab.)

DataTransform

Description: The name of a transform (XSLT document) to be applied after the report has been exported using the XML-rendering format.

When to Use: The XML document created by the export is to be transformed into another document format.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—Data Output tab

Description

Description: The description of the report

When to Use: The report’s description is to be stored with the report.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—General tab

DescriptionLocID

Description: The localization identifier (language and culture, for example: “en-us”) for a description property

When to Use: The report’s description has been localized.

Property Of: Report

DetailDataCollectionName

Description: The name of the element to contain all instances of this group when exporting to the XML-rendering format.

When to Use: This group is to be included when exporting to the XML-rendering format.

Property Of: Table

Custom Properties Dialog Box Location: Table Properties—Data Output tab

DetailDataElementName

Description: The name to be used for the element or attribute used to identify the detail data when exporting to the XML-rendering format.

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Table

Custom Properties Dialog Box Location: Table Properties—Data Output tab

DetailDataElementOutput

Description: Specifies whether this item is output when exporting to the XML-rendering format.

When to Use: The report is to be exported using the XML-rendering format.

Property Of: Table

Custom Properties Dialog Box Location: Table Properties—Data Output tab

Direction

Description: The writing direction to use with this item, either left-to-right or right-to-left.

When to Use: A character set that is written right-to-left is being used in this item.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

Custom Properties Dialog Box Location: Text Box Properties, Advanced—Format tab (for text box)

DisplayChartWith3-DVisualEffect

Description: Specifies whether to make a chart 3-D.

When to Use: Readability or interest is to be added by making a chart three-dimensional.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

DisplayLegendInsidePlotArea

Description: Specifies whether to display the chart legend inside the chart-plotting area.

When to Use: Space can be saved by placing the chart’s legend in an unused portion of the plotting area.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—Legend tab

DrawGrid

Description: Specifies whether the layout grid is shown on the Layout tab.

When to Use: The layout grid dots are not wanted on the Layout tab.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—General tab

EmbeddedImages

Description: The collection of graphics embedded in the report

When to Use: Images are to be embedded in the report.

Property Of: Report

EndPoint

Description: The coordinates of the end of the line

When to Use: A line is to be positioned on the report.

Notes: The Horizontal and Vertical detail properties specify the location of the end of the line.

Property Of: Line

Detail Properties: Horizontal, Vertical

Filters

Description: One or more expressions to exclude certain records from the dataset

When to Use: The dataset contains records not desired in the data region, and these records cannot or should not be removed by the dataset query.

Notes: The detail properties combine to build a set of filter expressions. Only records in the dataset that satisfy this set of filter expressions are included in the data region or grouping.

Property Of: Chart, Chart Category Group, Chart Series Group, List, List Details Group, Matrix, Matrix Column Group, Matrix Row Group, Table, Table Details Group, Table Group

Custom Properties Dialog Box Location: Filters tab

Detail Properties: Expression, Operator, Value, And/Or

FixedHeader

Description: Flag to freeze a group header on the screen during scrolling

When to Use: The group header should not scroll off the screen.

Property Of: Matrix Column Group, Table, TableColumn

Font

Description: The specification of the font to be used to render text within this item

When to Use: A font other than Normal, Arial, 10 point is desired.

Notes: The FontStyle detail property specifies whether the font is normal or italicized. The FontFamily detail property contains the name of the font. The FontSize detail property specifies the size of the font in points. The FontWeight detail property specifies the thickness of the font and is used to create bold text. (Underlining is controlled by the TextDecoration property.)

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

Detail Properties: FontStyle, FontFamily, FontSize, FontWeight

Format

Description: A formatting string to control the appearance of a value

When to Use: An appearance other than the default appearance of a value is required for better readability.

Property Of: Chart, Chart Value, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

Custom Properties Dialog Box Location: Text Box Properties—Format tab (for text box) or Edit Chart Value—Point Labels tab (for chart value)

GridSpacing

Description: The distance between layout grid points

When to Use: A distance other than 0.125 inch is desired between grid points.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—General tab

Grouping

Description: The grouping information for the detail level of the data region

When to Use: The detail level of this data region is to be a group.

Property Of: List, Table Row

Notes: This property displays the Detail Grouping dialog box.

Grouping/Sorting

Description: The grouping and sorting information for a header-level or footer-level table row

When to Use: Data is to be grouped or sorted.

Property Of: Table Row

Notes: This property displays the Detail Grouping dialog box. (This is the correct dialog box with the correct information, but it has a misleading title. The information in the dialog box applies to the group this table row belongs to. It is not the information for the detail level as the title would suggest.)

GroupOn

Description: The grouping expression

When to Use: Data is to be grouped when displayed by this data region.

Property Of: Chart Category Group, Chart Series Group, List Details Group, Matrix Column Group, Matrix Row Group, Table Details Group, Table Group

Custom Properties Dialog Box Location: General tab

GroupsBeforeRowHeaders

Description: The number of columns to appear to the left of the row headers (reverse this if you’re using a right-to-left matrix)

When to Use: The row headers are to appear in the matrix, rather than to the left (or right) of it.

Property Of: Matrix

Custom Properties Dialog Box Location: Matrix Properties—General tab

Height

Description: The height of the row

When to Use: The row height is to be modified.

Property Of: Matrix Row, Table Row

HideDuplicates

Description: Specifies whether to hide duplicate values when the text box is repeated in a table column

When to Use: The value in the text box is to act as a group header, even though it is within the table detail rather than the group header.

Property Of: Text Box

Custom Properties Dialog Box Location: Table Properties—General tab

HorizontalRotation

Description: The horizontal rotation applied to a 3-D chart

When to Use: The horizontal rotation must be adjusted to provide the user with the optimum view of the chart data.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

IncludeGroupFooter

Description: Specifies whether a footer row is to be included for this group

When to Use: Totals or other concluding information is to be displayed at the end of the table group.

Property Of: Table Group

Custom Properties Dialog Box Location: Grouping and Sorting Properties—General tab

IncludeGroupHeader

Description: Specifies whether a header row is to be included for this group

When to Use: Headers or other introductory information is to be displayed at the beginning of the table group.

Property Of: Table Group

Custom Properties Dialog Box Location: Grouping and Sorting Properties—General tab

InitialToggleState

Description: The initial state of the toggle graphic associated with this text box

When to Use: This text box is being used to control the visibility of another report item.

Property Of: Text Box

Custom Properties Dialog Box Location: Text Box Properties—Visibility tab

InteractiveSize

Description: The default page size of the report when it is viewed in an interactive renderer

When to Use: The page size of the report should be different when viewed in an interactive renderer than when viewed in a printed or fixed-page format.

Property Of: Report

JumpToBookmark

Description: The name of the bookmark to which this report item is to hyperlink

When to Use: This report item is to cause the Report Viewer to navigate to a bookmark in this report.

Notes: Linking to a bookmark works only in the Report Viewer or in the HTML- and MHTML-rendering formats.

Property Of: Chart Value, Image, Text Box

Custom Properties Dialog Box Location: Navigation tab (Action tab for a chart value)

JumpToReport

Description: The name of the report to which this report item is to hyperlink

When to Use: This report item is to cause the Report Viewer to navigate to another report.

Notes: Linking to another report works only in the Report Viewer or in the HTML- and MHTML-rendering formats.

Property Of: Chart Value, Image, Text Box

Custom Properties Dialog Box Location: Navigation tab (Action tab for a chart value)

JumpToReportParameters

Description: The parameters required by the report to which the item is to hyperlink

When to Use: This report item is to cause the Report Viewer to navigate to another report, and the target report requires report parameters.

Notes: The Parameter Name detail property contains a list of parameters for the hyperlinked report. The Parameter Value detail property contains a list of values to be assigned to each of those parameters.

Property Of: Chart Value, Image, Text Box

Custom Properties Dialog Box Location: Navigation tab (Action tab for a chart value)

Detail Properties: Parameter Name, Parameter Value

JumpToURL

Description: The URL to which this report item is to hyperlink

When to Use: This report item is to cause the Report Viewer to navigate to a website.

Notes: Linking to a website works only in the Report Viewer and the HTML-, MHTML-, PDF-, and Excel-rendering formats.

Property Of: Chart Value, Image, Text Box

Custom Properties Dialog Box Location: Navigation tab (Action tab for a chart value)

KeepTogether

Description: Specifies whether to attempt to keep this data region on one page

When to Use: The data region is to be kept on one page for better readability and analysis.

Property Of: List, Matrix, Table

Custom Properties Dialog Box Location: General tab

Label

Description: The document map label for this item

When to Use: The report is to include a document map, and this item is to be linked to one item in the document map.

Notes: The document map works only in the Report Viewer and in the PDF- and Excel-rendering formats.

Property Of: Chart, Chart Category Group, Chart Series Group, Image, Line, List, List Details Group, Matrix, Matrix Column Group, Matrix Row Group, Rectangle, Subreport, Table, Table Details Group, Table Group, Text Box

Custom Properties Dialog Box Location: General tab or Navigation tab

LabelFontStyle

Description: The font style of a chart point label

When to Use: The chart values are to have their own textual labels.

Notes: The FontFamily detail property contains the name of the font. The FontSize detail property specifies the size of the font in points. The FontStyle detail property specifies whether the font is normal or italicized. The FontWeight detail property specifies the thickness of the font and is used to create bold text. The Color detail property specifies the color of the type. The TextDecoration detail property specifies whether the text is underlined, lined through, or overlined.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value—Point Labels tab

Detail Properties: FontFamily, FontSize, FontStyle, FontWeight, Color, TextDecoration

LabelLocID

Description: The localization identifier (language and culture, for example: “en-us”) for a document map label

When to Use: The document map label has been localized.

Property Of: Chart, Image, Line, List, Matrix, Rectangle, Subreport, Table, Text Box

Language

Description: The language being used to display values within this report item

When to Use: The language being used is something other than the default language on the computer.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Report, Subreport, Table, Table Column, Table Row, Text Box

LayoutDirection

Description: The direction in which matrix columns are built, either left-to-right or right-to-left

When to Use: A matrix must be built from right-to-left.

Property Of: Matrix

Custom Properties Dialog Box Location: Matrix Properties—General tab

LegendBorderAndLineStyle

Description: The border and line style for the chart legend

When to Use: The chart legend is to have a nondefault border.

Notes: The Style detail property controls the style of the line. The Width detail property controls the width of the line. The Color detail property controls the color of the line.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—Legend tab

Detail Properties: Style, Width, Color

LegendFillStyle

Description: The fill style for the chart legend

When to Use: The chart legend is to have its own fill style.

Notes: The fill can be a single color or a two-color gradient. The Color detail property contains the color of the area or is the first color in a two-color gradient when the Gradient detail property is true. The Gradient detail property specifies whether this is a single-color fill (false) or a two-color gradient (true). The EndColor detail property contains the second color in a two-color gradient.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—Legend tab

Detail Properties: Color, Gradient, End Color

LegendFontStyle

Description: The font style for the chart legend

When to Use: The chart legend is to have a nondefault font style.

Notes: The FontFamily detail property contains the name of the font. The FontSize detail property specifies the size of the font in points. The FontStyle detail property specifies whether the font is normal or italicized. The FontWeight detail property specifies the thickness of the font and is used to create bold text. The Color detail property specifies the color of the type. The TextDecoration detail property specifies whether the text is underlined, lined through, or overlined.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—Legend tab

Detail Properties: FontFamily, FontSize, FontStyle, FontWeight, Color, TextDecoration

LegendLayout

Description: Specifies whether the chart legend is laid out in columns, rows, or as a table

When to Use: The chart legend is to have a nondefault layout for better readability.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—Legend tab

LegendPosition

Description: The position of the chart legend relative to the plot area

When to Use: The chart legend is to have a nonstandard position.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—Legend tab

LineColor

Description: The color of the line

When to Use: The line is to have a color other than black.

Property Of: Line

LineHeight

Description: The height of a line of text within this report item

When to Use: The report item is to use a nonstandard line height.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

LineStyle

Description: The style of the line (solid, dashed, dotted, and so forth)

When to Use: The line is to have a style other than solid.

Property Of: Line

LineWidth

Description: The width of the line in points

When to Use: The line is to have a width other than 1 point.

Property Of: Line

LinkToChild

Description: The report item within the rectangle that will be the ultimate target of a document map entry that points to the rectangle

When to Use: A rectangle containing several report items is the target of a document map entry.

Property Of: Rectangle

Location

Description: The location of the report item within the layout area

When to Use: Every time an item is placed in a layout area.

Notes: The Left and Top detail properties specify the position of the upperleft corner of the report item in the layout area.

Property Of: Chart, Image, Line, List, Matrix, Rectangle, Subreport, Table, Text Box

Detail Properties: Left, Top

Margins

Description: The size of the margins on the report page

When to Use: The margins are to be something other than 1 inch.

Notes: If the body width plus the left and right margins are greater than the report page width, the report will span more than one page horizontally. The Left, Right, Top, and Bottom detail properties specify the size of each margin in inches.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—Layout tab

Detail Properties: Left, Right, Top, Bottom

MarkerSize

Description: The size of the marker placed for each data value on a chart

When to Use: Each data value is to be highlighted with a shape to mark its position.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value—Appearance tab

MarkerType

Description: The shape used to mark each data value on a chart

When to Use: Each data value is to be highlighted with a shape to mark its position.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value—Appearance tab

MergeTransactions

Description: Combines any transactions from a subreport with the transactions of the parent report

When to Use: The queries in both the parent report and the subreport initiate data modifications that should be committed only if both are successful.

Notes: Both reports must use the same data source.

Property Of: Subreport

MIMEType

Description: The MIME type of the graphic used to populate the image item

When to Use: The MIME type must be selected only when using an external image source such as a database. The MIME type is automatically detected for embedded images.

Property Of: Image

Name

Description: The name of the report item

When to Use: The report item will be referenced by another item in the report (for example, to control visibility).

Notes: Report item names must be unique within a report.

Property Of: Chart, Chart Category Group, Chart Series Group, Image, Line, List, List Details Group, Matrix, Matrix Column Group, Matrix Row Group, Rectangle, Subreport, Table, Table Details Group, Table Group, Text Box

Custom Properties Dialog Box Location: General tab

NoRows

Description: The message displayed in place of a data region when that data region’s dataset contains no rows

When to Use: A data region’s dataset may be empty.

Property Of: Chart, List, Matrix, Subreport, Table

NumeralLanguage

Description: The language to use when applying formatting to numeric output

When to Use: The numeral language is to be something other than the default for the computer.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

NumeralVariant

Description: The variant of the numeral language to use when applying formatting to numeric output

When to Use: The numeral language variant is to be something other than the default for the computer.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

Orthographic

Description: Specifies whether to present a 3-D chart as an orthographic projection

When to Use: An orthographic projection of a 3-D chart is to be used to provide the best view for analysis.

Notes: An orthographic projection represents the three dimensions as perpendicular to one another. The Perspective property is ignored when the Orthographic property is selected.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

Padding

Description: The amount of empty space left around the sides of an item

When to Use: The amount of empty space is to be changed to improve the report’s presentation and readability.

Notes: The Left, Right, Top, and Bottom detail properties specify in points the white space on each side of the report item.

Property Of: Chart, Image, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

Custom Properties Dialog Box Location: Advanced Text Box Properties—Format tab (only for text box)

Detail Properties: Left, Right, Top, Bottom

PageBreakAtEnd

Description: Specifies whether a forced page break is to be inserted at the end of this report item

When to Use: A page break is to be forced to meet report-formatting needs.

Property Of: Chart, List, List Details Group, Matrix, Matrix Row Grouping, Rectangle, Table, Table Details Group, Table Group

Custom Properties Dialog Box Location: General tab

PageBreakAtStart

Description: Specifies whether a forced page break is to be inserted at the beginning of this report item

When to Use: A page break is to be forced to meet report-formatting needs.

Property Of: Chart, List, List Details Group, Matrix, Matrix Row Grouping, Rectangle, Table, Table Details Group, Table Group

Custom Properties Dialog Box Location: General tab

PageSize

Description: The size of the report page

When to Use: The report will be printed or exported to the PDF- or TIFF-rendering formats.

Notes: The Width detail property specifies the width of the report in inches. The Height detail property specifies the height of the report in inches.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—Layout tab

Detail Properties: Width, Height

Palette

Description: The color scheme to use for a chart

When to Use: A nondefault set of colors is to be used when creating a chart.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

Parameters

Description: The parameter values to be passed to a subreport

When to Use: The subreport is to receive values from the parent report to control the subreport’s content.

Notes: The Parameter Name detail property contains a list of parameters for the selected subreport. The Parameter Value detail property contains a list of values to be assigned to each of those parameters.

Property Of: Subreport

Custom Properties Dialog Box Location: Subreport Properties—Parameters tab

Detail Properties: Parameter Name, Parameter Value

Parent

Description: The report item that contains this item

When to Use: This is a read-only property controlled by the item’s location on the report layout.

Property Of: Chart, Image, Line, List, Matrix, Rectangle, Subreport, Table, Text Box

Parent Group

Description: The group that contains this group

When to Use: This is a read-only property maintained automatically by the group hierarchy.

Property Of: Chart Category Group, Chart Series Group, List Details Group, Matrix Column Group, Matrix Row Group, Table Details Group, Table Group

Custom Properties Dialog Box Location: General tab

Perspective

Description: The amount of perspective applied to a 3-D chart

When to Use: The default perspective of a 3-D chart is to be changed to improve readability or interest.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

PlotAreaBorderAndLineStyle

Description: The format of the line surrounding the chart’s plot area

When to Use: The format of the chart’s plot area is to be changed from the 1-point, solid, black line.

Notes: The Style detail property controls the style of the line. The Width detail property controls the width of the line. The Color detail property controls the color of the line.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

Detail Properties: Style, Width, Color

PlotAreaFillStyle

Description: The fill behind the chart’s plotting area

When to Use: The chart’s plotting area is to have a fill color other than light gray.

Notes: The fill can be a single-color or a two-color gradient. The Color detail property contains the color of the area or is the first color in a two-color gradient when the Gradient detail property is true. The Gradient detail property specifies whether this is a single-color fill (false) or a two-color gradient (true). The EndColor detail property contains the second color in a two-color gradient.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

Detail Properties: Color, Gradient, End Color

PlotDataAsLine

Description: Specifies whether the chart data is to be represented by a line

When to Use: The chart data is to be represented by a line.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value—Appearance tab

PointWidth

Description: Specifies the width, in points, of the column on a column chart or a bar on a bar chart

When to Use: The default width of the column or bar must be modified.

Property Of: Chart

Position

Description: The position of the chart value labels or the matrix subtotal

When to Use: The chart value label is to be placed in a position other than directly above the data point, or the matrix subtotal is to be placed above or before the detail, rather than below or after it.

Property Of: Chart Value, Matrix Subtotal

Custom Properties Dialog Box Location: Edit Chart Value—Point Labels tab. (This property does not appear in a custom properties dialog box for a Matrix Subtotal.)

PrintOnFirstPage

Description: Specifies whether the page header or page footer should print on the first page of the report

When to Use: The report contains a page header or footer that is not to be printed on the first page of the report.

Property Of: Page Header, Page Footer

Custom Properties Dialog Box Location: Report Properties—General tab

PrintOnLastPage

Description: Specifies whether the page header or page footer should print on the last page of the report.

When to Use: The report contains a page header or footer that is not to be printed on the last page of the report.

Property Of: Page Header, Page Footer

Custom Properties Dialog Box Location: Report Properties—General tab

References

Description: The custom assemblies referenced by the report

When to Use: A report expression is to make use of a property or method in a custom assembly.

Notes: The AssemblyName detail property contains a list of assemblies that are referenced by the report.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—References tab

Detail Properties: AssemblyName

RepeatFooterOnNewPage

Description: Specifies whether a footer should be repeated on each new page spanned by the table

When to Use: A table or table group contains a footer that is to be repeated on every page spanned by the table.

Property Of: Table, Table Group

Custom Properties Dialog Box Location: General tab

RepeatHeaderOnNewPage

Description: Specifies whether a header should be repeated on each new page spanned by the table

When to Use: A table or table group contains a header that is to be repeated on every page spanned by the table.

Property Of: Table, Table Group

Custom Properties Dialog Box Location: General tab

RepeatOnNewPage

Description: This table row should repeat on each page of the report

When to Use: One or more table rows should repeat on each page of the report for better report clarity.

Property Of: Table Row (Not a property of a detail table row)

RepeatWith

Description: The data region this report item should repeat with across multiple pages

When to Use: This report item is part of a heading that is to be repeated with a data region that spans multiple pages.

Property Of: Image, Line, Rectangle, Text Box

Custom Properties Dialog Box Location: General tab

ReportName

Description: The name of the report to be displayed in this subreport item

When to Use: The report name is always required when using a subreport item.

Property Of: Subreport

Custom Properties Dialog Box Location: Subreport Properties—General tab

ReportParameters

Description: The parameters used by this report

When to Use: User input is to be used in determining the content of this report.

Notes: The AllowNullValue detail property specifies whether each parameter can have a null value. The AllowBlankValue detail property specifies whether each parameter can have a blank value. The Available Values detail property contains a list of the valid values for each property, either as a list of constants or as a reference to a dataset. The DataType detail property specifies the data type of each parameter. The DefaultValues detail property contains a default value for each property, either as a constant value or as a reference to a dataset. The Name detail property contains the name of each property. The Prompt detail property contains the prompt string for each property.

Property Of: Report

Custom Properties Dialog Box Location: Report Parameters

Detail Properties: AllowNullValue, AllowBlank Value, Available Values, DataType, Default Values, Name, Prompt

SeriesLabel

Description: A portion of the label applied to the series on the chart

When to Use: The series label is to include information from the data value.

Notes: The series label is made up of the expression specified in the series grouping concatenated with the expression specified with the chart value.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value—Values tab

Shading

Description: The type of shading used in a 3-D chart

When to Use: Shading other than simple shading is to be used with a 3-D chart to increase readability or enhance interest.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

ShowLegend

Description: Specifies whether to show the chart legend

When to Use: The chart is to include a data series that must be identified by the legend.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—Legend tab

ShowMarkers

Description: Specifies whether to place a marker for each data value on a chart

When to Use: Each data value on a chart is to be highlighted with a shape to mark its position.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Value—Appearance tab

ShowPointLabels

Description: Specifies whether to label each data value on a chart

When to Use: Each data value on a chart is to be labeled to improve readability or analysis.

Property Of: Chart Value

Custom Properties Dialog Box Location: Edit Chart Values—Point Labels tab

Size

Description: The size of the report item

When to Use: Every time an item is placed in a layout area

Notes: The Width detail property contains the width of the report object in inches. The Height detail property contains the height of the report object in inches.

Property Of: Body, Chart, Image, List, Matrix, Page Header, Page Footer, Rectangle, Subreport, Table, Text Box

Detail Properties: Width, Height

Sizing

Description: The technique used to size a graphic within an image report item

When to Use: The graphic is to be sized using a technique other than the fit technique.

Notes: The AutoSize technique changes the size of the image report item, so the graphic completely fills it at its normal size. The Fit technique stretches the graphic to fit the dimensions of the image report item. The FitProportional technique shrinks or magnifies the graphic to fit the image report item, but retains its proportions of height to width. The Clip technique displays as much of the graphic, at its normal size, as will fit within the image report item; the remainder is clipped off.

Property Of: Image

SnapToGrid

Description: Specifies whether report-item corner points are aligned with the grid when they are placed on the report layout

When to Use: The report layout is not to be constrained by the grid.

Property Of: Report

Custom Properties Dialog Box Location: Report Properties—General tab

Sorting

Description: The expression used to order the dataset or data grouping

When to Use: The dataset or data grouping is to be presented in a sort order that is not provided by the dataset query.

Notes: The Expression detail property contains a list of expressions used to sort the contents of the data region or grouping. The Direction detail property specifies whether each sort is in ascending order or descending order.

Property Of: Chart Category Group, Chart Series Group, List, Matrix Column Group, Matrix Row Group, Table, Table Group

Custom Properties Dialog Box Location: Sorting tab

Detail Properties: Expression, Direction

Source

Description: The source of the graphic

When to Use: A source must be specified for each image report item.

Notes: A Database image is extracted from a binary large object (BLOB). An Embedded image is stored in the report itself. An External image is stored in the report project and deployed to the Report Manager with the report.

Property Of: Image

Custom Properties Dialog Box Location: Image Wizard

Subtype

Description: The specific type of chart

When to Use: A chart subtype must be specified for all chart types except a bubble chart.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

TextAlign

Description: The horizontal position of the text within a report item

When to Use: The text is to be centered or right-justified.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

TextDecoration

Description: The decoration (underline, overline, or line through) applied to the text

When to Use: The text is to be underlined, overlined, or struck through.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

Custom Properties Dialog Box Location: Text Box Properties—Font tab (only for text box)

Title

Description: The title of the chart

When to Use: The chart is to be given a title to provide better understanding of the data it contains.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

TitleFontStyle

Description: The font style of the chart title

When to Use: The chart is to have a title.

Notes: The FontFamily detail property contains the name of the font. The FontSize detail property specifies the size of the font in points. The FontStyle detail property specifies whether the font is normal or italicized. The FontWeight detail property specifies the thickness of the font and is used to create bold text. The Color detail property specifies the color of the type. The TextDecoration detail property specifies whether the text is underlined, lined through, or overlined.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

Detail Properties: FontFamily, FontSize, FontStyle, FontWeight, Color, TextDecoration

ToolTip

Description: The tool tip displayed for this report item

When to Use: The user is to be provided with additional information concerning a report item when interacting with the report.

Property Of: Chart, Image, List, Matrix, Rectangle, Subreport, Table, Text Box

Custom Properties Dialog Box Location: General tab

ToolTipLocID

Description: The localization identifier (language and culture, for example: “en-us”) for a ToolTip

When to Use: The ToolTip has been localized.

Property Of: Chart, Image, List, Matrix, Rectangle, Subreport, Table, Text Box

Type

Description: The general type of chart

When to Use: A general chart type must be specified for all charts.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—General tab

UnicodeBiDi

Description: The technique used for handling text rendered right-to-left embedded in a line of text rendered left-to-right or vice versa

When to Use: Multiple languages are to be included in the same text box, with one language rendered left-to-right and the other rendered right-to-left.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

UserSort

Description: The properties to facilitate a dynamic sort within the report

When to Use: The report is to include dynamic sorting.

Notes: The SortExpression detail property contains the expression which will be used for sorting. The SortExpressionScope detail property specifies the scope to which the sort is applied. The SortTarget detail property specifies the data region object, grouping, or data set to which the sort is applied.

Property Of: Text Box

Detail Properties: SortExpression, SortExpressionScope, SortTarget

Value

Description: Chart Value—An expression to determine the values to be charted; Image—The name of the graphic to be placed in the image item; Text Box—The text to be displayed in the text box.

When to Use: A value is required for a chart value, an image, or a text box.

Property Of: Chart Value, Image, Text Box

Custom Properties Dialog Box Location: Chart Value: Edit Chart Value—Values tab; Image: Image Wizard; Text Box: Text Box Properties—General tab

ValueLocID

Description: The localization identifier (language and culture, for example: “en-us”) for a value

When to Use: The value has been localized.

Property Of: Text Box

VerticalAlign

Description: The vertical position of the text within a report item

When to Use: The text is to be located in the middle or at the bottom.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

VerticalRotation

Description: The vertical rotation applied to a 3-D chart

When to Use: The vertical rotation must be adjusted to provide the user with the optimum view of the chart data.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

Visibility

Description: Specifies whether a report item is visible on the report

When to Use: The report item is not to be visible on the report, or the report item’s visibility is to be toggled by another report item.

Notes: The Hidden detail property specifies whether this report item is visible or hidden. The ToggleItem detail property is a reference to another report item that will toggle the visibility of this report item.

Property Of: Chart, Image, Line, List, List Details Group, Matrix, Matrix Column Group, Matrix Row Group, Rectangle, Subreport, Table, Table Column, Table Details Group, Table Group, Table Row, Text Box

Custom Properties Dialog Box Location: Visibility tab

Detail Properties: Hidden, ToggleItem

WallThickness

Description: The thickness of the walls surrounding a 3-D chart

When to Use: The thickness of the walls surrounding a 3-D chart is to be adjusted to create the most pleasing chart representation.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—3-D Effect tab

Width

Description: The width of a column

When to Use: The column width is to be adjusted to the appropriate size for the data it contains.

Property Of: Matrix Column, Table Column

WritingMode

Description: Indicates whether the text is written left-to-right/top-to-bottom or top-to-bottom/right-to-left

When to Use: A character set that is written top-to-bottom/right-to-left is to be used.

Property Of: Chart, List, Matrix, Matrix Column, Matrix Row, Matrix Subtotal, Subreport, Table, Table Column, Table Row, Text Box

X-AxisFormatting

Description: The formatting for the x-axis of a chart

When to Use: A chart type with an x-axis is to be rendered.

Notes: The detail properties control the look of each aspect of the x-axis.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—x-axis tab

Detail Properties: CrossAt, FormatCode, FormatCodeStyle, InterlacedStrips, LogarithmicScale, MajorGridlines, MajorGridlinesInterval, MajorGridlinesStyle, MajorTickMark, MinorGridlines, MinorGridlinesInterval, MinorGridlinesStyle, MinorTickMark, NumericOrTime-scaleValues, Reversed, ScaleMaximum, ScaleMinimum, ShowLabels, SideMargins, Title, TitleAlign, TitleStyle

Y-AxisFormatting

Description: The formatting for the y-axis of a chart

When to Use: A chart type with a y-axis is to be rendered.

Notes: The detail properties control the look of each aspect of the y-axis.

Property Of: Chart

Custom Properties Dialog Box Location: Chart Properties—y-axis tab

Detail Properties: CrossAt, FormatCode, FormatCodeStyle, Interlaced Strips, Logarithmic Scale, MajorGridlines, MajorGridlinesInterval, MajorGridlinesStyle, MajorTickMark, MinorGridlines, MinorGridlinesInterval, MinorGridlinesStyle, MinorTickMark, Reversed, ScaleMaximum, ScaleMinimum, ShowLabels, SideMargins, Title, TitleAlign, TitleStyle