FormFields
See also FormField.
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
FormField [] (index:
number)
Returns the FormField with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
FormField add ([layer:
Layer][, at:
LocationOptions=LocationOptions.UNKNOWN][, reference:
varies][, withProperties:
Object])
Creates a new FormField
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the FormField. (Optional) |
| at | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location at which to insert the FormField relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
| reference | Document Layer MasterSpread Page PageItem Spread | The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) |
| withProperties | Object | 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.
Array of FormField everyItem ()
Returns every FormField in the collection.
FormField firstItem ()
Returns the first FormField in the collection.
FormField item (index:
varies)
Returns the FormField with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | 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 | number | The ID. |
FormField itemByName (name:
string)
Returns the FormField with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of FormField itemByRange (from:
varies, to:
varies)
Returns the FormFields within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | FormField Long Integer String | The FormField, index, or name at the beginning of the range. Can accept: FormField, Long Integer or String. |
| to | FormField Long Integer String | 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 | FormField | 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 | FormField | The index of the FormField that follows the desired FormField. |
string toSource ()
Generates a string which, if executed, will return the FormField.
Element of
Cell.formFields
Character.formFields
Document.formFields
GraphicLine.formFields
Group.formFields
InsertionPoint.formFields
Layer.formFields
Line.formFields
MasterSpread.formFields
Oval.formFields
Page.formFields
Paragraph.formFields
PlaceGun.formFields
Polygon.formFields
Rectangle.formFields
Snippet.formFields
SplineItem.formFields
Spread.formFields
Story.formFields
Table.formFields
Text.formFields
TextColumn.formFields
TextFrame.formFields
TextStyleRange.formFields
Word.formFields
XmlStory.formFields
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |