Documentation

Class ReportBook

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

Inheritance
System.Object
ReportBook
Namespace: Telerik.Reporting
Assembly: Telerik.Reporting.dll

Syntax

public class ReportBook : Component, IReportDocument, IComponent, IDisposable

Constructors

ReportBook()

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

Declaration
public ReportBook()

ReportBook(IEnumerable<Report>)

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

Declaration
[Obsolete("Please use the default constructor and add the reports to the ReportSource collection.")]
public ReportBook(IEnumerable<Report> reports)
Parameters
System.Collections.Generic.IEnumerable<Report> reports

ReportBook(IEnumerable<Report>, String)

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

Declaration
[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
System.Collections.Generic.IEnumerable<Report> reports

System.String documentName

Properties

DocumentName

Gets or sets a System.String representing the name of the document.

Declaration
public string DocumentName { get; set; }
Property Value
System.String

A System.String representing the document name. The default value is the Type name of the ReportBook this property belongs to.
Implements
Remarks

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

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

Reports

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

Declaration
[Obsolete("Please use ReportSources property instead.")]
public ReportCollection Reports { get; }
Property Value
ReportCollection

ReportSources

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

Declaration
public ReportSourceCollection ReportSources { get; }
Property Value
ReportSourceCollection

TocPosition

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

Declaration
public ReportBookTocPosition TocPosition { get; set; }
Property Value
ReportBookTocPosition

TocReportSource

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

Declaration
public ReportSource TocReportSource { get; set; }
Property Value
ReportSource

See Also

Operators

Implicit(ReportBook to ReportSource)

Declaration
[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
ReportBook reportBook

Returns
ReportSource

Explicit Interface Implementations

IReportDocument.PageSettings

For internal use only.

Declaration
[Obsolete("Please use instead the Report.PageSettings property.")]
PageSettings IReportDocument.PageSettings { get; set; }
Returns
PageSettings

Implements

IReportDocument.ReportParameters

Gets the ReportParameters of the ReportBook. Parameters are obtained by merging the parameters of individual reports that have their Mergeable property set to true plus adding all non-mergable parameters.

Declaration
[Obsolete("Please use instead the ReportSource.Parameters of each individual ReportSource or wrap the report book into ReportSource and use its parametrs collection.")]
IEnumerable<IReportParameter> IReportDocument.ReportParameters { get; }
Returns
System.Collections.Generic.IEnumerable<IReportParameter>

Implements

IReportDocument.Reports

Gets the reports contained in the ReportBook.

Declaration
[Obsolete("Please use the ReportSources property instead.")]
IEnumerable<Report> IReportDocument.Reports { get; }
Returns
System.Collections.Generic.IEnumerable<Report>

Implements

IReportDocument.ReportSources

Declaration
IEnumerable<ReportSource> IReportDocument.ReportSources { get; }
Returns
System.Collections.Generic.IEnumerable<ReportSource>

Implements