Differences

This shows you the differences between two versions of the page.

--- docs:3500:0700:0710 [2023/04/05 07:50] – removed - external edit (Unknown date) 127.0.0.1
+++ docs:3500:0700:0710 [2025/06/12 02:36] (current) – Rename to AwareIM aware_support3
@@ Line 1: / Line 1: @@
+{{tag>Programmers_Reference IReport_Environment}}
+[<10>]
+===== Implementing code for the scriptlet =====
+The scriptlet’s code is called by //**AwareIM**// at run time when it calculates the report in which the scriptlet is present. The purpose of the scriptlet component is to calculate and set the value of the element that it is attached to. When the scriptlet is called it is given a call-back interface [[docs:3500:0700:0720|IReportEnvironment]] representing the environment in which the scriptlet is running. This interface exposes the method [[pr_methods:setelementvalue|setElementValue]], which has to be called by the scriptlet when it finishes the necessary calculations.
+The scriptlet is a class that must implement IReportScriptlet interface. Methods of this interface are called at various times during the report calculation. The scriptlet designer must provide a non-empty implementation of those methods that are called at the times that the scriptlet will be calculating its values. The methods exposed by the IReportScriptlet interface are described below. As mentioned before all methods are given a reference to the [[docs:3500:0700:0720|IReportEnvironment]] interface. Also all methods are supposed to throw an exception if error occurs.
+{{topic>ireport_environment +methods&notags}}