FileMan Delphi Components/TFMLister

From VistApedia
Revision as of 13:33, 7 April 2012 by NeilArmstrong (talk | contribs) (Added glossary link to Record~)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

TFMLister Component


Parent Class

TFMLister = class(TFMAccess)


Description

The purpose of the TFMLister component is to retrieve a list of VA FileMan Records from the server. Records are retrieved into the TFMLister's Results property. TFMLister is a wrapper around the LIST^DIC Database Server (DBS) call.

You can use a TFMLister by itself, to directly retrieve a list of Records from the server:

You can also use the TFMLister in conjuction with list-type VA FileMan data controls to edit pointer fields:

Returned Structure

The structure of each returned TFMRecordObj is:

ObjectDescription
RecObj.IENIEN of the Record.
RecObj.FMFldValuesTFMFieldObj objects for fields requested in FieldNumbers.
RecObj.FMIXExternalValuesexternal form of index value(s) (TFMLister only) if requested.
RecObj.FMIXInternalValuesinternal form of index value(s) (TFMLister only) if requested.
RecObj.FMWIDValuesWrite Identifier of a file and the Identifier parameter result.
RecObj.ObjectsPlace to associate your own object.

When to Use TFMFinder Instead of TFMLister

The TFMFinder can be useful in certain cases where the TFMLister is not. In particular, the TFMLister looks up internal values when you use its PartList property. If the value you need to search on is an external value, you may want to use the TFMFinder instead.


Descriptions of properties inherited from the parent component are not listed here (only those properties added to the parent component are described).

For help on inherited properties, please refer to Delphi's documentation on the parent component.