DisplayString property

Applies to
InvoiceField object

The DisplayString property is a returns the value of an invoice field.

There are two differences between the DisplayString property and the Value property:

  • The DisplayString property is read-only.
  • The DisplayString property returns a formatted version of a value, whereas the Value property returns a "raw" value from the invoice.

Two types of formatting are made to the value, depending on its type:

  • If the value is a date, it is formatted using the DisplayDate setting in Eiglobal.ini. For more information, refer Eiglobal > Interpret topic in ReadSoft Invoices INI Help.
  • If the value is an amount, it is formatted using DisplayThousand, DisplayDecimal, and, in Kofax ReadSoft Invoices 5-4 SP2 or later, the CurrenciesWithNoCents settings in Eiglobal.ini. For more information, refer Eiglobal > Interpret topic in ReadSoft Invoices INI Help.

Example

The value on an invoice is "2011 January 24" and DisplayDate is set to the default (YYYYMMDD). InvoiceField.Value returns the exact value on the invoice, that is, "2011 January 24". DisplayString, on the other hand, returns the formatted value, namely "20110124".

Syntax

object.DisplayString [= value]

Part

Description

object

An expression that evaluates to an object in the InvoiceField object.

value

A string value.