List_FormatString()

The List_FormatString() function defined in the syListObj form is used to format string values for list data displayed in the Information Pane, included in a report, or exported to Microsoft Excel.

Syntax

List_FormatString(string_value, use)

Parameters

• string_value – The string value being formatted.

• use – An integer indicating where the formatted string is to be used. Based on the intended use, the string will be formatted appropriately. The value corresponds to one of the following constants:

Constant	Description
LIST_FORMATFOR_EXCEL	The value is being formatted for exporting to Excel.
LIST_FORMATFOR_PREVPANE	The value is being formatted for display in the Information Pane.
LIST_FORMATFOR_REPORT	The value is being formatted for display in the report generated from the list content.

Return value

A formatted string value.