Back to all docs
API Reference / Telerik.Reporting / ReportItemBase

Class
ReportItemBase

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

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:
cs-api-definition
[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.

Declaration

cs-api-definition
protected ReportItemBase()

Properties

AIDescription

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

Declaration

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

Property Value

string

AccessibleDescription

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

Declaration

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

Property Value

string

AccessibleRole

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

Declaration

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

Property Value

string

Action

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

Declaration

cs-api-definition
public virtual IAction Action { get; set; }

Property Value

IAction

Bindings

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

Declaration

cs-api-definition
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

cs-api-definition
[Obsolete("Please use BookmarkId and DocumentMapText instead.")]
[Browsable(false)]
public string Bookmark { get; set; }

Property Value

string

A string / expression value specifying the bookmark label.

BookmarkId

Gets or sets a bookmark id for this item.

Declaration

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

Property Value

string

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.

Declaration

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

Property Value

ConditionalFormatting

Container

TODO: Add documentation.

Declaration

cs-api-definition
[Browsable(false)]
public virtual IContainer Container { get; }

Property Value

IContainer

DesignMode

TODO: Add documentation.

Declaration

cs-api-definition
[Browsable(false)]
public virtual bool DesignMode { get; }

Property Value

bool

DocumentMapText

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

Declaration

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

Property Value

string

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

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

Declaration

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

Property Value

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

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

Property Value

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

cs-api-definition
[Browsable(false)]
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

cs-api-definition
[Browsable(false)]
public string Name { get; set; }

Property Value

string

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.

Declaration

cs-api-definition
[Browsable(false)]
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

cs-api-definition
[Browsable(false)]
public Report Report { get; }

Property Value

Report

A Report object which the item belongs to.

Site

TODO: Add documentation.

Declaration

cs-api-definition
[Browsable(false)]
public virtual ISite Site { get; set; }

Property Value

ISite

Style

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

Declaration

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
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

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

Property Value

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

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

Property Value

string

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.

Declaration

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

Property Value

ToolTip

Visible

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

Declaration

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

Property Value

bool

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

Methods

ClearGlobalDependencies()

TODO: Add documentation.

Declaration

cs-api-definition
protected void ClearGlobalDependencies()

Contains(ReportItemBase)

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

Declaration

cs-api-definition
public bool Contains(ReportItemBase item)

Parameters

item

ReportItemBase

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.

Declaration

cs-api-definition
public void Dispose()

Dispose(bool)

TODO: Add documentation.

Declaration

cs-api-definition
protected virtual void Dispose(bool disposing)

Parameters

disposing

bool

GetEventHandlers(EventHandler)

TODO: Add documentation.

Declaration

cs-api-definition
protected static Delegate[] GetEventHandlers(EventHandler eventHandler)

Parameters

eventHandler

EventHandler

Returns

Delegate[]

OnItemValidate(ReportItemBase)

TODO: Add documentation.

Declaration

cs-api-definition
protected virtual void OnItemValidate(ReportItemBase item)

Parameters

item

ReportItemBase

ToString()

Returns a string that represents the current ReportItemBase.

Declaration

cs-api-definition
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

Occurs when the report item is disposed.

Declaration

cs-api-definition
public event EventHandler Disposed

Event Value

EventHandler

ItemDataBinding

Occurs when the report item binds to a data source.

Declaration

cs-api-definition
public event EventHandler ItemDataBinding

Event Value

EventHandler

ItemDataBound

Occurs after the report item binds to a data source.

Declaration

cs-api-definition
public event EventHandler ItemDataBound

Event Value

EventHandler

In this article
DefinitionConstructorsReportItemBase()PropertiesAIDescriptionAccessibleDescriptionAccessibleRoleActionBindingsBookmarkBookmarkIdConditionalFormattingContainerDesignModeDocumentMapTextItemDataBindingMethodNameItemDataBoundMethodNameItemsNameParentReportSiteStyleStyleNameTocTextToolTipVisibleMethodsClearGlobalDependencies()Contains(ReportItemBase)Dispose()Dispose(bool)GetEventHandlers(EventHandler)OnItemValidate(ReportItemBase)ToString()EventsDisposedItemDataBindingItemDataBound
Not finding the help you need?
Contact Support