6.5

© 2007 ABBYY. All rights reserved.
56
• DateValue specifies the date value to be converted to the string.
• DateType specifies the date format (see Enum TDateFormat).
• YearLength specifies the number of digits in the year (see Enum TYearLength).
• DateSeparator specifies the delimiter of the date parts. It should consist of one character only.
If the method is called without one or several default parameters, the default parameters specified for the form will be used (see
SetDefaultDateFormat). If the default parameters have not been predefined, a run time error will occur.
Note. It is recommended to use this method before writing the date by using the SetCheckValue function.
FormatDecimal method
Function FormatDecimal( ByRef DecimalValue As Currency, Optional ByRef DecimalSeparator As String ) As String
Converts the DecimalValue number to a string of the specified format.
Parameters:
• DecimalValue specifies the value.
• DecimalSeparator contains the decimal delimiter (one character only) that will be used for converting the number to
text.
If the method is called without the DecimalSeparator value, the default decimal delimiter specified for the form will be used (see
SetDefaultDecimalSeparator). If the default decimal delimiter has not been specified for the form, a run time error will occur.
Note; It is recommended to use this method before writing the number by using the SetCheckValue function.
FormPages collection
Count property
Count As Long is a read–only property. It returns the number of the pages in the collection.
Item method
Item( Index As Long ) As FormPage returns the collection element with the specified index.
FormPage class
TemplateName property
TemplateName As String is a read–only property.
Fields property
Fields As Fields is a read–only property.
Fields collection
Count property
Count As Long is a read–only property. It returns the number of the fields on the page.
Item method
The Item( Index As Long ) As Field method returns the object of the field with the specified index.
ItemByName method
The ItemByName( FieldName As String ) As Field method returns the object of the field with specified name.
Note: If a checkmark is a member of a checkmark group, it cannot be an independent object and it is absent in the field collection.
Field class
The object corresponds to a field in the form page.
Name property
Name is a read–only property. It returns the field name.
Value property
Value As Variant (vbString) is a read–only property. It returns the field value (text).
The value of the Value property for different field types:
Field type Return values
Text
Type: Variant(vbString)
Text string.
Date
Type: Variant(vbString)
Text string.
Note: The field can contain both the correct and incorrect date (arbitrary text). The incorrect date can be entered
when editing the form in ABBYY FormReader Enterprise Edition or it can be exported from the *. ffdata file. In this case
the Value property returns the text "as it is". If the field is not filled, the method returns “”.
Number
Type: Variant(vbString)
Text string.
Note: The field can contain both the correct and incorrect number (arbitrary text). The incorrect number can be
entered when editing the form in ABBYY FormReader Enterprise Edition or it can be exported from the *. ffdata file. In
this case the Value property returns the text "as it is". If the field is not filled, the method returns “”.
Checkmark
Type: Variant(vbString)
If the check mark is not selected, the property returns “0”; otherwise it returns “1”.
Any other data are regarded as invalid.