[]
        
(Showing Draft Content)

GrapeCity.ActiveReports.SectionReport

SectionReport Class

Represents the type of report with predefined sections: Page Header, Detail, and Page Footer.

Inheritance
SectionReport
Namespace: GrapeCity.ActiveReports
Assembly: MESCIUS.ActiveReports.dll
Syntax
public class SectionReport : MarshalByRefObject, IComponent, IDisposable, IStyleSheetProvider, ISupportInitialize, ICloneable
Remarks

SectionReport can be customized using code/scripts in the report events.

Examples
var sectionReport = new GrapeCity.ActiveReports.SectionReport();
sectionReport.LoadLayout(System.Xml.XmlReader.Create("Report.rpx")); 
sectionReport.Document.Printer.PrinterName = String.Empty;
viewer.LoadDocument(sectionReport);

Constructors

Name Description
SectionReport()

Initialises a new instance of the SectionReport class.

Fields

Name Description
m_document

Properties

Name Description
CalculatedFields

Gets a value representing the collection of fields whose values are evaluated during report execution.

CompatibilityMode

Gets or sets a value indicating whether the engine should use the legacy GDI/GDI+ rendering or the new cross-platform based rendering implementation.

Components

Gets the datasource components other than DbDataSource saved to rpx. Gets populated only at run time loadlayout.

Culture

Gets or sets a value indicating the CultureInfo that is used to format number and dates displayed in a report.

CurrentPage

Gets a value indicating the current report page.

DataMember

Gets or sets a value indicating the name of the list or table in the DataSource to which the report will bind.

DataSource

Gets or sets a value representing the report data source.

DeviceInfo
Document

Gets a value representing the report output that can be printed, displayed in the viewer or exported to an external document.

EnableScriptDebugging

Gets or sets a value indicating whether to pause the debugger if the report script code throws an exception.

ExpressionErrorMessage

Gets or sets the message that represents a message to be displayed to the user instead of reporting engine exceptions.

Fields

Gets or sets a value representing the collection of the data source fields.

FontResolver

Gets or sets the font resolver.

ImageConverterService
IsDirty

Gets or sets a value indicating the report layout state.

LayoutAction

Gets or sets the custom action after the current record is rendered.

MaxPages

Gets or sets a value indicating the maximum number of pages the report will create.

Name

Gets os a sets a value indicating the report name.

PageNumber

Gets or sets a value indicating the number of the current page being processed when a report is running.

PageSettings

Gets or sets a value representing the report’s page settings.

Parameters

Gets a value representing the collection of report parameters.

ParentReport

Gets or sets a value indicating the parent report.

PrintWidth

Gets or sets a value indicating the print width of the report in inches.

ResourceLocator

Gets or sets a value representing the implementation of the resource locator.

Script

Gets or sets a value containing the custom report code.

ScriptLanguage

Gets or sets a value indicating the scripting language that ActiveReports uses to write and interpret the script properties.

ScriptReferences

Gets a value representing the collection of references that could be use in the code of a report script.

Sections

Gets value representing a sections collection of the report.

ShowParameterUI

Gets or sets a value indicating whether the query parameters dialog box appears when the report is executed.

State

Gets a value indicating the current state of a report.

StyleSheet

Gets a value representing the collection of formatting styles used to format controls in the report.

TextLayout
UserData

Gets or sets a value representing the custom report string data.

Version

Gets the version number of the product.

Watermark

Gets or sets a value representing an image that will be used for the background of report pages.

WatermarkAlignment

Gets or sets a value indicating the position of the background image on report pages.

WatermarkPrintOnPages

Gets or sets a value indicating the specific pages to which the watermark should be added.

WatermarkSizeMode

Gets or sets a value indicating the scaling of the background image of report pages.

Methods

Name Description
AddAssembly(Assembly)

Adds the specified external assembly to use inside scripts.

AddCode(string)

Adds additional valid script code to the scripting context of the report. The AddCode method allows complete functions to be added to a report's script at runtime. The added functions can be called from the report events in the script.

AddControlLicense(string, string)

Adds the license key to the report so that licensed controls can be added to the sections at runtime using the Controls.Add method.

AddNamedItem(string, object)

Adds the object to the global namespace of the script.

AddScriptReference(string)

Adds the reference to the specified assembly to load to the scripting runtime context.

AllFields()

Returns the union collection of the Fields and CalculatedFields objects.

Cancel()

Cancels the report processing. All rendered pages are deleted from the report's Document object.

Clone(SectionReport)
CmToInch(float)

Converts a measurement in centimeters to inches.

Dispose()

Performs tasks related to releasing resources.

Dispose(bool)

Performs tasks related to freeing and releasing resources..

InchToCm(float)

Converts a measurement in inches to centimeters.

InvalidateStyles()

Causes the report to reset all cached style data.

LoadLayout(Stream)

Loads the report layout from the stream.

LoadLayout(Stream, out ArrayList)

Loads the report layout from the stream.

LoadLayout(string)

Loads the report layout from the file.

LoadLayout(string, out ArrayList)

Loads report's layout from file.

LoadLayout(Type, string)

Loads the report layout from the embedded resource.

LoadLayout(XmlReader)

Loads the report layout from the System.Xml.XmlReader.

LoadStyles(Stream)

Loads the report stylesheet from a stream.

LoadStyles(string)

Loads the report stylesheet from an external file.

OnLayoutLoaded(EventArgs)

Fires GrapeCity.ActiveReports.SectionReport.LayoutLoaded event

OnLayoutLoading(EventArgs)

Fires GrapeCity.ActiveReports.SectionReport.LayoutLoading event

PrintAbortedEventHandler(object, EventArgs)
PrintProgressEventHandler(object, EventArgs)
RaiseParameterUIClosed(bool)

Raises the ParameterUIClosed event.

ResetScripts()

Clears the script of any items added using the AddNamedItem method or code added using the AddCode method. This does not affect the previously saved report layout (RPX) file and only deletes code added using the above methods.

ResetWatermark()

Resets the watermark to the empty.

Restart()

Resets the report state and clears report's Document object.

Run()

Generates the report output that could be then printed, displayed in the viewer, or exported to an external document.

Run(bool)

Generates the report output that could be then printed, displayed in the viewer, or exported to an external document.

SaveLayout(Stream)

Saves the report layout to the specified stream in the Arnet format.

SaveLayout(string)

Saves layout to the file in theArnet format.

SaveLayout(XmlWriter)

Saves the report layout to the provided System.Xml.XmlWriter.

SaveStyles(Stream)

Saves report styles to a stream.

SaveStyles(string)

Saves report styles to an external file.

Stop()

Stops the report processing.

Events

Name Description
DataInitialize

Occurs after the ReportStart event.

DataSourceChanged

Occurs when the DataMember or DataSource properties have changed.

FetchData

Occurs for each data record processing.

LocateCredentials

Occurs when the report needs to obtain data source credentials from the calling application.

NoData

Occurs when there is no data to process and no records are returned by the report's data source.

PageEnd

Occurs at the end of page processing.

PageStart

Occurs at the beginning of page processing.

ParameterUIClosed

Occurs when a report readers closed the parameters input dialog.

PrintAborted

Occurs when the report printing is cancelled.

PrintProgress

Occurs during printing at the beginning of each printed page.

ReportEnd

Occurs at the end of report processing.

ReportStart

Occurs at the start of report processing.

Extension Methods