GetHelpNotesAsHtml Method

Member of finWorkflowItem
Gets the notes in HTML format for display on Summary Pages.

<para> Version 1 type Workflows allow notes to be specified in HTML format. If HTML is detected, e.g. the less than character is detected not followed by a space, a blank String will be returned. In this case, the GetHelpNotesAsHtml method should be used. </para> <para> Notes for Version 2 type Workflows should be specified as Wiki Text but if the text '&lt;html&gt;' appears at the beginning, HTML can be forced. </para>

Syntax

finWorkflowItem.GetHelpNotesAsHtml([positionalCharacter])

Parameters

NameTypeOptionalByRefDescription
positionalCharacter String Optional ByRef Either blank, '*' or '^'. Can be used by Scripts to decide how to display the help notes.

Return Value

String

A String value.

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