CustomReportItem Class

Article
02/01/2013

Represents a report item that is not natively defined in RDL.

Inheritance Hierarchy

System.Object
  Microsoft.ReportingServices.RdlObjectModel.ReportObjectBase
    Microsoft.ReportingServices.RdlObjectModel.ReportObject
      Microsoft.ReportingServices.RdlObjectModel.ReportElement
        Microsoft.ReportingServices.RdlObjectModel.ReportItem
          Microsoft.ReportingServices.RdlObjectModel.CustomReportItem

Namespace: Microsoft.ReportingServices.RdlObjectModel
Assembly: Microsoft.ReportingServices.Designer.Controls (in Microsoft.ReportingServices.Designer.Controls.dll)

Syntax

'Declaration
Public Class CustomReportItem _
    Inherits ReportItem
'Usage
Dim instance As CustomReportItem

public class CustomReportItem : ReportItem

public ref class CustomReportItem : public ReportItem

type CustomReportItem =  
    class 
        inherit ReportItem 
    end

public class CustomReportItem extends ReportItem

The CustomReportItem type exposes the following members.

Constructors

	Name	Description
	CustomReportItem	Creates a new instance of the CustomReportItem class.

Top

Properties

	Name	Description
	ActionInfo	Gets or sets the actions that are associated with the ReportItem. (Inherited from ReportItem.)
	AllowInHeaderFooter	When overridden in a derived class, gets a value that indicates whether the custom report item is allowed in header or footer. (Overrides ReportItem.AllowInHeaderFooter.)
	AltReportItem	Gets or sets the report item to render instead of the custom report item, if the custom item type is not supported natively.
	Bookmark	Gets or sets a bookmark that can be linked to by using a Bookmark action. (Inherited from ReportItem.)
	ComponentMetadata	Gets or sets the component metadata. (Inherited from ReportObject.)
	ContainedReportItems	Infrastructure. Gets or sets the items contained in the report. (Overrides ReportItem.ContainedReportItems.)
	CustomData	Gets or sets the data to be passed to the custom report item control.
	CustomProperties	Gets or sets the custom information to be handed to the report rendering component. (Inherited from ReportItem.)
	DataElementName	Gets or sets the name to use for the data element/attribute for this report item. (Inherited from ReportItem.)
	DataElementOutput	Gets or sets a value that indicates whether the item should appear in a data rendering. (Inherited from ReportItem.)
	DocumentMapLabel	Gets or sets a label to identify an instance of a report item within the client UI, This provides a user-friendly label for searching. (Inherited from ReportItem.)
	DocumentMapLabelLocID	Gets or sets the unique identifier for the DocumentMapLabel property. (Inherited from ReportItem.)
	Height	Gets or sets the height of the item. (Inherited from ReportItem.)
	Left	Gets or sets the distance of the item from the left of the containing object. (Inherited from ReportItem.)
	Name	Gets or sets the name of the report item. (Inherited from ReportItem.)
	Parent	The parent of this report object. (Inherited from ReportObjectBase.)
	RepeatWith	Gets or sets the name of a data region that this report item should be repeated with if that data region spans multiple pages. (Inherited from ReportItem.)
	Site	Infrastructure. Gets or sets the site associated with the ReportObject object. (Inherited from ReportObject.)
	Style	Gets the style properties of this report definition object. (Inherited from ReportElement.)
	ToolTip	Gets or sets a textual label for the report item. Used for such things as rendering TITLE and ALT attributes in HTML reports. (Inherited from ReportItem.)
	ToolTipLocID	Gets or sets the unique identifier for the ToolTip property. (Inherited from ReportItem.)
	Top	Gets or sets the distance of the item from the top of the containing object. (Inherited from ReportItem.)
	Type	Gets or sets the type of the custom report item.
	Visibility	Gets or sets the current visibility state of this report object. (Inherited from ReportItem.)
	Width	Gets or sets the width of the item. Negative sizes allowed only for lines. (Inherited from ReportItem.)
	ZIndex	Gets or sets the drawing order of the report item within the containing object. (Inherited from ReportItem.)

Top

Methods

	Name	Description
	DeepClone	Returns a deep clone of this ReportObject instance. (Inherited from ReportObject.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetContainingDataScopes	Infrastructure. Returns the list of report object that contains data scopes. (Inherited from ReportObject.)
	GetDataScopesForDefaultImpl	Infrastructure. Returns the data scopes for default implementation. (Inherited from ReportObject.)
	GetDependenciesCore	Infrastructure. Returns the dependencies core for the ReportObject object. (Inherited from ReportObject.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Initialize	Initializes an instance of the CustomReportItem class. (Overrides ReportItem.Initialize().)
	InitializeForDesigner	Infrastructure. Initializes the properties of an instance of the ReportItem class for the designer. (Inherited from ReportItem.)
	MemberwiseClone	(Inherited from Object.)
	OnChildPropertyChanged	Infrastructure. Raises an event when the property of the child was changed. (Inherited from ReportObject.)
	OnPropertyChanged	Infrastructure. Raises an event when the property was changed. (Inherited from ReportObject.)
	RdlSemanticEqualsCore	Infrastructure. Returns whether the report definition language semantic is the same with the core object. (Inherited from ReportObject.)
	SavePropertyValue<T>	Infrastructure. Saves the property value of the report object. (Inherited from ReportObject.)
	ToString	(Inherited from Object.)

Top

Fields

	Name	Description
	AllowTypeInHeaderFooter	Specifies whether the custom report item allows type in header or footer.

Top

Explicit Interface Implementations

	Name	Description
	IDisposable.Dispose	Infrastructure. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ReportObject.)
	IComponent.Disposed	Infrastructure. Occurs when the ReportObject object is disposed. (Inherited from ReportObject.)

Top

Remarks

Extended information about the custom report item is placed within the CustomProperties property. Tools and servers that do not support the type use the AltReportItem property instead.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via