DataRegion Class

Article
02/01/2013

Represents the base class for a data region, such as Tablix.

Inheritance Hierarchy

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

Syntax

'Declaration
Public MustInherit Class DataRegion _
    Inherits ReportItem _
    Implements IDataScopeService, IDataScope, IContainedObject
'Usage
Dim instance As DataRegion

public abstract class DataRegion : ReportItem, 
    IDataScopeService, IDataScope, IContainedObject

public ref class DataRegion abstract : public ReportItem, 
    IDataScopeService, IDataScope, IContainedObject

[<AbstractClassAttribute>]
type DataRegion =  
    class 
        inherit ReportItem 
        interface IDataScopeService 
        interface IDataScope 
        interface IContainedObject 
    end

public abstract class DataRegion extends ReportItem implements IDataScopeService, IDataScope, IContainedObject

The DataRegion type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	ActionInfo	Gets or sets the actions that are associated with the ReportItem. (Inherited from ReportItem.)
	AllGroups	Infrastructure. Gets or sets all groups of the data region.
	AllowInHeaderFooter	When overridden in a derived class, gets a value that indicates whether the data region is allowed in header or footer. (Overrides ReportItem.AllowInHeaderFooter.)
	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 sub-items contained in this report item. (Inherited from ReportItem.)
	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.)
	DataSetName	Gets or sets a value that indicates which dataset to use for this data region.
	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.)
	Filters	Gets or sets the filters to apply to each row of data in the data region.
	Height	Gets or sets the height of the item. (Inherited from ReportItem.)
	KeepTogether	Gets or sets a value that indicates whether all sections of the data region are kept together on one page, if possible.
	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.)
	NoRowsMessage	Gets or sets the message to display in the data region when it contains no rows.
	PageBreak	Gets or sets the page break behavior for the data region
	PageName	Gets or sets the page name for the data region.
	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.)
	SortExpressions	Gets or sets the expressions by which to sort the rows of data in the data region.
	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.)
	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 list of dependency objects embedded in the data region. (Overrides ReportObject.GetDependenciesCore(IList<ReportObject>).)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Initialize	Initializes an instance of the DataRegion 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 data region 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.)
	IDataScope.Group	Infrastructure. Gets the group of the data for the data region.
	IDataScopeService.GetDataScopesFor	Infrastructure. Gets the data scopes for the data region.