ClassReportBook
Represents a collection of reports logically unified as a single document.
Definition
Namespace:Telerik.Reporting
Assembly:Telerik.Reporting.dll
Syntax:
[ToolboxBitmap(typeof(ReportBook), "Resources.ReportBook.bmp")]
public class ReportBook : Component, IReportDocumentInheritance: objectMarshalByRefObjectComponentReportBook
Implements:
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
reports
IEnumerable<Report>
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
reports
IEnumerable<Report>
documentName
string
Properties
DocumentName
Gets or sets a string representing the name of the document.
Declaration
public string DocumentName { get; set; }Property Value
string
A 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 string that starts with "=" is interpreted as an expression to evaluate the document name; otherwise it is interpreted as a literal string.
ReportSources
Gets the collection of reports that take part in this ReportBook.
Declaration
public ReportSourceCollection ReportSources { get; }Property Value
Reports
Gets the collection of reports that are parts of this ReportBook.
Declaration
[Obsolete("Please use ReportSources property instead.")]
[Browsable(false)]
public ReportCollection Reports { get; }Property Value
TocPosition
Gets or sets the ReportBookTocPosition for the Table of Contents in the Report Book.
Declaration
public ReportBookTocPosition TocPosition { get; set; }Property Value
TocReportSource
Gets or sets the ReportSource for the Table of Contents report.
Declaration
public ReportSource TocReportSource { get; set; }Property Value
Operators
implicit operator ReportSource(ReportBook)
TODO: Add documentation.
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
Returns