Back to all docs
API Reference / Telerik.Reporting / ReportItemBase
New to Telerik Reporting? Start a free 30-day trial

ReportItemBase

Class

Defines the base class for visual report items used for creating reports.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:
C#
[ToolboxBitmap(typeof(ReportItemBase), "Resources.ReportItemBase.bmp")]
public abstract class ReportItemBase : ReportObject, IToggleVisibilityTarget, IActionTarget

Inheritance: objectReportObjectReportItemBase

Derived Classes: ReportReportItemReportSectionBase

Implements: IActionTargetIToggleVisibilityTarget

Inherited Members ReportObject.ToString(string[])

Constructors

ReportItemBase()

TODO: Add documentation.

C#
protected ReportItemBase()

Properties

AccessibleDescription

string

Gets or sets the accessible description for the current report item.

C#
public string AccessibleDescription { get; set; }

AccessibleRole

string

Gets or sets the accessible role for the current report item.

C#
public string AccessibleRole { get; set; }

Action

Gets or sets an interactive action associated with this report item.

C#
public virtual IAction Action { get; set; }

AIDescription

string

Gets or sets the current report item's AI description, adding context for the model used in the GenAI-powered preview insights.

C#
public string AIDescription { get; set; }

Bindings

Gets the collection of binding rules contained within the report item.

C#
public BindingCollection Bindings { get; }
Property Value:

An collection of Binding instances representing the list of property bindings defined within the item.

Bookmark

string

Gets or sets a bookmark label to be displayed for this report item.

C#
[Obsolete("Please use BookmarkId and DocumentMapText instead.")]
[Browsable(false)]
public string Bookmark { get; set; }
Property Value:

A string / expression value specifying the bookmark label.

BookmarkId

string

Gets or sets a bookmark id for this item.

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

A string started with "=" is interpreted as an expression to calculate the resulting id, otherwise - literal string. Supports embedded expressions also. When processed should evaluate to an unique value for each processing instance of the item. Any duplicated occurrences at runtime get modified in order to avoid duplication in the resulting report.

Remarks:

BookmarkId must be used along with NavigateToBookmarkAction interactive action in order to specify the target of the action.

ConditionalFormatting

Gets the collection of the conditional formatting rules, associated with this item.

C#
public ConditionalFormatting ConditionalFormatting { get; }

Container

IContainer

TODO: Add documentation.

C#
[Browsable(false)]
public virtual IContainer Container { get; }

DesignMode

bool

TODO: Add documentation.

C#
[Browsable(false)]
public virtual bool DesignMode { get; }

DocumentMapText

string

Gets or sets a text to be displayed for this item in the document map.

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

A string started with "=" is interpreted as an expression to calculate the real data, otherwise - literal string. Supports embedded expressions also.

Remarks:

When defined the document map displays nodes that navigate to the instances of the item.

ItemDataBindingMethodName

string

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

C#
[AIAssistantExclude("")]
public string ItemDataBindingMethodName { get; set; }
Property Value:

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

ItemDataBoundMethodName

string

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

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

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

Items

Gets the collection of report items contained within the report item.

C#
[Browsable(false)]
[AIAssistantInclude("DetailSection, PageHeaderSection, PageFooterSection, GroupHeaderSection, GroupFooterSection, Panel, Table, List, Crosstab")]
public ReportItemBase.ItemCollection Items { get; }
Property Value:

An ReportItemBase.ItemCollection representing the collection of items contained within the item.

Name

string

Gets or sets the name of the report item.

C#
[Browsable(false)]
[AIAssistantRequired]
public string Name { get; set; }
Property Value:

The name of the report item.

Implements: IActionTarget.Name

Remarks:

The Name property can be used at run time to evaluate the object by name rather than type and programmatic name.

Parent

Gets or sets the parent container of the report item.

C#
[Browsable(false)]
public ReportItemBase Parent { get; set; }
Property Value:

A ReportItemBase that represents the parent item of the report item.

Remarks:

Setting the Parent property value to a null reference (Nothing in Visual Basic) removes the item from the ReportItemBase.ItemCollection of its current parent item.

Report

Gets the report this item belongs to.

C#
[Browsable(false)]
public Report Report { get; }
Property Value:

A Report object which the item belongs to.

Site

ISite

TODO: Add documentation.

C#
[Browsable(false)]
public virtual ISite Site { get; set; }

Style

Gets a Style object specifying the appearance of the report item.

C#
[TypeConverter(typeof(ExpandableObjectConverter))]
public Style Style { get; }
Property Value:

A Style object specifying the items' style.

StyleName

string

Gets or sets the name of the report item's global style.

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

A string value specifying the style name.

Remarks:

Global styles are defined through the Report's StyleSheet property.

TocLevel

string

Gets or sets the level for this item in the table of contents.

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

A string started with "=" is interpreted as an expression to calculate the actual level, otherwise - literal integer. Supports embedded expressions also.

Remarks:

Takes effect when the current item has TocText defined and sets its level to an explicit value. If omitted, the level is calculated automatically based on the report's item hierarchy.

TocText

string

Gets or sets a text to be displayed for this item in the table of contents.

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

A string started with "=" is interpreted as an expression to calculate the real data, otherwise - literal string. Supports embedded expressions also.

Remarks:

When defined the table of contents displays nodes that navigate to the instances of the item.

ToolTip

Gets the tooltip associated with the current report item.

C#
public ToolTip ToolTip { get; }

Visible

bool

Gets or sets a value indicating whether the report item is displayed.

C#
public bool Visible { get; set; }
Property Value:

true if the report item is displayed; otherwise, false. The default is true.

Methods

ClearGlobalDependencies()

TODO: Add documentation.

C#
protected void ClearGlobalDependencies()

Contains(ReportItemBase)

bool

Retrieves a value indicating whether the specified report item is a child of the report item.

C#
public bool Contains(ReportItemBase item)
Parameters:itemReportItemBase

The ReportItemBase to evaluate.

Returns:

bool

true if the specified report item is a child of the report item; otherwise, false.

Dispose()

TODO: Add documentation.

C#
public void Dispose()

Dispose(bool)

TODO: Add documentation.

C#
protected virtual void Dispose(bool disposing)
Parameters:disposingbool

GetEventHandlers(EventHandler)

Delegate[]

TODO: Add documentation.

C#
protected static Delegate[] GetEventHandlers(EventHandler eventHandler)
Parameters:eventHandlerEventHandlerReturns:

Delegate[]

OnItemValidate(ReportItemBase)

TODO: Add documentation.

C#
protected virtual void OnItemValidate(ReportItemBase item)
Parameters:itemReportItemBase

ToString()

string

Returns a string that represents the current ReportItemBase.

C#
public override string ToString()
Returns:

string

A String that contains the Name and the Type's FullName of the current ReportItemBase.

Overrides: object.ToString()

Events

Disposed

EventHandler

Occurs when the report item is disposed.

C#
public event EventHandler Disposed

ItemDataBinding

EventHandler

Occurs when the report item binds to a data source.

C#
public event EventHandler ItemDataBinding

ItemDataBound

EventHandler

Occurs after the report item binds to a data source.

C#
public event EventHandler ItemDataBound
In this article
DefinitionConstructorsReportItemBase()PropertiesAIDescriptionAccessibleDescriptionAccessibleRoleActionBindingsBookmarkBookmarkIdConditionalFormattingContainerDesignModeDocumentMapTextItemDataBindingMethodNameItemDataBoundMethodNameItemsNameParentReportSiteStyleStyleNameTocLevelTocTextToolTipVisibleMethodsClearGlobalDependencies()Contains(ReportItemBase)Dispose()Dispose(bool)GetEventHandlers(EventHandler)OnItemValidate(ReportItemBase)ToString()EventsDisposedItemDataBindingItemDataBound
Not finding the help you need?
Contact Support