Report Definition XML Elements

Article
12/03/2008

The report definition for a report contains elements that define the data and appearance of the report.

A report definition file can contain additional elements that are not used by the report server. For example, Report Designer places an element in the report definition that is only used by Report Designer.

In This Section

Element	Parent	Description
AccentSensitivity	DataSet	Indicates whether the data is accent-sensitive.
Action	DataPoint, Image, Textbox	Defines a hyperlink, bookmark link, or drillthrough action.
AllowBlank	ReportParameter	Indicates whether the value for the parameter can be an empty string.
Author	Report	Specifies the name of the person who created the report.
AutoRefresh	Report	Specifies the rate, in seconds, at which a report rendered in HTML refreshes.
Axis	CategoryAxis, ValueAxis	Defines properties for labels, titles, and gridlines on an axis.
BackgroundColor	Style	Describes the background color of the item.
BackgroundGradientEndColor	Style	Specifies the end color of the background gradient.
BackgroundGradientType	Style	Specifies the type of background gradient.
BackgroundImage	Style	Provides information about the background image.
BackgroundRepeat	BackgroundImage	Indicates how the background image fills the available space.
Body	Report	Contains the visual elements of the report.
Bookmark	Chart, Image, Line, List, Matrix, Rectangle, Subreport, Table, Textbox	Provides a bookmark that users can jump to using a link defined as a bookmark action.
BookmarkLink	Action	Contains the ID of a bookmark within the report.
BorderColor	Style	Indicates the border color of the item.
BorderStyle	Style	Indicates the style of the border of the item.
BorderWidth	Style	Indicates the width of the border of the item.
Bottom	BorderColor	Describes the color of the bottom border of the item.
Bottom	BorderStyle	Describes the style of the bottom border of the item.
Bottom	BorderWidth	Describes the width of the bottom border of the item.
BottomMargin	Report	Describes the width of the bottom margin of the report.
Calendar	Style	Specifies the calendar to use to format dates.
CanGrow	Textbox	Indicates whether the size of the text box can increase according to its content.
CanShrink	Textbox	Indicates whether the size of the text box can decrease according to its content.
Caption	Title	Contains the text of the title.
CaseSensitivity	DataSet	Indicates whether the data is case-sensitive.
CategoryAxis	Chart	Defines the category axis of the chart.
CategoryGrouping	CategoryGroupings	Defines a category level for a category grouping in a chart.
CategoryGroupings	Chart	Defines a set of category groupings for the chart.
CellDataElementName	Matrix	Contains the name of the data element for a matrix cell in a report rendered using a data rendering extension, such as XML or CSV.
CellDataElementOutput	Matrix	Indicates whether the matrix cell appears in output rendered by the XML rendering extension.
Chart	ReportItems	Defines a chart region to be included in the report.
ChartData	Chart	Defines the data values for the chart.
ChartElementOutput	Chart	Indicates whether the element containing the chart data points appears in output rendered by the XML rendering extension.
ChartSeries	Chart	Defines a set of data points for a series.
Class	Classes	Contains information about a class to instantiate.
Classes	Report	Contains classes to instantiate during report initialization.
ClassName	Class	Contains the name of the class to instantiate.
Clustered	ThreeDProperties	Indicates whether the data series are displayed along distinct rows in a three-dimensional chart.
Code	Report	Contains definitions for custom functions to be used in the report.
CodeModule	CodeModules	Contains the name of the code module to load.
CodeModules	Report	Contains the names of code modules to load for use in expressions.
Collation	DataSet	Describes the locale that the report server uses to sort data.
Color	Style	Describes the foreground color of the item.
ColSpan	TableCell	Indicates the number of columns that the table cell spans.
ColumnGrouping	ColumnGroupings	Defines a column header region in a matrix.
ColumnGroupings	Matrix	Contains the set of column groupings for a matrix.
Columns	Body	Defines the default number of columns in the report.
ColumnSpacing	Body	Defines the spacing between each column.
CommandText	Query	Specifies the query that the report server executes to retrieve data for the report.
CommandType	Query	Indicates the type of query that is contained in the CommandText element.
ConnectionProperties	DataSource	Provides information about the data source.
ConnectString	ConnectionProperties	Contains the connection string for the data source.
Corner	Matrix	Contains the items in the corner region of a matrix.
CrossAt	Axis	Indicates the value at which to cross the other axis.
Custom	Chart, Grouping, Image, Line, List, Matrix, Rectangle, Report, Subreport, Table, Textbox	Contains custom information to be passed to the rendering extension.
CustomReportItem	ReportItems	Defines a custom report item to be drawn in the report.
DataCollectionName	Grouping	Contains the name of the data element of the collection containing all instances of the group in a report rendered using a data rendering extension, such as XML or CSV.
DataElementName	Chart, CustomReportItem, DataPoint, Grouping, Image, Line, List, Matrix, Rectangle, Report, Subreport, Subtotal, Table,Textbox	Contains the name of the data element or attribute for a report item or the name of the top-level element for a report rendered using a data rendering extension, such as XML or CSV.
DataElementOutput	Chart, CustomReportItem, DataPoint, Grouping, Image, Line, List, Matrix, Rectangle, Subreport, Subtotal, Table, Textbox	Indicates whether the item appears in output rendered by the XML rendering extension.
DataElementStyle	Report,Textbox	Indicates whether a text box within the report should be rendered as an element or as an attribute when the report is rendered using a data rendering extension, such as XML or CSV.
DataInstanceElementOutput	List	Indicates whether the list appears in output rendered by the XML rendering extension.
DataInstanceName	List	Contains the name of the data element for a list in a report rendered using a data rendering extension, such as XML or CSV.
DataField	Field	Name of a field in a query.
DataLabel	DataPoint	Defines the data labels to display for data values.
DataPoint	DataPoints	Defines a single data point for a chart.
DataPoints	ChartSeries	Defines the data points for a chart series.
DataProvider	ConnectionProperties	Specifies the data processing extension to use for the data source.
DataSchema	Report	Contains the namespace to use in a report rendered using a data rendering extension, such as XML or CSV.
DataSet	DataSets	Contains information about a dataset used in the report.
DataSetName	DataSetReference	Indicates which dataset to use for the dataset reference.
DataSetName	List, Matrix, Chart, Table	Indicates which dataset to use for the data region.
DataSetReference	DefaultValue, ValidValues	Defines a dataset that contains a list of valid parameter values and for a default parameter.
DataSets	Report	Describes the data in the report.
DataSource	DataSources	Describes a source of data for the report.
DataSourceName	Query	Contains the name of the data source for the query.
DataSourceReference	DataSource	Contains the path to a shared data source.
DataSources	Report	Describes the data sources for the report.
DataTransform	Report	Contains the location and file name of a transformation to apply to a report rendered using a data rendering extension, such as XML or CSV.
DataType	ReportParameter	Specifies the data type of a parameter.
DataValue	DataValues	Defines a single value for a data point.
DataValues	DataPoint	Contains a set of data values for the y-axis.
Default	BorderColor	Describes the default color of the border of the item.
Default	BorderStyle	Describes the default style of the border of the item.
Default	BorderWidth	Describes the default width of the border of the item.
DefaultValue	ReportParameter	Specifies the default value to use for the parameter.
DepthRatio	ThreeDProperties	Indicates the ratio of height to width.
Description	Report	Provides a long description of the report.
DetailDataCollectionName	Table	Contains the name of the data element of the collection containing all instances of the group in a report rendered using a data rendering extension, such as XML or CSV.
DetailDataElementName	Table	Contains the name of the data element for instances of the group in a report rendered using a data rendering extension, such as XML or CSV.
DetailDataElementOutput	Table	Indicates whether the details appear in output rendered by the XML rendering extension.
Details	Table	Defines the details rows for a table.
Direction	SortBy	Indicates whether the items are sorted in ascending or descending order.
Direction	Style	Specifies the direction of text and matrices.
DrawingStyle	ThreeDProperties	Specifies shape of the columns or bars in a three-dimensional chart.
Drillthrough	Action	Contains a reference to a report to be opened through a drillthrough action.
DynamicCategories	CategoryGrouping	Defines the a category level that repeats with each category group in a chart.
DynamicColumns	ColumnGrouping	Defines dynamic column headings for a grouping.
DynamicRows	RowGrouping	Defines dynamic row headings for a grouping.
DynamicSeries	SeriesGrouping	Defines a series level that repeats with each series group in a chart.
EmbeddedImage	EmbeddedImages	Contains an image that is embedded within a report.
EmbeddedImages	Report	Contains the images that are embedded within a report.
Enabled	ThreeDProperties	Indicates whether the chart is three-dimensional.
Field	Fields	Describes a field in the dataset.
Fields	DataSet	Contains the fields in the dataset.
Filter	Filters	Contains a list of filters that restrict rows of data in a dataset or data region, or restrict group instances in a grouping.
FilterExpression	Filter	Contains an expression that is evaluated for each row of data or group.
Filters	Chart, DataSet, Grouping, List, Matrix, Table	Contains a collection of filter lists to apply to a dataset, data region, or grouping.
FilterValue	FilterValues	Contains a value to compare against a filter expression.
FilterValues	Filter	Contains a collection of values to compare against a filter expression.
FontFamily	Style	Contains the name of the font for the item.
FontSize	Style	Indicates the point size of the font for the item.
FontStyle	Style	Indicates the style of the font for the item.
FontWeight	Style	Indicates the weight of the font for the item.
Footer	Table, TableGroup	Defines the footer rows for a table or group.
Format	Style	Contains the Microsoft .NET Framework formatting string for the item.
GapDepth	ThreeDProperties	Indicates the percent depth gap between three-dimensional bars and columns.
GroupExpression	GroupExpressions	Defines an individual expression by which to group the data.
GroupExpressions	Grouping	Contains an ordered list of expressions by which to group the data.
Grouping	Details, DynamicCategories, DynamicColumns, DynamicRows, DynamicSeries, List, TableGroup	Defines how the data is grouped.
GroupsBeforeRowHeaders	Matrix	Indicates the number of instances of the outermost column group to appear outside the row headers.
Header	Table, TableGroup	Defines the header rows for a table or group.
Height	Body, Chart, ColumnGrouping, CustomReportItem, Details, Footer, Header, Image, Line, List, Matrix, MatrixRow, PageFooter, PageHeader, Rectangle, Subreport, Table, Textbox	Indicates the height of the item.
HeightRatio	ThreeDProperties	Indicates the ratio of height to width.
Hidden	Visibility	Indicates whether the item should initially be shown on the report.
HideDuplicates	Textbox	Indicates whether an item is displayed when its current value is the same as its value in the previous row.
Hyperlink	Action	Contains the URL of the target object.
Image	ReportItems	Contains an image to be displayed in the report.
ImageData	EmbeddedImage	Contains encoded image data.
Inclination	ThreeDProperties	Indicates the angle of inclination.
InitialState	ToggleImage	Determines the initial state of the toggle image.
InsidePlotArea	Legend	Indicates whether the legend is drawn inside the plot area of a chart.
InstanceName	Class	Contains the name of the variable to which the class is assigned.
IntegratedSecurity	ConnectionProperties	Indicates whether the data source uses integrated security to connect.
InteactiveHeight	Report	Specifies the default height of a report that is rendered in the HTML or GDI rendering extensions.
InteractiveWidth	Report	Specifies the default width of a report that is rendered in the HTML or GDI rendering extensions.
Interlaced	Axis	Indicates whether alternating dark stripes are drawn between grid lines.
KanatypeSensitivity	DataSet	Indicates whether the data is kanatype-sensitive.
KeepTogether	Chart, List, Matrix, Table	Indicates whether all sections of the data region are kept together on one page.
Label	DynamicCategories, DynamicSeries, StaticMember	Provides a label for items in a chart.
Label	ParameterValue	Contains the label to display to the user for the parameter.
Label	Chart, Grouping, Image, Line, List, Matrix, Rectangle, Subreport, Table, Textbox	Provides a user-friendly label for an instance of an item within a report.
LabelField	DataSetReference	Contains the name of the field that displays a parameter value to the user.
Language	Report	Indicates the primary language of the text in the report.
Language	Style	Indicates the primary language of the text.
Layout	Legend	Determines the arrangement of labels within the legend.
LayoutDirection	Matrix	Indicates whether matrix columns read left-to-right or right-to-left.
Left	BorderColor	Describes the color of the left border of the item.
Left	BorderStyle	Describes the style of the bottom border of the item.
Left	BorderWidth	Describes the width of the left border of the item.
Left	Chart, CustomReportItem, Image, Line, List, Matrix, Rectangle, Subreport, Table, Textbox	Indicates the distance of the item from the left of the containing item.
LeftMargin	Report	Specifies the width of the left margin of the report.
Legend	Chart	Defines the chart legend.
Line	ReportItems	Defines a line to be drawn in the report.
LineHeight	Style	Describes the height of a line of text.
LinkToChild	Rectangle	Contains the name of a child report item that is the target location for the document map label.
List	ReportItems	Defines a list region to be included in the report.
LogScale	Axis	Indicates whether the axis is logarithmic.
MajorGridLines	Axis	Defines the major grid lines in the chart.
MajorInterval	Axis	Indicates the interval between major gridlines on an axis.
MajorTickMarks	Axis	Indicates the position of the major tick marks on the axis.
Margin	Axis	Indicates whether the chart contains an axis margin.
Marker	DataPoint	Defines a marker for displayed chart data values.
Matrix	ReportItems	Defines a grid of regions that repeats with each column group and row group.
MatrixCell	MatrixCells	Defines the contents of each detail cell in a matrix.
MatrixCells	MatrixRow	Defines the set of cells in a row of the detail section of a matrix.
MatrixColumn	MatrixColumns	Defines a column in the detail section of a matrix.
MatrixColumns	Matrix	Defines a set of columns in the detail section of a matrix.
MatrixRow	MatrixRows	Defines a row in the detail section of a matrix.
MatrixRows	Matrix	Defines the set of rows in the detail section of a matrix.
Max	Axis	Indicates the maximum value of the axis.
MergeTransactions	Subreport	Indicates whether transactions in the subreport are merged with transactions in the parent report when both reports use the same data sources.
MIMEType	BackgroundImage, EmbeddedImage, Image	Identifies the Multipurpose Internet Mail Extensions (MIME) type of the image.
Min	Axis	Indicates the minimum value of the axis.
MinorGridLines	Axis	Defines the minor grid lines in the chart.
MinorInterval	Axis	Indicates the interval between minor gridlines on an axis.
MinorTickMarks	Axis	Indicates the position of the minor tick marks on the axis.
NoRows	Chart, List, Matrix, Subreport, Table	Specifies the text to display when no rows are returned by the datasets in a subreport or data region.
Nullable	ReportParameter	Indicates whether the value for the parameter can be null.
NumeralLanguage	Style	Specifies the language to use to format numbers.
NumeralVariant	Style	Specifies the language variant to use to format numbers.
Omit	Parameter	Indicates that the parameter is ignored when a user opens a report using a drillthrough link on another report.
Operator	Filter	Specifies an operator by which to compare the values in the FilterExpression and FilterValues elements.
PaddingBottom	Style	Designates the amount of padding below the item.
PaddingLeft	Style	Designates the amount of padding to the left of the item.
PaddingRight	Style	Designates the amount of padding to the right of the item.
PaddingTop	Style	Designates the amount of padding above the item.
PageBreakAtEnd	Chart, Grouping, List, Matrix, Rectangle, Table	Indicates that the rendering extension should insert a page break at the end of the item.
PageBreakAtStart	Chart, Grouping, List, Matrix, Rectangle, Table	Indicates that the rendering extension should insert a page break at the beginning of the item.
PageFooter	Report	Contains a footer that is rendered at the bottom of each page of the report.
PageHeader	Report	Contains a header that is rendered at the top of each page of the report.
PageHeight	Report	Specifies the default height of the report.
PageWidth	Report	Specifies the default width of the report.
Palette	Chart	Specifies the color palette for chart items.
Parameter	Parameters	Contains a parameter to pass to a report or control.
Parameters	Drillthrough, Subreport	Contains a list of parameters to pass to the report or control.
ParameterValue	ParameterValues	Provides a hard-coded value for a parameter.
ParameterValues	ValidValues	Provides a list of hard-coded values for a parameter.
Parent	Grouping	Identifies the parent group in a recursive hierarchy.
Perspective	ThreeDProperties	Indicates the percent of perspective.
PlotArea	Chart	Defines properties for the plot area of chart types with x- and y- axes.
PlotType	ChartSeries	Indicates whether the series is plotted as a line on a column chart.
PointWidth	Chart	Specifies the width of columns and bars in a chart.
Position	DataLabel	Indicates the position of the data label.
Position	Legend	Indicates the position of the legend.
Position	Subtotal	Indicates whether the subtotal rows or columns appear before or after the details rows or columns.
Position	Title	Indicates the position of the title.
PrintOnFirstPage	PageFooter, PageHeader	Indicates whether the page header is rendered on the first page of the report.
PrintOnLastPage	PageFooter, PageHeader	Indicates whether the page header is rendered on the last page of the report.
ProjectionMode	ThreeDProperties	Specifies the projection mode for the three-dimensional chart.
Prompt	ConnectionProperties	Contains the text that the user interface displays when prompting the user for database credentials.
Prompt	ReportParameter	Designates the text to display when the user interface prompts the user for parameter values.
Query	DataSet	Contains query information for the dataset.
QueryParameter	QueryParameters	Contains information about an individual parameter that is passed to the data source as part of a query.
QueryParameters	Query	Contains a list of parameters to pass to the data source.
Rectangle	ReportItems	Defines a rectangle to be drawn in the report.
RepeatOnNewPage	Footer, Header	Indicates whether the header or footer should be displayed with the table on each page.
RepeatWith	Image, Line, Rectangle, Textbox	Provides the name of the data region with which to repeat the report item if the data region spans multiple pages.
Report	(none)	Top-level element of the report.
ReportItems	Body, Corner, DynamicColumns, DynamicRows, List, MatrixCell, PageFooter, PageHeader, Rectangle, StaticColumn, StaticRow, Subtotal, TableCell	Contains the report items that define the contents of a report region.
ReportName	Drillthrough, Subreport	Contains the path and name of the target report.
ReportParameter	ReportParameters	Describes an individual parameter in the report.
ReportParameters	Report	Contains an ordered list of parameters in the report.
Reverse	Axis	Indicates whether the axis direction is reversed.
Right	BorderColor	Describes the color of the right border of the item.
Right	BorderStyle	Describes the style of the right border of the item.
Right	BorderWidth	Describes the width of the right border of the item.
RightMargin	Report	Specifies the width of the right margin of the report.
Rotation	DataLabel, ThreeDProperties	Indicates the angle of rotation.
RowGrouping	RowGroupings	Defines a row header region in a matrix.
RowGroupings	Matrix	Contains the set of row groupings for a matrix.
Scalar	Axis	Indicates whether the values on the axis are scalar.
SeriesGrouping	SeriesGroupings	Defines a series level for a series grouping in a chart.
SeriesGroupings	Chart	Defines a set of series groupings for the chart.
Shading	ThreeDProperties	Defines the shading of the three-dimensional chart.
ShowGridLines	MajorGridLines, MinorGridLines	Indicates whether gridlines are displayed in the chart.
Size	Marker	Indicates the size of the marker.
Sizing	Image	Determines the appearance of the image if it does not fit within the height and width of the Image element.
SortBy	Sorting	Defines an individual expression by which to sort the data.
SortExpression	SortBy	Contains the expression by which to sort the data.
Sorting	Details, DynamicColumns, DynamicRows, List, TableGroup	Defines how to sort the data.
Source	BackgroundImage, Image	Indicates the source of the image.
StaticCategories	CategoryGrouping	Defines a category level with a fixed set of members.
StaticColumn	StaticColumns	Defines a fixed column header region in a matrix.
StaticColumns	ColumnGrouping	Defines static column headings for the grouping.
StaticMember	StaticCategories, StaticSeries	Defines a label to display for a static series or category member.
StaticRow	StaticRows	Defines a fixed row header region in a matrix.
StaticRows	RowGrouping	Defines static headings for the grouping.
StaticSeries	SeriesGrouping	Defines a series level with a fixed set of members.
Style	Axis, Body, Chart, DataLabel, DataPoint, Image, Legend, Line, List, MajorGridLines, Marker, Matrix, MinorGridLines, PageFooter, PageHeader, PlotArea, Rectangle, Subreport, Subtotal, Table, Textbox	Contains information about the style of an item.
Subreport	ReportItems	Contains information about a report to be included within the report.
Subtotal	DynamicColumns, DynamicRows	Defines a subtotal column or row to be included in the matrix.
Subtype	Chart	Indicates the subtype of the chart.
Table	ReportItems	Defines a table to be included in the report.
TableCell	TableCells	Defines the contents of each cell in a table.
TableCells	TableRow	Defines a set of cells in a table.
TableColumn	TableColumns	Defines a column in a table.
TableColumns	Table	Contains a set of columns in a table.
TableGroup	TableGroups	Defines a group in a table.
TableGroups	Table	Contains a set of groups in a table.
TableRow	TableRows	Defines a row in a table.
TableRows	Header, Footer, Details	Contains an ordered list of table rows.
TextAlign	Style	Describes the horizontal alignment of the text of the item.
Textbox	ReportItems	Defines a text box to be drawn in the report.
TextDecoration	Style	Describes special text formatting for the item.
ThreeDProperties	Chart	Defines a the three-dimensional properties of a chart.
Timeout	Query	Specifies the number of seconds the query runs before timing out.
Title	Axis, Chart	Contains the title of the item.
ToggleImage	Textbox	Indicates that a toggle image is displayed as a part of the text box.
ToggleItem	Visibility	Specifies the text box that users click to show or hide the current item.
ToolTip	Chart, Image, List, Matrix, Rectangle, Subreport, Table, Textbox	Contains a text label for the item.
Top	BorderColor	Describes the color of the top border of the item.
Top	BorderStyle	Describes the style of the top border of the item.
Top	BorderWidth	Describes the width of the top border of the item.
Top	Chart, CustomReportItem, Image, Line, List, Matrix, Rectangle, Subreport, Table, Textbox	Indicates the distance of the item from the top of the containing item.
TopMargin	Report	Specifies the top margin of the report.
Transaction	DataSource	Indicates that the datasets using the data source should be executed in a single transaction.
Type	Chart	Indicates the type of the chart.
Type	Marker	Indicates the type of the marker.
UnicodeBiDi	Style	Indicates the level of bi-directional embedding.
UsedInQuery	ReportParameter	Indicates whether a report parameter is used in queries within the report.
ValidValues	ReportParameter	Provides a list of possible values for a parameter.
Value	DataLabel	Contains the expression for the value labels.
Value	DataValue	Contains the value of the data point.
Value	Field	Contains an expression that evaluates to the value of the field.
Value	Image, BackgroundImage	Identifies the source of the image.
Value	Parameter	Contains the value for an individual parameter that is passed to a report or control.
Value	ParameterValue	Contains a possible value for the parameter.
Value	QueryParameter	Contains the value to pass to the data source.
Value	Textbox	Contains the value of the text box.
Value	Values	Contains the default value for a parameter.
ValueAxis	Chart	Defines the value axis of the chart.
ValueField	DataSetReference	Contains the name of the field that provides the valid values or the default value of the parameter.
Values	DefaultValue	Contains the hard-coded default values for the parameter.
VerticalAlign	Style	Describes the vertical alignment of the text of the item.
Visibility	Chart, CustomReportItem, Details, DynamicColumns, DynamicRows, Image, Line, List, Matrix, Rectangle, Subreport, Table, TableColumn, TableGroup, TableRow, Textbox	Indicates whether the item is displayed in the rendered report.
Visible	Axis, DataLabel, Legend	Indicates whether the item is displayed in the chart.
WallThickness	ThreeDProperties	Indicates the percent thickness of the outer walls of the three-dimensional chart.
Width	Chart, CustomReportItem, Image, Line, List, Matrix, MatrixColumn, Rectangle, Report, RowGrouping, Subreport, Table, TableColumn, Textbox	Indicates the width of the item.
WidthSensitivity	DataSet	Indicates whether the data is width-sensitive.
WritingMode	Style	Indicates whether the text is written horizontally or vertically.
ZIndex	Chart, CustomReportItem, Image, Line, List, Matrix, Rectangle, Subreport, Table, Textbox	Indicates the drawing order of the item within the containing item.

Report Definition XML Elements

In This Section

See Also

Concepts

Other Resources

Help and Information

Additional resources