Summary Page Scripts are used to generate HTML detailing a particular object.
The purpose of a Summary Page Script is to generate an HTML page displaying information about the object to which they relate.
The following are examples of Summary Page Scripts:
Three configuration options are available on the Scripts Form, Options page under the Summary Page options:
| Setting | Description |
|---|---|
| Object Type | This is the Scripting Object Type that this Summary Page Script applies to. This is used to determine what this Script is valid for. |
| Caption | This is only applicable if the Summary Page is to display in the Pages section of a form and is the Caption that is given to the page. |
| Show at Top | This is only applicable if the Summary Page is to display in the Pages section of a form and determines whether the Summary page is displayed before or after the regular form pages. |
The Script takes the following parameters:
ByVal source As Object
This is the finPOWER Connect business layer object which can be used to generate the Script from E.g. a finClient object if this is a Client Summary Page.
The first thing you will want to do is cast the source object to the correct type E.g.
Dim Client As finClientClient = DirectCast(source, finClient)
ByVal target As iseSummaryPageTarget
This is the place which is requesting the summary page and allows you to vary the Script accordingly.
Most Scripts will ignore this parameters as do all of the built-in Scripts.
ByVal contextData1 As Object
This varies depending on the object type that this Script applies to E.g. if it applies to Client.Logs, this will be the Integer index of the item selected in the grid.
ByVal contextData2 As Object
This varies depending on the object type that this Script applies to E.g. if it applies to Client.Logs, this will be a Boolean value indicating whether to generate a threaded summary.
ByRef text As String
This is the text (generally HTML) that the Script has built.
The Script should return a Boolean value to indicate whether it succeded or not.
Generally, the Script will return True but there may be certain circumstances where you want to return False E.g. if for some reason the Script is being run for a User who is not a member of a particular Role.