List_FormatQuantity()

Examples


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

Syntax

List_FormatQuantity(quantity_value, decimal_places, use)

Parameters

quantity_value – The quantity value being formatted.

decimal_places – The 'Decimal Places QTYS' field (a drop-down list) specifying the number of decimal places to use for the quantity.

use – An integer indicating where the formatted quanitity value is to be used. Based on the intended use, the quantity value 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 quantity value.


Documentation Feedback