Home > Reference > Script steps reference > Fields script steps > Insert From Index

Insert From Index

 

Purpose 

Pastes a value from the index into a field.

See also 

Using a field index

Creating scripts to automate tasks

Format 

Insert from Index [Select; <table::field>]

Options 

•	Select entire contents replaces the contents of a field. If you do not select this option, Insert From Index inserts the result at the cursor position or at the end of the field's data.

•	Go to target field allows you to specify the field to paste the index value into. The field you specify may be of any type.

Compatibility 

 

Where the script step runs	Supported
FileMaker Pro	Yes
FileMaker Server scheduled script	No
FileMaker Go	No
Custom Web Publishing	No
FileMaker WebDirect	No
Runtime solution	Yes

Originated in 

FileMaker Pro 6.0 or earlier

Description 

This script step displays the index for the active field. You can use Insert From Index in Browse or Find modes.

FileMaker Pro displays the View Index dialog box so the user can select an entry. This method promotes consistent data entry and correct spelling. For this script step, you can specify a field and select the entire contents of the field.

FileMaker Pro uses what was last selected for the Show individual words option in the View Index dialog box (it is not remembered in the script).

Notes

•	If the specified field does not exist on the layout where the script is being performed, Insert From Index returns an error code which can be captured with the Get(LastError) function.

•	If you have turned indexing off for a field and deselected the option to Automatically create indexes as needed, the index will not display and an error code is returned. For more information on field indexing see Defining field indexing options.

Example 1 

Displays the index for a field in Find mode so the user can select a preexisting value.

Enter Find Mode [ ]
Insert from Index [Customers::Company]
Perform Find [ ]

Related topics 

Set Field script step

Script steps reference (alphabetical list)

Script steps reference (category list)