GetFieldByName method

Applies to  

Description

Returns the specified Field, if the field named exists on the FormDef. Otherwise, the method returns NULL.

Syntax

[ReturnValue =] Object.GetFieldByName ( FieldName, Index )

Part

Data type

Description

Object

Object

An object expression that evaluates to an object in the Applies To list.

FieldName

String

Specify the name of field you are looking for.

Index

Integer

If the field is indexed the index (>= 1) must be specified as well. Use 0 for non indexed fields.

Settings

Return value

Data type: Field (Object). If the specified field exists on the FormDef, the return value is that field. If it is not found, NULL is returned.

Remarks

This method creates the specified field if it exists on the corresponding FormDef but is not filled in on the current Form. If you do not want to create "empty" fields, use the ExistFieldByName method, instead.

Field names are case-sensitive in FORMS.

Classic method

GetFormField