EvaluateHeaderFooterExpressions Delegate

Article
12/03/2008

Called by the rendering extension, if necessary, to evaluate the header and footer.

Namespace: Microsoft.ReportingServices.ReportRendering
Assembly: Microsoft.ReportingServices.ProcessingCore (in microsoft.reportingservices.processingcore.dll)

Syntax

'Declaration
Public Delegate Sub EvaluateHeaderFooterExpressions ( _
    pageNumber As Integer, _
    totalPages As Integer, _
    report As Report, _
    pageReportItems As PageReportItems, _
    <OutAttribute> ByRef pageHeader As PageSection, _
    <OutAttribute> ByRef pageFooter As PageSection _
)

public delegate void EvaluateHeaderFooterExpressions (
    int pageNumber,
    int totalPages,
    Report report,
    PageReportItems pageReportItems,
    out PageSection pageHeader,
    out PageSection pageFooter
)

public delegate void EvaluateHeaderFooterExpressions (
    int pageNumber, 
    int totalPages, 
    Report^ report, 
    PageReportItems^ pageReportItems, 
    [OutAttribute] PageSection^% pageHeader, 
    [OutAttribute] PageSection^% pageFooter
)

/** @delegate */
public delegate void EvaluateHeaderFooterExpressions (
    int pageNumber, 
    int totalPages, 
    Report report, 
    PageReportItems pageReportItems, 
    /** @attribute OutAttribute() */ /** @ref */ PageSection pageHeader, 
    /** @attribute OutAttribute() */ /** @ref */ PageSection pageFooter
)

JScript supports the use of delegates, but not the declaration of new ones.

Parameters

pageNumber
The number of the current page.

totalPages
The total number of pages.

report
The Report object being evaluated.

pageReportItems
A PageReportItems collection containing report items on the page.

pageHeader
The resulting page header, if it needed evaluation. If this is null, check the PageHeader.

pageFooter
The resulting page footer, if it needed evaluation. If this is null, check the PageFooter.

Remarks

The page header and footer of the report may include aggregates or other information that is dependent on the contents of that page of the report. If the NeedsHeaderFooterEvaluation property of the Report is true, the rendering extension needs to create a PageReportItems object and add all the report items that are completely contained on the page into the collection. The rendering extension then calls the EvaluateHeaderFooterExpressions function, passing in the collection, and the report server returns the new page header and page footer. If the header or footer didn’t need to be evaluated, then they were available directly on the Report object. In the case that the header needs to be evaluated but the footer doesn’t (or vice-versa), the header is available from the result of EvaluateHeaderFooterExpressions, while the footer is available directly in the object model.

All visible items and items that are always hidden in the page should be included in the collection of report items. Conditionally hidden items will not be included if they are currently hidden.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms