See Also

ActiveReport Class  | DataDynamics.ActiveReports Namespace

See Also ActiveReports Send feedback to Data Dynamics

ActiveReport Class Members

ActiveReport overview

Public Constructors

Public Constructor ActiveReport Constructor Initializes a new instance of the ActiveReport class.

Public Properties

Public Property CurrentPage Returns the current page instance.
Public Property DataMember Gets or sets the specified list in a DataSource to which the report will bind.
Public Property DataSource Gets or sets the data source from which the report will retrieve data.
Public Property Document Returns a reference to the report output Document object.
Public Property ExpressionErrorMessage Stops the reporting engine from throwing exceptions and instead displays the provided string.
Public Property Fields Returns the current data binding collection.  This collection contains the available Field objects to which the report controls and sections can be bound.
Public Property IsDirty Sets or returns the current state of the report layout.  This property is set to True when any changes are made to the report layout since it was last saved.
Public Property LayoutAction Sets or returns a custom action following the rendering of the current record.
Public Property MaxPages Sets or returns the maximum number of pages that the report will create.
Public Property PageNumber Returns the number of the current page being processed when a report is running.
Public Property PageSettings Returns a reference to the current report's page settings. 
Public Property Parameters Returns a reference to the data source query parameters collection.
Public Property ParentReport Gets a reference to the parent report.
Public Property PrintWidth Sets or returns the report's printable width in inches.
Public Property Script Sets or returns the script code for a report's events.  Either this property or the script editor may be used to add script to a report.
Public Property ScriptLanguage Sets or returns the scripting language ActiveReports will use to write and interpret the script properties. 
Public Property Sections Returns a reference to the report's sections collection.
Public Property ShowParameterUI Sets or returns whether or not the query parameters dialog box will appear when the report is run.
Public Property State Returns the current state of the report.
Public Property StyleSheet Returns a collection of formatting styles used to format controls in the report.
Public Property UserData Sets or returns a user-defined value.
Public Property Version Returns the product's version number.
Public Property Watermark Adds a specified image to the report's background.  The watermark image can be positioned, sized, aligned and placed on specified pages by using the other watermark properties.
Public Property WatermarkAlignment Sets or returns the watermark's general vertical and horizontal position when it is added to the canvas.
Public Property WatermarkPrintOnPages Sets or returns a value indicating the specific pages to which the watermark should be added.
Public Property WatermarkSizeMode Sets or returns how the watermark will be sized when the image is rendered on the page.
Public Property XmlLayout For internal use only.

Public Methods

Public Method AddCode Adds additional valid script code to the report's scripting context.  Using AddCode allows complete functions to be added to a report's script at run time.  The added functions can be called from the report events in script.
Public Method AddControlLicense Adds a license key to the report so licensed controls can be added to sections at run time by using the Controls.Add method.
Public Method AddNamedItem Adds an object to the script's global namespace.  This method allows scripts to become aware of custom classes contained within a project.  Once an item has been added, the script can use the objectName string to reference the object and the functions contained within the class.
Public Method AddScriptReference Adds a reference to the specified assembly to be loaded into the scripting run-time context.
Public Method Cancel Cancels the report's processing. Any rendered pages will be cleared from the report's Document object.
Public Methodstatic (Shared in Visual Basic) CmToInch Converts value from centimeters to inches.
Public Method Dispose Releases the report instance from memory.
Public Method GenerateNewControlName For internal use only.
Public Methodstatic (Shared in Visual Basic) InchToCm Converts value from inches to centimeters.
Public Method LoadLayout Overloaded. Retrieves a report XML layout (RPX) from a file, stream or resource.
Retrieves a report XML layout and loads it into a report object.
Public Method RaiseParameterUIClosed For internal use.
Public Method ResetScripts Clears the script of any items added using the AddNamedItem method or code added using the AddCode method.  This does not affect the pre-saved report layout (RPX) file and only clears code added using the above methods.
Public Method ResetWatermark Resets the watermark to its default value.
Public Method Restart Resets the report data source and clears the pages collection.
Public Method Run Overloaded. Starts the report processing.
Public Method SaveLayout Overloaded. Saves a report's XML layout to a stream or file.
Public Method SetLicense Sets run-time licensing from the value string provided.
Public Method Show Loads the report layout, runs it with the bound data source and any script in the report xml, and shows it in a viewer.
Public Method Stop Stops processing the report.
Public Method ValidateControlName For internal use only.
Public Methodstatic (Shared in Visual Basic) ValidateNameSyntax Obsolete.  For internal use only.

Public Events

Public Event Changed Raised when any of the report properties change.
Public Event DataInitialize Raised after the ReportStart event to allow the addition of custom fields to the report's fields collection.
Public Event DataSourceChanged Raised when the properties of the report's data source are modified.
Public Event Disposed Raised when the report instance is released from memory.
Public Event FetchData Raised every time a new record is processed.
Public Event LayoutLoaded Raised after a report XML layout is loaded into the report instance.
Public Event LayoutLoading Raised before a report XML layout starts loading into the report instance.
Public Event NoData Raised if the report's data source does not return any records and there is no data to be processed.
Public Event PageEnd Raised after the report finishes rendering each page.
Public Event PageStart Raised before the report renders any output to a new page.
Public Event ParameterUIClosed Raised after the user closes the query parameters dialog.
Public Event PrintAborted Raised when the user cancels a print job.
Public Event PrintProgress Raised for each page while printing the report document.
Public Event ReportEnd Raised after the report finishes processing all pages.
Public Event ReportStart Raised before a report starts processing.

See Also

ActiveReport Class  | DataDynamics.ActiveReports Namespace

 

 


Copyright © 2004-2005 Data Dynamics, Ltd. All rights reserved.