Class ReportItem

Defines the base class for all report items that can be placed in a ReportSectionBase. Items of this type have a location and a size.

Inheritance

System.Object

ReportObject

ReportItemBase

ReportItem

Barcode

DataItem

HtmlTextBox

Panel

PictureBox

ShapeItemBase

SubReport

TextItemBase

Inherited Members

ReportItemBase.Dispose()

ReportItemBase.Dispose(Boolean)

ReportItemBase.ToString()

ReportItemBase.Contains(ReportItemBase)

ReportItemBase.OnItemValidate(ReportItemBase)

ReportItemBase.ClearGlobalDependencies()

ReportItemBase.Container

ReportItemBase.DesignMode

ReportItemBase.Site

ReportItemBase.Name

ReportItemBase.Visible

ReportItemBase.StyleName

ReportItemBase.Style

ReportItemBase.Items

ReportItemBase.Parent

ReportItemBase.Report

ReportItemBase.ConditionalFormatting

ReportItemBase.Bookmark

ReportItemBase.BookmarkId

ReportItemBase.DocumentMapText

ReportItemBase.TocText

ReportItemBase.Action

ReportItemBase.Bindings

ReportItemBase.ToolTip

ReportItemBase.AccessibleDescription

ReportItemBase.ItemDataBinding

ReportItemBase.ItemDataBound

ReportItemBase.Disposed

ReportObject.ToString(String[])

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Reporting

Assembly: Telerik.Reporting.dll

Syntax

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

Constructors

ReportItem()

Declaration

public ReportItem()

Properties

Anchor

Declaration

[Obsolete("Use the Anchoring property instead.")]
public AnchorStyles Anchor { get; set; }

Property Value

System.Windows.Forms.AnchorStyles

Anchoring

Gets or sets the edges of the container to which a report is bound and determines how a report items is resized with its parent.

Declaration

public AnchoringStyles Anchoring { get; set; }

Property Value

AnchoringStyles A bitwise combination of the AnchoringStyles values. The default is None.

Remarks

Use the Anchoring property to define how a report is automatically resized as its parent item is resized. Anchoring a report to its parent ensures that the anchored edges remain in the same position relative to the edges of the parent when the parent control is resized.

You can anchor a report item to one or more edges of its container. For example, if you have a DetailSection with a TextBox whose Anchoring property value is set to Top and Bottom, the TextBox is stretched to maintain the anchored distance to the top and bottom edges of the DetailSection as the Height of the DetailSection is increased.

Note:The Anchoring and Docking properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence.

Bottom

Gets the distance, in Units, between the bottom edge of the report item and the top edge of its container's client area.

Declaration

public Unit Bottom { get; }

Property Value

Unit An Unit representing the distance between the bottom edge of the report item and the top edge of its container's client area.

Remarks

The value of the Bottom property is equal to the sum of the Top property value and the Height property value.

Bounds

Gets or sets the size and location of the report item including its nonclient elements, in Units, relative to the parent report item.

Declaration

public RectangleU Bounds { get; set; }

Property Value

RectangleU A RectangleU relative to the parent report item that represents the size and location of the report item including its nonclient elements.

Remarks

The bounds of the report item include the nonclient elements such as borders and padding.

DefaultSize

Gets the default size of the report item.

Declaration

protected virtual SizeU DefaultSize { get; }

Property Value

SizeU The default SizeU of the report item.

Remarks

The DefaultSize property represents the SizeU of the report item when it is initially created. You can adjust the size of the report item by setting its Size property value.

Dock

Declaration

[Obsolete("The Telerik.Reporting.ReportItem.Dock property is now obsolete. Please use the Telerik.Reporting.ReportItem.Docking property instead.")]
public DockStyle Dock { get; set; }

Property Value

System.Windows.Forms.DockStyle

Docking

Gets or sets which report item borders are docked to its parent and determines how a report item is resized with its parent.

Declaration

public DockingStyle Docking { get; set; }

Property Value

DockingStyle One of the System.Windows.Forms.DockStyle values. The default is System.Windows.Forms.DockStyle.None.

Remarks

Use the Docking property to define how a report is automatically resized as its parent is resized. For example, setting Docking to System.Windows.Forms.DockStyle.Bottom causes the report item to align itself with the bottom edges of its parent and to resize as the parent is resized.

A report item can be docked to one edge of its parent container or can be docked to all edges and fill the parent container.

Note:The Anchoring and Docking properties are mutually exclusive. Only one can be set at a time, and the last one set takes precedence.

Height

Gets or sets the height of the report item.

Declaration

public Unit Height { get; set; }

Property Value

Unit The height of the report item in Units.

Remarks

Changes made to the Height and Top property values cause the Bottom property value of the report item to change.

Left

Gets or sets the distance, in Units, between the left edge of the report item and the left edge of its container's client area.

Declaration

public Unit Left { get; set; }

Property Value

Unit An Unit representing the distance between the left edge of the report item and the left edge of its container's client area.

Remarks

The Left property value is equivalent to the X property of the Location property value of the report item.

Changes made to the Width and Left property values cause the Right property value of the report item to change.

Location

Gets or sets the coordinates of the upper-left corner of the report item relative to the upper-left corner of its container.

Declaration

public virtual PointU Location { get; set; }

Property Value

PointU The PointU that represents the upper-left corner of the report item relative to the upper-left corner of its container.

Remarks

Because the PointU class is a value type (Structure in Visual Basic, struct in Visual C#), it is returned by value, meaning accessing the property returns a copy of the upper-left point of the report item. So, adjusting the X or Y properties of the PointU returned from this property will not affect the Left, Right, Top, or Bottom property values of the report item. To adjust these properties set each property value individually, or set the Location property with a new PointU.

Right

Gets the distance, in Units, between the right edge of the report item and the left edge of its container's client area.

Declaration

public Unit Right { get; }

Property Value

Unit An Unit representing the distance between the right edge of the report item and the left edge of its container's client area.

Remarks

The value of the Right property is equal to the sum of the Left property value and the Width property value.

Size

Gets or sets the height and width of the report item.

Declaration

public virtual SizeU Size { get; set; }

Property Value

SizeU The SizeU that represents the height and width of the report item in Units.

Remarks

Because the SizeU class is a value type (Structure in Visual Basic, struct in Visual C#), it is returned by value, meaning accessing the property returns a copy of the size of the report item. So, adjusting the Width or Height properties of the SizeU returned from this property will not affect the Width or Height of the report item. To adjust the Width or Height of the report item, you must set the item's Width or Height property, or set the Size property with a new SizeU.

Top

Gets or sets the distance, in Units, between the top edge of the report item and the top edge of its container's client area.

Declaration

public Unit Top { get; set; }

Property Value

Unit An Unit representing the distance between the top edge of the report item and the top edge of its container's client area.

Remarks

The Top property value is equivalent to the Y property of the Location property value of the report item.

Changes made to the Height and Top property values cause the Bottom property value of the report item to change.

Width

Gets or sets the width of the report item.

Declaration

public Unit Width { get; set; }

Property Value

Unit The width of the report item in Units.

Remarks

Changes made to the Width and Left property values cause the Right property value of the report item to change.