Report Class

Represents a report.

Inheritance Hierarchy

System.Object
  Microsoft.ReportingServices.OnDemandReportRendering.Report

Namespace:  Microsoft.ReportingServices.OnDemandReportRendering
Assembly:  Microsoft.ReportingServices.ProcessingCore (in Microsoft.ReportingServices.ProcessingCore.dll)

Syntax

'Declaration
Public NotInheritable Class Report _
    Implements IDefinitionPath
'Usage
Dim instance As Report
public sealed class Report : IDefinitionPath
public ref class Report sealed : IDefinitionPath
[<SealedAttribute>]
type Report =  
    class
        interface IDefinitionPath
    end
public final class Report implements IDefinitionPath

The Report type exposes the following members.

Properties

  Name Description
Public property Author Gets the author of the report.
Public property AutoRefresh Gets the rate at which the report page (when rendered as HTML) automatically refreshes, in seconds.
Public property Body Obsolete. Gets the body of the report.
Public property ConsumeContainerWhitespace Gets a value that indicates whether all whitespace in containers (i.e. Body and Rectangle) should be consumed when contents grow rather than preserving the minimum whitespace between the contents and the container.
Public property CustomProperties Gets the custom information to be handed to the report rendering component
Public property DataElementName Gets the name of a top level element that represents the report data.
Public property DataElementStyle Gets a value that indicates whether leaf-level values (e.g. textbox values and chart data values) should render as elements or attributes.
Public property DataSchema Gets the schema or namespace to use for a report data rendering.
Public property DataSetName Gets the name of the dataset, if the report contains only one dataset.
Public property DataTransform Gets the location to a transformation to apply to a report data rendering. This can be a full folder path (e.g. “/xsl/xfrm.xsl”) or relative path (e.g. “xfrm.xsl”).
Public property DefinitionPath Gets the path to this report definition object in the report definition.
Public property Description Gets the description of the report.
Public property DocumentMap Gets the document map for the report.
Public property ExecutionTime Gets the most recent time the report is executed.
Public property HasBookmarks Gets a value that indicates the report contains bookmarks.
Public property HasDocumentMap Gets a value that indicates the report contains document map labels.
Public property ID Gets the unique identifier for this report definition object.
Public property InitialPageName Gets an expression that evaluates to the initial or default name of the report page.
Public property Instance Gets the report instance object that contains the calculated values of this report definition object.
Public property Language Gets an expression that evaluates to the primary language of the text.
Public property Location Gets the location from which the report was executed.
Public property Name Gets the report name.
Public property NeedsHeaderFooterEvaluation Obsolete. Gets a value that indicates whether AddToCurrentPage must be called for each item on the page before GetPageSections is called.
Public property NeedsOverallTotalPages Gets a value that indicates whether the Globals!OverallTotalPages value is used in the page header or footer, and that this value needs to be calculated when generating the rendered output.
Public property NeedsPageBreakTotalPages Gets a value that indicates whether to the Globals!TotalPages value is used in the page header or footer, and that this value needs to be calculated when generating the rendered output.
Public property NeedsReportItemsOnPage Gets a value that indicates whether there is an aggregate in the page header or footer that aggregates data in a TextBox.
Public property NeedsTotalPages Gets a value that indicates whether to the Globals!TotalPages or Globals!OverallTotalPages value is used in the page header or footer, and that this value needs to be calculated when generating the rendered output.
Public property Page Obsolete. Gets the page layout information about the report.
Public property Parameters Gets the report parameters.
Public property ParentDefinitionPath Gets the path to report definition object's parent in the report definition.
Public property ReportSections Gets the report sections in the report.
Public property ShowHideToggle Gets the unique name of the toggled item in the current rendering request, if any.
Public property SnapshotPageSizeInfo Gets a rough indication of the size of the report, which can be used to drive memory management decisions within the rendering extension.
Public property SortItem Gets the unique name of the selected user sort item in the current rendering request, if any.
Public property Width Obsolete. Gets the width of the report.

Top

Methods

  Name Description
Public method AddToCurrentPage Registers the value of a textbox as being on the current page.
Public method CreateChunk Creates a stream for a chunk of the rendered report.
Public method EnableNativeCustomReportItem() Indicates the renderer natively supports all custom report item types, so the processing engine should not generate an image.
Public method EnableNativeCustomReportItem(String) Indicates the renderer natively supports all custom report item types, so the processing engine should not generate an image.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetChunk Gets a report data chunk.
Public method GetHashCode (Inherited from Object.)
Public method GetOrCreateChunk Gets or creates a report data chunk.
Public method GetPageSections Obsolete. Causes page header/footer calculations to be performed for the current page. This method must be called before accessing the PageSections for the report.
Public method GetReportUrl URL from which the report was executed.
Public method GetResource Used to retrieve auxiliary resources used during rendering; e.g., an XSLT used by the XML renderer.
Public method GetStreamUrl URL by which a client application may request a stream of the given name.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method SetPage Obsolete. Sets the current page number and total page count. This method must be called before GetPageSections. The totalPages argument must be accurate if NeedsHeaderFooterEvaluation is true. Otherwise, this argument is unused.
Public method ToString (Inherited from Object.)

Top

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.