Difference between revisions of "FileMan Delphi Components/TFMGets"

From VistApedia
Jump to: navigation, search
(Description)
(Added glossary link to Record~)
 
Line 12: Line 12:
 
== Description ==
 
== Description ==
  
The purpose of the TFMGets component is to retrieve a specified record from the server database. The TFMGets component acts as a wrapper around the [http://hardhats.org/fileman/pm/db_diqgs.htm <code>GETS^DIQ</code>] DBS call. Most of its properties are passed as parameters to the underlying DBS call.
+
The purpose of the TFMGets component is to retrieve a specified [[record~|Record]] from the server database. The TFMGets component acts as a wrapper around the [http://hardhats.org/fileman/pm/db_diqgs.htm <code>GETS^DIQ</code>] DBS call. Most of its properties are passed as parameters to the underlying DBS call.
  
 
For step-by-step instructions using the TFMGets component, please refer to the "[[FileMan_Delphi_Components/Retrieve_a_Record|How to Retrieve a Record]]" topic.
 
For step-by-step instructions using the TFMGets component, please refer to the "[[FileMan_Delphi_Components/Retrieve_a_Record|How to Retrieve a Record]]" topic.
Line 26: Line 26:
 
== When to Use More Than One TFMGets Component on a Form ==
 
== When to Use More Than One TFMGets Component on a Form ==
  
Typically, you would want to devote one TFMGets component for each discrete record or set of fields you need to retrieve values for on a form. If you are editing a set of fields from a top-level record, and also a set of fields for a record in a multiple, ordinarily you would use separate TFMGets components for each set of fields.
+
Typically, you would want to devote one TFMGets component for each discrete [[record~|Record]] or set of fields you need to retrieve values for on a form. If you are editing a set of fields from a top-level [[record~|Record]], and also a set of fields for a [[record~|Record]] in a multiple, ordinarily you would use separate TFMGets components for each set of fields.
  
  

Latest revision as of 13:27, 7 April 2012

TFMGets Component

Parent Class

TFMGets = class(TFMAccess)

Description

The purpose of the TFMGets component is to retrieve a specified Record from the server database. The TFMGets component acts as a wrapper around the GETS^DIQ DBS call. Most of its properties are passed as parameters to the underlying DBS call.

For step-by-step instructions using the TFMGets component, please refer to the "How to Retrieve a Record" topic.

Internal Lists

The TFMGets component maintains two internal lists:

  1. A list of fields to retrieve values for (the FieldNumbers property). When a GetData (or GetAndFill) call is made, the TFMGets component retrieves data values for all fields on its FieldNumbers list (whether or not the field is associated with a VA FileMan data control). Use the AddField and RemoveField methods to add and remove standalone fields (not associated with a VA FileMan data control) from this list.
  1. A list of associated data controls. To associate a data control with a TFMGets component, use its FMGets property. The control's field number is automatically added to the TFMGets' FieldNumbers property (its list of fields to retrieve). To de-associate a control, clear its FMGets property. When a TFMGets component's GetAndFill or FillData call is made, the FMGets automatically stuffs retrieved data values into all associated controls.

When to Use More Than One TFMGets Component on a Form

Typically, you would want to devote one TFMGets component for each discrete Record or set of fields you need to retrieve values for on a form. If you are editing a set of fields from a top-level Record, and also a set of fields for a Record in a multiple, ordinarily you would use separate TFMGets components for each set of fields.


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.