FormField

A form field.

Properties

Property Type Access Description
absoluteFlip Flip
:
NONE
HORIZONTAL
VERTICAL
HORIZONTAL_AND_VERTICAL
BOTH
r/w Indicates whether the FormField has been flipped independently of its parent object and, if yes, the direction in which the FormField was flipped.
absoluteHorizontalScale number r/w The horizontal scale of the FormField relative to its containing object.
absoluteRotationAngle number r/w The rotation angle of the FormField relative to its containing object. (Range: -360 to 360)
absoluteShearAngle number r/w The skewing angle of the FormField relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale number r/w The vertical scale of the FormField relative to its containing object.
allGraphics Array of Graphic readonly Lists all graphics contained by the FormField.
allowOverrides bool r/w If true, the master page FormField allows overrides.
allPageItems Array of PageItem readonly Lists all page items contained by the FormField.
anchoredObjectSettings AnchoredObjectSetting readonly Anchored object settings.
appearanceName string readonly The appearance applied to the button.
appliedObjectStyle ObjectStyle r/w The object style applied to the FormField.
associatedXMLElement XMLItem readonly The XML element associated with the FormField.
behaviors Behaviors readonly A collection of behavior objects.
closeWindowBehaviors CloseWindowBehaviors readonly A collection of close window behavior objects.
contentTransparencySettings ContentTransparencySetting readonly Transparency settings for the content of the FormField.
cornerOption CornerOptions
:
NONE
ROUNDED_CORNER
INVERSE_ROUNDED_CORNER
INSET_CORNER
BEVEL_CORNER
FANCY_CORNER
r/w The shape to apply to corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadius number r/w The radius in measurement units of the corner effect.
description string r/w The description of the FormField.
endCap EndCap
:
BUTT_END_CAP
ROUND_END_CAP
PROJECTING_END_CAP
r/w The end shape of an open path.
endJoin EndJoin
:
MITER_END_JOIN
ROUND_END_JOIN
BEVEL_END_JOIN
r/w The corner join applied to the FormField.
fillColor Swatch r/w The swatch (color, gradient, tint, or mixed ink) applied to the to fill the FormField. . Can also accept: String.
fillTint number r/w The percent of tint to use in the FormField’s fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
fillTransparencySettings FillTransparencySetting readonly Transparency settings for the fill applied to the FormField.
flip Flip
:
NONE
HORIZONTAL
VERTICAL
HORIZONTAL_AND_VERTICAL
BOTH
r/w The direction in which to flip the printed image.
frameFittingOptions FrameFittingOption readonly The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
gapColor Swatch r/w The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTint number r/w The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
geometricBounds Array of number r/w The bounds of the FormField excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
gotoAnchorBehaviors GotoAnchorBehaviors readonly A collection of goto anchor behavior objects.
gotoFirstPageBehaviors GotoFirstPageBehaviors readonly A collection of goto first page behavior objects.
gotoLastPageBehaviors GotoLastPageBehaviors readonly A collection of goto last page behavior objects.
gotoNextPageBehaviors GotoNextPageBehaviors readonly A collection of goto next page behavior objects.
gotoNextViewBehaviors GotoNextViewBehaviors readonly A collection of goto next view behavior objects.
gotoPreviousPageBehaviors GotoPreviousPageBehaviors readonly A collection of goto previous page behavior objects.
gotoPreviousViewBehaviors GotoPreviousViewBehaviors readonly A collection of goto previous view behavior objects.
gotoURLBehaviors GotoURLBehaviors readonly A collection of goto URL behavior objects.
gradientFillAngle number r/w The angle of a linear gradient applied to the fill of the FormField. (Range: -180 to 180)
gradientFillLength number r/w The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the FormField.
gradientFillStart Array of number r/w The starting point (in page coordinates) of a gradient applied to the fill of the FormField, in the format [x, y].
gradientStrokeAngle number r/w The angle of a linear gradient applied to the stroke of the FormField. (Range: -180 to 180)
gradientStrokeLength number r/w The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the FormField.
gradientStrokeStart Array of number r/w The starting point (in page coordinates) of a gradient applied to the stroke of the FormField, in the format [x, y].
horizontalScale number r/w The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
id number readonly The unique ID of the FormField.
index number readonly The index of the FormField within its containing object.
itemLayer Layer r/w The layer that the FormField is on.
label string r/w A property that can be set to any string.
leftLineEnd ArrowHead
:
NONE
SIMPLE_ARROW_HEAD
SIMPLE_WIDE_ARROW_HEAD
TRIANGLE_ARROW_HEAD
TRIANGLE_WIDE_ARROW_HEAD
BARBED_ARROW_HEAD
CURVED_ARROW_HEAD
CIRCLE_ARROW_HEAD
CIRCLE_SOLID_ARROW_HEAD
SQUARE_ARROW_HEAD
SQUARE_SOLID_ARROW_HEAD
BAR_ARROW_HEAD
r/w The arrowhead applied to the start of the path.
localDisplaySetting DisplaySettingOptions
:
HIGH_QUALITY
TYPICAL
OPTIMIZED
DEFAULT_VALUE
r/w Display performance options for the FormField.
locked bool r/w If true, the FormField is locked.
lockState LockStateValues
:
NONE
UNMANAGED_STORY
CHECKED_IN_STORY
CHECKED_OUT_STORY
LOCKED_STORY
EMBEDDED_STORY
MISSING_LOCK_STATE
MIXED_LOCK_STATE
readonly The lock state.
miterLimit number r/w The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500)
movieBehaviors MovieBehaviors readonly A collection of movie behavior objects.
name string r/w The name of the FormField.
nonprinting bool r/w If true, the FormField does not print.
openFileBehaviors OpenFileBehaviors readonly A collection of open file behavior objects.
overprintFill bool r/w If true, the FormField’s fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap bool r/w If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke bool r/w If true, the FormField’s stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden bool readonly If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem any readonly An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parent any readonly The parent of the FormField (a Spread, MasterSpread, Group, TextFrame, Story, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, Page, Document, Layer or InsertionPoint).
properties Object r/w A property that allows setting of several properties at the same time.
quitBehaviors QuitBehaviors readonly A collection of quit behavior objects.
rightLineEnd ArrowHead
:
NONE
SIMPLE_ARROW_HEAD
SIMPLE_WIDE_ARROW_HEAD
TRIANGLE_ARROW_HEAD
TRIANGLE_WIDE_ARROW_HEAD
BARBED_ARROW_HEAD
CURVED_ARROW_HEAD
CIRCLE_ARROW_HEAD
CIRCLE_SOLID_ARROW_HEAD
SQUARE_ARROW_HEAD
SQUARE_SOLID_ARROW_HEAD
BAR_ARROW_HEAD
r/w The arrowhead applied to the end of the path.
rotationAngle number r/w The rotatation angle of the FormField. (Range: -360 to 360)
shearAngle number r/w The skewing angle applied to the FormField. (Range: -360 to 360)
showHideFieldsBehaviors ShowHideFieldsBehaviors readonly A collection of show/hide fields behavior objects.
soundBehaviors SoundBehaviors readonly A collection of sound behavior objects.
strokeAlignment StrokeAlignment
:
CENTER_ALIGNMENT
INSIDE_ALIGNMENT
OUTSIDE_ALIGNMENT
r/w The stroke alignment applied to the FormField.
strokeColor Swatch r/w The swatch (color, gradient, tint, or mixed ink) applied to the to stroke of the FormField. Can also accept: String.
strokeCornerAdjustment StrokeCornerAdjustment
:
NONE
DASHES
GAPS
DASHES_AND_GAPS
r/w The corner adjustment applied to the FormField.
strokeDashAndGap Array of number r/w The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
strokeTint number r/w The percent of tint to use in object’s stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeTransparencySettings StrokeTransparencySetting readonly Transparency settings for the stroke.
strokeType StrokeStyle r/w The name of the stroke style to apply. Can also accept: String.
strokeWeight number r/w The weight (in points) to apply to the FormField’s stroke.
textWrapPreferences TextWrapPreference readonly The text wrap preference properties that define the default formatting for wrapping text around objects.
transparencySettings TransparencySetting readonly Transparency settings.
verticalScale number r/w The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
viewZoomBehaviors ViewZoomBehaviors readonly A collection of view zoom behavior objects.
visibilityInPdf VisibilityInPdf
:
VISIBLE_IN_PDF
HIDDEN_IN_PDF
VISIBLE_BUT_DOES_NOT_PRINT_IN_PDF
HIDDEN_BUT_PRINTABLE_IN_PDF
r/w The field’s visibility in the PDF document.
visibleBounds Array of number r/w The bounds of the FormField including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.

Methods

PageItemaddPath (with:
Array of PageItem)
Creates a new page item by combining the FormField with other objects. Deletes the objects if they do not intersect.

Parameter Type Description
with Array of PageItem The object(s) to add.

void applyObjectStyle (using:
ObjectStyle[, clearingOverrides:
bool=true ][, clearingOverridesThroughRootObjectStyle:
bool=false ])
Applies the specified object style.

Parameter Type Description
using ObjectStyle The object style to apply.
clearingOverrides bool If true, clears the FormField’s existing attributes before applying the style. (Optional) (default: true )
clearingOverridesThroughRootObjectStyle bool If true, clears attributes and formatting applied to the FormField that are not defined in the object style. (Optional) (default: false )

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

void bringForward ()
Brings the FormField forward one level in its layer.

void bringToFront ()
Brings the FormField to the front of its layer.

Array of PageItemchangeObject ([reverseOrder:
bool])
Finds objects that match the find what value and replace the objects with the change to value.

Parameter Type Description
reverseOrder bool If true, returns the results in reverse order. (Optional)

bool checkIn ([versionComments:
string][, forceSave:
bool=false ])
Checks in the story or stories.

Parameter Type Description
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional) (default: false )

bool checkOut ()
Checks out the story.

void clearObjectStyleOverrides ()
Clear overrides for object style

void clearTransformations ()
Clears transformations from the FormField. Transformations include rotation, scaling, flipping, fitting, and shearing.

void convertShape (given:
ConvertShapeOptions[, numberOfSides:
number][, insetPercentage:
number][, cornerRadius:
number])
Converts the FormField to a different shape.

Parameter Type Description
given ConvertShapeOptions
:
CONVERT_TO_RECTANGLE
CONVERT_TO_ROUNDED_RECTANGLE
CONVERT_TO_BEVELED_RECTANGLE
CONVERT_TO_INVERSE_ROUNDED_RECTANGLE
CONVERT_TO_OVAL
CONVERT_TO_TRIANGLE
CONVERT_TO_POLYGON
CONVERT_TO_LINE
CONVERT_TO_STRAIGHT_LINE
CONVERT_TO_OPEN_PATH
CONVERT_TO_CLOSED_PATH
The FormField’s new shape.
numberOfSides number The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentage number The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadius number The corner radius of the resulting rectangle. (Optional)

void detach ()
Detaches an overridden master page item from the master page.

PageItemduplicate ([to:
any][, by:
Array of number])
Duplicates the FormField at the specified location or offset

Parameter Type Description
to Array of 2 Units
Spread
Page
Layer
The location of the new FormField, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of number Amount by which to offset the new FormField from the original FormField’s position. (Optional)

PageItemexcludeOverlapPath (with:
Array of PageItem)
Creates a new page item by excluding the overlapping areas of the FormField and other objects.

Parameter Type Description
with Array of PageItem The object(s) to exclude.

void exportFile (format:
any, to:
File[, showingOptions:
bool=false ][, using:
PDFExportPreset][, versionComments:
string][, forceSave:
bool=false ])
Exports the FormField to file.

Parameter Type Description
format ExportFormat
String
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to File The path to the export file.
showingOptions bool If true, displays the export options dialog. (Optional) (default: false )
using PDFExportPreset The export style. (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional) (default: false )

string extractLabel (key:
string)
Gets the label value associated with the specified key.

Parameter Type Description
key string The key.

Array of PageItemfindObject ([reverseOrder:
bool])
Finds objects that match the find what value.

Parameter Type Description
reverseOrder bool If true, returns the results in reverse order. (Optional)

void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.

Parameter Type Description
given FitOptions
:
CONTENT_TO_FRAME
CENTER_CONTENT
PROPORTIONALLY
FRAME_TO_CONTENT
FILL_PROPORTIONALLY
The fit option to use.

void flipItem (given:
Flip[, around:
any])
Flips the FormField.

Parameter Type Description
given Flip
:
NONE
HORIZONTAL
VERTICAL
HORIZONTAL_AND_VERTICAL
BOTH
The axis around which to flip the FormField.
around Array of 2 Units
AnchorPoint
The point around which to flip the FormField. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Array of FormFieldgetElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.

Parameter Type Description
key string The key.
value string The value.

PageItemintersectPath (with:
Array of PageItem)
Creates a new page item by intersecting the FormField with other objects. Returns an error if the objects do not intersect.

Parameter Type Description
with Array of PageItem The object(s) with which to intersect.

PageItemmakeCompoundPath (with:
Array of PageItem)
Creates a compound path by combining the path of the FormField with the paths of other objects.

Parameter Type Description
with Array of PageItem The other objects whose paths to include in the new compound path.

void markup (using:
XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter Type Description
using XMLElement The XML element.

PageItemminusBack (with:
Array of PageItem)
Creates a new page item by reverse subtracting the overlapping areas of the FormField and other objects.

Parameter Type Description
with Array of PageItem The object(s) to reverse subtract.

void move ([to:
any][, by:
Array of number])
Moves the FormField to a new location. Note: Either the ‘to’ or ‘by’ parameter is required; if both parameters are defined, only the to value is used.

Parameter Type Description
to Array of 2 Units
Spread
Page
Layer
The new location of the FormField,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of number The amount (in measurement units) to move the FormField relative to its current position, in the format (x, y). (Optional)

any override (destinationPage:
Page)
Overrides a master page item and places the item on the document page as a new object.

Parameter Type Description
destinationPage Page The document page that contains the master page item to override.

Array of any place (fileName:
File[, showingOptions:
bool=false ][, withProperties:
Object])
Places the file.

Parameter Type Description
fileName File The file to place
showingOptions bool Whether to display the import options dialog (Optional) (default: false )
withProperties Object Initial values for properties of the new FormField (Optional)

void placeXML (using:
XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

Parameter Type Description
using XMLElement The XML element whose content you want to place.

void redefineScaling ([to:
Array of number])
Move an item’s scaling to its content if possible

Parameter Type Description
to Array of number The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

Array of PageItemreleaseCompoundPath ()
Releases a compound path.

void remove ()
Deletes the FormField.

void removeOverride ()
Removes the override from a previously overridden master page item.

any resolve (location:
any, in:
CoordinateSpaces[, consideringRulerUnits:
bool=false ])
Get the coordinates of the given location in the specified coordinate system

Parameter Type Description
location Array of 2 Reals
AnchorPoint
Array of Arrays of 2 Reals
CoordinateSpaces
AnchorPoint
BoundingBoxLimits
The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
in CoordinateSpaces
:
PASTEBOARD_COORDINATES
PARENT_COORDINATES
INNER_COORDINATES
The coordinate space to use
consideringRulerUnits bool If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false )

bool revert ()
Reverts the document to its state at the last save operation.

void select ([existingSelection:
SelectionOptions=REPLACE_WITH ])
Selects the FormField.

Parameter Type Description
existingSelection SelectionOptions
:
ADD_TO
REMOVE_FROM
REPLACE_WITH
The selection status of the FormField in relation to previously selected objects. (Optional) (default: REPLACE_WITH )

void sendBackward ()
Sends the FormField back one level in its layer.

void sendToBack ()
Sends the FormField to the back of its layer.

Assetstore (using:
Library[, withProperties:
Object])
Stores the FormField(s) in the specified library.

Parameter Type Description
using Library The library in which to store the FormField(s).
withProperties Object Initial values for properties of the new FormField (Optional)

PageItemsubtractPath (with:
Array of PageItem)
Creates a new page item by subtracting the overlapping areas of the FormField and other objects.

Parameter Type Description
with Array of PageItem The object(s) to subtract.

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

string toSpecifier ()
Retrieves the object specifier.

void transform (in:
CoordinateSpaces, from:
any, withMatrix:
any[, replacingCurrent:
any][, consideringRulerUnits:
bool=false ])
Transform the page item

Parameter Type Description
in CoordinateSpaces
:
PASTEBOARD_COORDINATES
PARENT_COORDINATES
INNER_COORDINATES
The coordinate space to use
from Array of 2 Reals
AnchorPoint
Array of Arrays of 2 Reals
CoordinateSpaces
AnchorPoint
BoundingBoxLimits
The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
withMatrix Array of 6 Reals
TransformationMatrix
Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent MatrixContent
Array of MatrixContent
Long Integer
Transform components to consider; providing this optional parameter causes the target’s existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target’s existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
consideringRulerUnits bool If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false )

Array of string transformAgain ()
Transforms the FormField using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformAgainIndividually ()
Transforms the FormField using the last transformation performed on any FormField. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgain ()
Transforms the FormField using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgainIndividually ()
Transforms the FormField using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of TransformationMatrixtransformValuesOf (in:
CoordinateSpaces)
Get the transformation values of the page item

Parameter Type Description
in CoordinateSpaces
:
PASTEBOARD_COORDINATES
PARENT_COORDINATES
INNER_COORDINATES
The coordinate space to use

Element of:

Page.tabOrder
ShowHideFieldsBehavior.fieldsToHide
ShowHideFieldsBehavior.fieldsToShow

Used in:

FormFields.previousItem (

obj:
FormField )

FormFields.nextItem (

obj:
FormField )

Returned by:

Array of FormField FormField .getElements (

)

FormField FormFields.anyItem (

)

Array of FormField FormFields.everyItem (

)

FormField FormFields.firstItem (

)

FormField FormFields.item (
index:
any
)

FormField FormFields.itemByID (
id:
number
)

FormField FormFields.itemByName (
name:
string
)

Array of FormField FormFields.itemByRange (
from:
any, to:
any
)

FormField FormFields.lastItem (

)

FormField FormFields.middleItem (

)

FormField FormFields.nextItem (
obj:
FormField
)

FormField FormFields.previousItem (
obj:
FormField
)

Leave a Comment

Previous post:

Next post: