Class ReportItemBase

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

Inheritance
System.Object
ReportObject
ReportItemBase
Report
ReportItem
ReportSectionBase
Inherited Members
Namespace: Telerik.Reporting
Assembly: Telerik.Reporting.dll

Syntax

public abstract class ReportItemBase : ReportObject, IReportItem, IComponent, IDisposable, IToggleVisibilityTarget, IActionTarget, IDesignTimeStyleEditable, INamedObject, IDesignTimeSelectable

Constructors

ReportItemBase()

Declaration
protected ReportItemBase()

Properties

AccessibleDescription

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

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

AccessibleRole

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

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

Action

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

Declaration
public virtual IAction Action { get; set; }
Property Value
IAction

AIDescription

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

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

Bindings

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

Declaration
public BindingCollection Bindings { get; }
Property Value
BindingCollection

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

Bookmark

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

Declaration
[Obsolete("Please use BookmarkId and DocumentMapText instead.")]
public string Bookmark { get; set; }
Property Value
System.String

A string / expression value specifying the bookmark label.

BookmarkId

Gets or sets a bookmark id for this item.

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

A System.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.

Declaration
public ConditionalFormatting ConditionalFormatting { get; }
Property Value
ConditionalFormatting

Container

Declaration
public virtual IContainer Container { get; }
Property Value
System.ComponentModel.IContainer

DesignMode

Declaration
public virtual bool DesignMode { get; }
Property Value
System.Boolean

DocumentMapText

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

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

A System.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

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

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

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

ItemDataBoundMethodName

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

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

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.

Declaration
public ReportItemBase.ItemCollection Items { get; }
Property Value
ReportItemBase.ItemCollection

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

Name

Gets or sets the name of the report item.

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

The name of the report item.
Implements
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.

Declaration
public ReportItemBase Parent { get; set; }
Property Value
ReportItemBase

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.

Declaration
public Report Report { get; }
Property Value
Report

A Report object which the item belongs to.

Site

Declaration
public virtual ISite Site { get; set; }
Property Value
System.ComponentModel.ISite

Style

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

Declaration
public Style Style { get; }
Property Value
Style

A Style object specifying the items' style.

StyleName

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

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

A string value specifying the style name.
Remarks

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

TocText

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

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

A System.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.

Declaration
public ToolTip ToolTip { get; }
Property Value
ToolTip

Visible

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

Declaration
public bool Visible { get; set; }
Property Value
System.Boolean

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

Methods

ClearGlobalDependencies()

Declaration
protected void ClearGlobalDependencies()

Contains(ReportItemBase)

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

Declaration
public bool Contains(ReportItemBase item)
Parameters
ReportItemBase item

The ReportItemBase to evaluate.
Returns
System.Boolean

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

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
System.Boolean disposing

GetEventHandlers(EventHandler)

Declaration
protected static Delegate[] GetEventHandlers(EventHandler eventHandler)
Parameters
System.EventHandler eventHandler

Returns
System.Delegate[]

OnItemValidate(ReportItemBase)

Declaration
protected virtual void OnItemValidate(ReportItemBase item)
Parameters
ReportItemBase item

ToString()

Returns a System.String that represents the current ReportItemBase.

Declaration
public override string ToString()
Returns
System.String

A String that contains the Name and the Type's FullName of the current ReportItemBase.
Overrides
System.Object.ToString()

Events

Disposed

Occurs when the report item is disposed.

Declaration
public event EventHandler Disposed
Event Type
System.EventHandler

ItemDataBinding

Occurs when the report item binds to a data source.

Declaration
public event EventHandler ItemDataBinding
Event Type
System.EventHandler

ItemDataBound

Occurs after the report item binds to a data source.

Declaration
public event EventHandler ItemDataBound
Event Type
System.EventHandler