GetSummaryText Method

Member of finScriptFunctions
Gets the Summary Text for an Object. This is used for Form Headings and Summary Text.

The Script may return details as a simple String in the form: Title & vbCrLf & SummaryText or as an <ISSummaryText> XML String.

Syntax

finScriptFunctions.GetSummaryText(targetObjectType, sourceObject, target, contextData1, contextData2, summaryText, titleText)

Parameters

NameTypeOptionalByRefDescription
targetObjectType String The type of Object to get the Summary Text for.
sourceObject Object The Source Object related to the Summary Text, may be Nothing.
target iseSummaryTextTarget The Target.
contextData1 Object Context Data 1.
contextData2 Object Context Data 2.
summaryText String ByRef The Summary Text in a pseudo-tagged format usable for Form Headings.
titleText String ByRef The Title Text in a pseudo-tagged format usable for Form Headings.

Return Value

Boolean

A Boolean value indicating whether Title and Summary Text is being returned.

Member of:
finScriptFunctions
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0