List_FormatBoolean()

Examples


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

Syntax

List_FormatString(boolean_value, use)

Parameters

boolean_value – The boolean value being formatted.

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

[spacer]

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 string containing the formatted boolean value. The value true will be returned as “Yes”. The value false will be returned as “No”.


Documentation Feedback