InDesign Server2025
API 20.5.0.49
Collection of FormField

FormFields

A collection of form fields.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

FormField

Returns the FormField with the specified index.

index Number The index.
FormField

Creates a new FormField

layer? Layer The layer on which to create the FormField.
at? LocationOptions The location at which to insert the FormField relative to the reference object or within the container object.
reference? Document | Layer | MasterSpread | Page | Spread | PageItem The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem.
withProperties? Object Initial values for properties of the new FormField
FormField

Returns any FormField in the collection.

Number

Displays the number of elements in the FormField.

FormField[]

Returns every FormField in the collection.

FormField

Returns the first FormField in the collection.

FormField

Returns the FormField with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
FormField

Returns the FormField with the specified ID.

id Number The ID.
FormField

Returns the FormField with the specified name.

name String The name.
FormField[]

Returns the FormFields within the specified range.

from FormField | LongInteger | String The FormField, index, or name at the beginning of the range. Can accept: FormField, Long Integer or String.
to FormField | LongInteger | String The FormField, index, or name at the end of the range. Can accept: FormField, Long Integer or String.
FormField

Returns the last FormField in the collection.

FormField

Returns the middle FormField in the collection.

FormField

Returns the FormField whose index follows the specified FormField in the collection.

obj FormField The FormField whose index comes before the desired FormField.
FormField

Returns the FormField with the index previous to the specified index.

obj FormField The index of the FormField that follows the desired FormField.
String

Generates a string which, if executed, will return the FormField.

Object of 27

Properties elsewhere that hold a FormFields.