FormFields
A collection of form fields.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
FormField [] (index:Number)
Returns the FormField with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
FormField add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)
Creates a new FormField
|
Parameter |
Type |
Description |
|---|---|---|
|
layer |
The layer on which to create the FormField. (Optional) |
|
|
at |
The location at which to insert the FormField relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
|
|
reference |
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) |
|
|
withProperties |
Initial values for properties of the new FormField (Optional) |
FormField anyItem ()
Returns any FormField in the collection.
Number count ()
Displays the number of elements in the FormField.
FormField everyItem ()
Returns every FormField in the collection.
FormField firstItem ()
Returns the first FormField in the collection.
FormField item (index:Varies LongInteger String)
Returns the FormField with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
FormField itemByID (id:Number)
Returns the FormField with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
FormField itemByName (name:String)
Returns the FormField with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
FormField itemByRange (from:Varies FormField LongInteger String, to:Varies FormField LongInteger String)
Returns the FormFields within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The FormField, index, or name at the beginning of the range. Can accept: FormField, Long Integer or String. |
|
to |
LongInteger |
The FormField, index, or name at the end of the range. Can accept: FormField, Long Integer or String. |
FormField lastItem ()
Returns the last FormField in the collection.
FormField middleItem ()
Returns the middle FormField in the collection.
FormField nextItem (obj:FormField)
Returns the FormField whose index follows the specified FormField in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The FormField whose index comes before the desired FormField. |
FormField previousItem (obj:FormField)
Returns the FormField with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the FormField that follows the desired FormField. |
String toSource ()
Generates a string which, if executed, will return the FormField.
Object of
PlaceGun.formFields
Document.formFields
Layer.formFields
Spread.formFields
Page.formFields
MasterSpread.formFields
Oval.formFields
Rectangle.formFields
GraphicLine.formFields
Polygon.formFields
Group.formFields
SplineItem.formFields
Snippet.formFields
Cell.formFields
Table.formFields
Text.formFields
Character.formFields
Word.formFields
Line.formFields
TextColumn.formFields
Paragraph.formFields
TextStyleRange.formFields
InsertionPoint.formFields
TextFrame.formFields
Story.formFields
EndnoteTextFrame.formFields
XmlStory.formFields