Class
Report

Represents the base class for any report in Telerik Reporting.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
[ToolboxBitmap(typeof(Report), "Resources.Report.bmp")]
public class Report : ReportItemBase, IToggleVisibilityTarget, IActionTarget, IDataItem, IDataFlow, IDataSourceContainer, IReportDocument

Inheritance: objectReportObjectReportItemBaseReport

Implements: IActionTargetIDataFlowIDataItemIDataSourceContainerIReportDocumentIToggleVisibilityTarget

Inherited Members ReportItemBase.Dispose()ReportItemBase.Dispose(bool)ReportItemBase.ToString()ReportItemBase.Contains(ReportItemBase)ReportItemBase.GetEventHandlers(EventHandler)ReportItemBase.OnItemValidate(ReportItemBase)ReportItemBase.ClearGlobalDependencies()ReportItemBase.ContainerReportItemBase.DesignModeReportItemBase.SiteReportItemBase.NameReportItemBase.ItemDataBindingMethodNameReportItemBase.ItemDataBoundMethodNameReportItemBase.VisibleReportItemBase.StyleNameReportItemBase.StyleReportItemBase.ItemsReportItemBase.ParentReportItemBase.ReportReportItemBase.ConditionalFormattingReportItemBase.BookmarkReportItemBase.BookmarkIdReportItemBase.DocumentMapTextReportItemBase.TocTextReportItemBase.ActionReportItemBase.BindingsReportItemBase.ToolTipReportItemBase.AccessibleDescriptionReportItemBase.AccessibleRoleReportItemBase.AIDescriptionReportItemBase.ItemDataBindingReportItemBase.ItemDataBoundReportItemBase.DisposedReportObject.ToString(string[])

Constructors

Report()

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

Declaration

cs-api-definition
public Report()

Properties

AutoRun

Gets or sets a value indicating whether the report should be rendered automatically upon initial preview.

Declaration

cs-api-definition
public bool AutoRun { get; set; }

Property Value

bool

A boolean representing the AutoRun behavior. The default value is true.

Remarks

When the report is referenced in a SubReport this property will not be respected.

Culture

Gets or sets the culture information associated with the report.

Declaration

cs-api-definition
public CultureInfo Culture { get; set; }

Property Value

CultureInfo

A CultureInfo representing the culture supported by the Report.

DataSource

Gets or sets the data source that the Report is displaying data for.

Declaration

cs-api-definition
[TypeConverter(typeof(DataSourceConverter))]
public object DataSource { get; set; }

Property Value

object

An object that functions as a data source.

Implements IDataSourceContainer.DataSource

Remarks

Telerik Reporting includes dedicated data source components that enable retrieving and feeding all data items from various sources. See all the available data source components at: https://docs.telerik.com/reporting/designing-reports/connecting-to-data/data-source-components/overview

For convenience, all the objects applicable to the DataSource property can be directly assigned to this DataSource property. At runtime, the report engine will wrap them in an ObjectDataSource to resolve the actual data.

DocumentName

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

Declaration

cs-api-definition
public string DocumentName { get; set; }

Property Value

string

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

Implements IReportDocument.DocumentName

Remarks

The value of this property is used to suggest a file name when exporting a report to one of the available export formats. This property value is not used when exporting from the standalone report designer. The report filename will be used instead.

Also used to specify the report name (root node) in the document map.

A string that starts with "=" is interpreted as an expression to evaluate the document name; otherwise it is interpreted as a literal string. The expression cannot contain any data fields.

ExternalStyleSheets

Gets the collection of ExternalStyleSheets for the report.

Declaration

cs-api-definition
[TypeConverter("Telerik.Reporting.Design.ExternalStyleSheetCollectionConverter, Telerik.Reporting.Design, Version=20.0.26.304, Culture=neutral, PublicKeyToken=a9d7983dfcc261be")]
public ExternalStyleSheetCollection ExternalStyleSheets { get; }

Property Value

ExternalStyleSheetCollection

ExternalStyles

TODO: Add documentation.

Declaration

cs-api-definition
[Obsolete("Please use ExternalStyleSheets property instead.")]
[Browsable(false)]
public ICollection<string> ExternalStyles { get; }

Property Value

ICollection<string>

Filters

Gets a FilterCollection that defines the filter expression(s) for the Report

Declaration

cs-api-definition
public FilterCollection Filters { get; }

Property Value

FilterCollection

A FilterCollection that contains the Filter objects for the Report

Remarks

Filter expressions limit the data that is displayed to the user after the data is retrieved from the data source.

Groups

Gets a GroupCollection that defines the groups for the Report

Declaration

cs-api-definition
public GroupCollection Groups { get; }

Property Value

GroupCollection

A GroupCollection that contains the Group objects for the Report

Remarks

Grouping is used to gather all rows that match certain grouping criteria together. Grouping criteria is defined by adding one or more Grouping objects to a Group.

NeedDataSourceMethodName

Gets or sets the name of the method that should be called when the NeedDataSource event is triggered.

Declaration

cs-api-definition
public string NeedDataSourceMethodName { get; set; }

Property Value

string

A string value identifying the name of the method from the source assembly.

PageNumberingStyle

Gets or sets a PageNumberingStyle for the Report.

Declaration

cs-api-definition
public PageNumberingStyle PageNumberingStyle { get; set; }

Property Value

PageNumberingStyle

A PageNumberingStyle representing the page numbering style. The default value is Continue

Remarks

When the report is part of a ReportBook, use this property to indicate whether the page numbering / count should start from 1 or continue from the last page number / count of the previous report.

PageSettings

Gets or sets the page settings for the Report .

Declaration

cs-api-definition
public PageSettings PageSettings { get; set; }

Property Value

PageSettings

The page settings for the Report.

Implements IReportDocument.PageSettings

ReportEngineSettings

Gets an instance of ReportEngineSettings containing report-specific settings that will be respected by the reporting engine during the processing and rendering stage of the report lifecycle.

Declaration

cs-api-definition
public ReportEngineSettings ReportEngineSettings { get; }

Property Value

ReportEngineSettings

Example

This example illustrates how to set the caching of the report definition properties of a report.

cs
var report1 = new Report1();

// Set the CacheDefinitionProperties to CacheDefinitionProperties.No to allow modifying the report definition at runtime.
// Please note that this approach might cause inpredictable behavior and will decrease the processing performance.
report1.ReportEngineSettings.CacheDefinitionProperties = Telerik.Reporting.CacheDefinitionProperties.No;

ReportParameters

Gets a collection of report parameters.

Declaration

cs-api-definition
public ReportParameterCollection ReportParameters { get; }

Property Value

ReportParameterCollection

RuntimeSettings

Gets a collection containing report-specific export rendering settings.

Declaration

cs-api-definition
public RenderingSettingsCollection RuntimeSettings { get; }

Property Value

RenderingSettingsCollection

Remarks

When the report is part of a ReportBook this property will be respected for the first report in the book only.

Example

This example illustrates how to set the PDF Runtime settings of a report.

cs
var pdfSettings = new Telerik.Reporting.RenderingSettings() { Name = "PDF" };
pdfSettings.Parameters.Add(new Telerik.Reporting.Parameter() { Name = "DocumentAuthor", Value = "YourName" });
report1.RuntimeSettings.Add(pdfSettings);

SkipBlankPages

Gets or sets a value indicating whether pages without significant content should be output.

Declaration

cs-api-definition
public bool SkipBlankPages { get; set; }

Property Value

bool

A boolean representing the SkipBlankPages behavior. The default value is true.

Remarks

When the report is part of a ReportBook this property will be respected for the corresponding report in the book.

Sorting

TODO: Add documentation.

Declaration

cs-api-definition
[Browsable(false)]
[Obsolete("Please use Sortings property instead.")]
public SortingCollection Sorting { get; }

Property Value

SortingCollection

Sortings

Gets a SortingCollection that defines the sort column(s), and their type and order for the Report

Declaration

cs-api-definition
public SortingCollection Sortings { get; }

Property Value

SortingCollection

A SortingCollection that contains the Sorting objects for the Report

Remarks

Sort expressions sort the data that is displayed to the user after the data is retrieved from the data source.

StyleSheet

Gets the StyleSheet associated with the report.

Declaration

cs-api-definition
public StyleSheet StyleSheet { get; }

Property Value

StyleSheet

A StyleSheet object representing a collection of style rules.

Remarks

The StyleSheet property of a report can be used to define various types of styles for use by the report items.

UnitOfMeasure

Gets or sets the default unit of measure for the report.

Declaration

cs-api-definition
public UnitType UnitOfMeasure { get; set; }

Property Value

UnitType

An UnitType representing the default unit of measure for the report.

Remarks

All newly created report items will have their locations, sizes, etc. in this UnitType.

Width

Gets or sets the width of the report.

Declaration

cs-api-definition
public Unit Width { get; set; }

Property Value

Unit

The width of the report in Units.

Methods

GetDataSources()

Gets all IDataSource instances available in the report definition, regardless if they are referenced by a data item or a report parameter.

Declaration

cs-api-definition
public IEnumerable<IDataSource> GetDataSources()

Returns

IEnumerable<IDataSource>

A read-only collection of IDataSource instances.

OnError(object, ErrorEventArgs)

TODO: Add documentation.

Declaration

cs-api-definition
protected virtual void OnError(object sender, ErrorEventArgs e)

Parameters

sender

object

e

ErrorEventArgs

OnNeedDataSource(object, EventArgs)

TODO: Add documentation.

Declaration

cs-api-definition
protected virtual void OnNeedDataSource(object sender, EventArgs e)

Parameters

sender

object

e

EventArgs

Events

Error

TODO: Add documentation.

Declaration

cs-api-definition
public event ErrorEventHandler Error

Event Value

ErrorEventHandler

NeedDataSource

Occurs when the processing of the report processing instance (i.e., Report/> instance) begins and this instance has no DataSource property set.

Declaration

cs-api-definition
public event EventHandler NeedDataSource

Event Value

EventHandler

Remarks

The event is hooked on the definition Report instance, but the sender object in the event handler is the processing Report/> instance. The processing instance of the report inherits its DataSource from the definition instance, but if neither has DataSource set, this event is raised.

Example

The following example demonstrates how to implement a NeedDataSource event handler:

cs
void report_NeedDataSource(object sender, EventArgs e)
{
    Telerik.Reporting.Processing.Report processingReport = (Telerik.Reporting.Processing.Report)sender;
    object processingParameterValue = processingReport.Parameters["parameter1"].Value;
    processingReport.DataSource = GetData(processingParameterValue);
}

static object GetData(object value)
{
    // Implement your custom data retrieval logic instead
    return new string[] { "Sofia", "London", "Tokyo" };
}
vb
Private Sub report_NeedDataSource(sender As Object, e As EventArgs)
    Dim processingReport As Telerik.Reporting.Processing.Report = DirectCast(sender, Telerik.Reporting.Processing.Report)
    Dim processingParameterValue As Object = processingReport.Parameters("parameter1").Value
    processingReport.DataSource = GetData(processingParameterValue)
End Sub
Private Shared Function GetData(value As Object) As Object

    ' Implement your custom data retrieval logic instead

    Return New String() {"Sofia", "London", "Tokyo"}
End Function 

Operators

implicit operator ReportSource(Report)

TODO: Add documentation.

Declaration

cs-api-definition
[Obsolete("The implicit Telerik.Reporting.Report 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(Report report)

Parameters

report

Report

Returns

ReportSource