New to Telerik ReportingStart a free 30-day trial

Represents a collection of reports logically unified as a single document.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:

C#
[ToolboxBitmap(typeof(ReportBook), "Resources.ReportBook.bmp")]
public class ReportBook : Component, IReportDocument

Inheritance: objectMarshalByRefObjectComponentReportBook

Implements: IReportDocument

Constructors

Initializes a new instance of the ReportBook class with default settings.

C#
public ReportBook()

Initializes a new instance of the ReportBook class from the provided reports and document name.

C#
[Obsolete("Please use the default constructor, add the reports to the ReportSource collection and set document name.")]
public ReportBook(IEnumerable<Report> reports, string documentName)
Parameters:reportsIEnumerable<Report>documentNamestring

Initializes a new instance of the ReportBook class from the provided reports.

C#
[Obsolete("Please use the default constructor and add the reports to the ReportSource collection.")]
public ReportBook(IEnumerable<Report> reports)
Parameters:reportsIEnumerable<Report>

Properties

Gets or sets a string representing the name of the document.

C#
public string DocumentName { get; set; }
Property Value:

A string representing the document name. The default value is the Type name of the ReportBook this property belongs to.

Implements: IReportDocument.DocumentName

Remarks:

The value of this property is used to suggest a file name when exporting to one of the available export formats.

A string that starts with "=" is interpreted as an expression to evaluate the document name; otherwise it is interpreted as a literal string.

Gets the collection of reports that are parts of this ReportBook.

C#
[Obsolete("Please use ReportSources property instead.")]
[Browsable(false)]
public ReportCollection Reports { get; }

Gets the collection of reports that take part in this ReportBook.

C#
public ReportSourceCollection ReportSources { get; }

Gets or sets the ReportBookTocPosition for the Table of Contents in the Report Book.

C#
public ReportBookTocPosition TocPosition { get; set; }

Gets or sets the ReportSource for the Table of Contents report.

C#
public ReportSource TocReportSource { get; set; }

Operators

TODO: Add documentation.

C#
[Obsolete("The implicit Telerik.Reporting.ReportBook to Telerik.Reporting.ReportSource conversion is now obsolete. Please use a Telerik.Reporting.InstanceReportSource object instead. For more information, please visit: https://www.telerik.com/support/kb/reporting/general/q2-2012-api-changes-reportsources.aspx#reportprocessor.")]
public static implicit operator ReportSource(ReportBook reportBook)
Parameters:reportBookReportBookReturns:

ReportSource