Adobe InDesign CS (3.0) Object Model JS: FormField

InDesign CS

Class

FormField

 

A form field. Base Class: PageItem

Superclass of Button

QuickLinks

addPath, bringForward, bringToFront, duplicate, excludeOverlapPath, exportFile, extractLabel, fit, insertLabel, intersectPath, makeCompoundPath, markup, minusBack, move, override, place, placeXML, releaseCompoundPath, remove, removeOverride, resetScaling, resize, rotate, select, sendBackward, sendToBack, shear, store, subtractPath, unlink

Hierarchy

Cell | Character | Document | Group | InsertionPoint | Layer | Line | MasterSpread | Page | Paragraph | Spread | Story | Table | Text | TextColumn | TextFrame | TextStyleRange | Word
PageItem
FormField
Button
Behavior | CloseWindowBehavior | GotoAnchorBehavior | GotoFirstPageBehavior | GotoLastPageBehavior | GotoNextPageBehavior | GotoNextViewBehavior | GotoPreviousPageBehavior | GotoPreviousViewBehavior | GotoURLBehavior | MovieBehavior | OpenFileBehavior | QuitBehavior | ShowHideFieldsBehavior | SoundBehavior | TextWrapPreference | ViewZoomBehavior

Properties

PropertyTypeAccessDescription
absoluteHorizontalScalenumber r/wThe horizontal scale of the FormField relative to its containing object.
absoluteRotationAnglenumber r/wThe rotation angle of the FormField relative to its containing object. (Range: -360 to 360)
absoluteShearAnglenumber r/wThe skewing angle of the FormField relative to its containing object. (Range: -360 to 360)
absoluteVerticalScalenumber r/wThe vertical scale of the FormField relative to its containing object.
allGraphics Array of Graphic readonlyLists all graphics contained by the FormField.
allPageItems Array of PageItem readonlyLists all page items contained by the FormField.
appearanceNamestring readonlyThe appearance applied to the button.
associatedXMLElementXMLElement readonlyReturns the associated XML element
behaviorsBehaviors readonlyA collection of behavior objects.
blendModeBlendMode:
BlendMode.NORMAL
BlendMode.MULTIPLY
BlendMode.SCREEN
BlendMode.OVERLAY
BlendMode.SOFT_LIGHT
BlendMode.HARD_LIGHT
BlendMode.COLOR_DODGE
BlendMode.COLOR_BURN
BlendMode.DARKEN
BlendMode.LIGHTEN
BlendMode.DIFFERENCE
BlendMode.EXCLUSION
BlendMode.HUE
BlendMode.SATURATION
BlendMode.COLOR
BlendMode.LUMINOSITY
r/wThe blend mode used to combine the background with the color of the FormField.
closeWindowBehaviorsCloseWindowBehaviors readonlyA collection of close window behavior objects.
cornerEffectCornerEffects:
CornerEffects.NONE
CornerEffects.ROUNDED_CORNER
CornerEffects.INVERSE_ROUNDED_CORNER
CornerEffects.INSET_CORNER
CornerEffects.BEVEL_CORNER
CornerEffects.FANCY_CORNER
r/wThe shape to apply to corner points in a path. Note: corner effect differs from end join in that you can set a radius for a corner effect, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadiusnumber r/wThe radius of the corner
descriptionstring r/wThe description of the FormField.
endCapEndCap:
EndCap.BUTT_END_CAP
EndCap.ROUND_END_CAP
EndCap.PROJECTING_END_CAP
r/wThe end shape of an open path.
endJoinEndJoin:
EndJoin.MITER_END_JOIN
EndJoin.ROUND_END_JOIN
EndJoin.BEVEL_END_JOIN
r/wThe corner join applied to the FormField.
featherCornerTypeFeatherCornerType:
FeatherCornerType.SHARP
FeatherCornerType.ROUNDED
FeatherCornerType.DIFFUSION
r/wThe type of feathering.
featherModeFeatherMode:
FeatherMode.NONE
FeatherMode.STANDARD
r/wThe feather-enabling mode.
featherWidthnumber r/wThe width of the feathering
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the FormField. . Can also accept: String.
fillTintnumber r/wThe 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.)
gapColorSwatch r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTintnumber r/wThe 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 Measurement Unit (Number or String) r/wThe 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.
gotoAnchorBehaviorsGotoAnchorBehaviors readonlyA collection of goto anchor behavior objects.
gotoFirstPageBehaviorsGotoFirstPageBehaviors readonlyA collection of goto first page behavior objects.
gotoLastPageBehaviorsGotoLastPageBehaviors readonlyA collection of goto last page behavior objects.
gotoNextPageBehaviorsGotoNextPageBehaviors readonlyA collection of goto next page behavior objects.
gotoNextViewBehaviorsGotoNextViewBehaviors readonlyA collection of goto next view behavior objects.
gotoPreviousPageBehaviorsGotoPreviousPageBehaviors readonlyA collection of goto previous page behavior objects.
gotoPreviousViewBehaviorsGotoPreviousViewBehaviors readonlyA collection of goto previous view behavior objects.
gotoURLBehaviorsGotoURLBehaviors readonlyA collection of goto URL behavior objects.
gradientFillAnglenumber r/wThe angle of a linear gradient applied to the fill of the FormField. (Range: -180 to 180)
gradientFillLengthnumber r/wLength of ramp for a linear gradient or radius of a radial gradient on the fill
gradientFillStart Array of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the fill of the FormField, in the format [x, y].
gradientStrokeAnglenumber r/wThe angle of a linear gradient applied to the stroke of the FormField. (Range: -180 to 180)
gradientStrokeLengthnumber r/wLength of ramp for a linear gradient or radius of a radial gradient on the stroke
gradientStrokeStart Array of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the stroke of the FormField, in the format [x, y].
horizontalScalenumber r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
idnumber readonlyThe unique ID of the FormField.
indexnumber readonlyThe index of the FormField within its containing object.
isolateBlendingbool r/wIf true, the FormField blends in isolation.
itemLayerLayer r/wThe layer that the FormField is on.
knockoutGroupbool r/wIf true, the FormField is a knockout group.
labelstring r/wA property that can be set to any string.
leftLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
r/wThe arrowhead applied to the start of the path.
localDisplaySettingDisplaySettingOptions:
DisplaySettingOptions.HIGH_QUALITY
DisplaySettingOptions.TYPICAL
DisplaySettingOptions.OPTIMIZED
DisplaySettingOptions.DEFAULT_VALUE
r/wDisplay performance options for the FormField.
lockedbool r/wIf true, the FormField is locked.
miterLimitnumber r/wThe 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)
movieBehaviorsMovieBehaviors readonlyA collection of movie behavior objects.
namestring r/wThe name of the FormField.
nonprintingbool r/wIf true, the FormField does not print.
opacitynumber r/wThe opacity of the object
openFileBehaviorsOpenFileBehaviors readonlyA collection of open file behavior objects.
overprintFillbool r/wIf true, the FormField's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGapbool r/wIf true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStrokebool r/wIf true, the FormField's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overriddenbool readonlyIf 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.
overriddenMasterPageItemPageItem readonlyAn object that was originally on a master page but was subsequently overridden.
parentCell
Character
Document
Group
InsertionPoint
Layer
Line
MasterSpread
Page
Paragraph
Spread
Story
Table
Text
TextColumn
TextFrame
TextStyleRange
Word
readonlyThe parent of the FormField (a Spread, MasterSpread, Group, TextFrame, Story, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, Document, Layer, InsertionPoint or Page).
propertiesObject r/wA property that allows setting of several properties at the same time.
quitBehaviorsQuitBehaviors readonlyA collection of quit behavior objects.
rightLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
r/wThe arrowhead applied to the end of the path.
rotationAnglenumber r/wThe rotatation angle of the FormField. (Range: -360 to 360)
shadowBlendModeBlendMode:
BlendMode.NORMAL
BlendMode.MULTIPLY
BlendMode.SCREEN
BlendMode.OVERLAY
BlendMode.SOFT_LIGHT
BlendMode.HARD_LIGHT
BlendMode.COLOR_DODGE
BlendMode.COLOR_BURN
BlendMode.DARKEN
BlendMode.LIGHTEN
BlendMode.DIFFERENCE
BlendMode.EXCLUSION
BlendMode.HUE
BlendMode.SATURATION
BlendMode.COLOR
BlendMode.LUMINOSITY
r/wThe blend mode to use for drawing the shadow.
shadowBlurRadiusnumber r/wThe radius of the shadow blur.
shadowColorSwatch r/wThe swatch (color or mixed ink) applied to the shadow.
shadowModeShadowMode:
ShadowMode.NONE
ShadowMode.DROP
r/wThe shadow mode.
shadowOpacitynumber r/wThe opacity of the shadow
shadowXOffsetnumber r/wThe horizontal offset of the shadow.
shadowYOffsetnumber r/wThe vertical offset of the shadow.
shearAnglenumber r/wThe skewing angle applied to the FormField. (Range: -360 to 360)
showHideFieldsBehaviorsShowHideFieldsBehaviors readonlyA collection of show/hide fields behavior objects.
soundBehaviorsSoundBehaviors readonlyA collection of sound behavior objects.
strokeAlignmentStrokeAlignment:
StrokeAlignment.CENTER_ALIGNMENT
StrokeAlignment.INSIDE_ALIGNMENT
StrokeAlignment.OUTSIDE_ALIGNMENT
r/wThe stroke alignment applied to the FormField.
strokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the FormField. Can also accept: String.
strokeCornerAdjustmentStrokeCornerAdjustment:
StrokeCornerAdjustment.NONE
StrokeCornerAdjustment.DASHES
StrokeCornerAdjustment.GAPS
StrokeCornerAdjustment.DASHES_AND_GAPS
r/wThe corner adjustment applied to the FormField.
strokeDashAndGap Array of Measurement Unit (Number or String) r/wThe 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].
strokeTintnumber r/wThe 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.)
strokeTypeStrokeStyle r/wThe stroke type
strokeWeightnumber r/wThe weight (in points) to apply to the FormField's stroke.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
verticalScalenumber r/wThe vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
viewZoomBehaviorsViewZoomBehaviors readonlyA collection of view zoom behavior objects.
visibilityInPdfVisibilityInPdf:
VisibilityInPdf.VISIBLE_IN_PDF
VisibilityInPdf.HIDDEN_IN_PDF
VisibilityInPdf.VISIBLE_BUT_DOES_NOT_PRINT_IN_PDF
VisibilityInPdf.HIDDEN_BUT_PRINTABLE_IN_PDF
r/wThe field's visibility in the PDF document.
visibleBounds Array of Measurement Unit (Number or String) r/wThe 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

Instances

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

ParameterTypeDescription
with Array of PageItemThe object(s) to add.

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

void bringToFront ()
Brings the FormField to the front.

FormField duplicate ()
Duplicates the FormField.

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

ParameterTypeDescription
with Array of PageItemThe object(s) to exclude.

void exportFile (format: any, to: File[, showingOptions: bool=false][, using: PDFExportPreset])
Exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
String
The export format. Can accept: ExportFormat enumerator or String.
toFileThe path of the export file.
showingOptionsboolIf true, prompts the user to select export options. (Optional) (default: false)
usingPDFExportPresetThe export style to use. (Optional)

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

ParameterTypeDescription
keystringThe key.

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

ParameterTypeDescription
givenFitOptions:
FitOptions.CONTENT_TO_FRAME
FitOptions.CENTER_CONTENT
FitOptions.PROPORTIONALLY
FitOptions.FRAME_TO_CONTENT
The fit option to use.

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

ParameterTypeDescription
keystringThe key.
valuestringThe value.

PageItem intersectPath (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.

ParameterTypeDescription
with Array of PageItemThe object(s) with which to intersect.

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

ParameterTypeDescription
with Array of PageItemThe 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.

ParameterTypeDescription
usingXMLElementThe XML element.

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

ParameterTypeDescription
with Array of PageItemThe object(s) to reverse subtract.

void move ([to: any][, by: Array of Measurement Unit (Number or String)])
Move Page Item to a new location. One of the To or By parameters is required.

ParameterTypeDescription
to Array of 2 Units
Layer
Page
Spread
The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by Array of Measurement Unit (Number or String)Amount by which to move the object relative to its current position (Optional)

PageItem override (destinationPage: Page)
Overrides a master page item and places it on the page

ParameterTypeDescription
destinationPagePageThe document page on which the master page item will be overridden.

any place (fileName: File[, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: any][, showingOptions: bool=false][, autoflowing: bool=false][, retainingFormatting: bool=true][, convertingQuotes: bool=true][, withProperties: Object])
Places a file in the document.

ParameterTypeDescription
fileNameFileThe file to place.
placePoint Array of Measurement Unit (Number or String)The point where to place the object (only applicable if you are telling a page or spread to place) (Optional)
destinationLayer Array of Layers
Layer
The layer(s) to place the file on (only valid if you are telling a page or spread to place). Can accept: Layer or Array of Layers. (Optional)
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
autoflowingboolWhether to autoflow placed text (Optional) (default: false)
retainingFormattingboolWhether to keep formatting of placed text files (Optional) (default: true)
convertingQuotesboolWhether to convert to typographer's quotes (Optional) (default: true)
withPropertiesObjectInitial values for properties of the placed object(s) (Optional)

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

ParameterTypeDescription
usingXMLElementThe XML element whose content you want to place.

Array of PageItem releaseCompoundPath ()
Releases a compound path.

void remove ()
Deletes the FormField.

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

void resetScaling ()
Resets the FormField's scaling to 100%. Note: This does not change the size of the FormField. Instead, it makes the current size of the FormField the basis for future scaling.

void resize ([horizontalScale: number][, verticalScale: number][, around: any][, consideringCurrentScale: bool=false][, transformingContent: bool=true][, consideringParentsScale: bool=false])
Resize the page item. You must specify either horizontal scale or vertical scale or both.

ParameterTypeDescription
horizontalScalenumberThe percentage of horizontal scale (Optional)
verticalScalenumberThe percentage of vertical scale (Optional)
aroundAnchorPoint
Array of 2 Units
The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentScaleboolIf true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContentboolIf true then both the object and items within it are scaled (Optional) (default: true)
consideringParentsScaleboolIf true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false)

void rotate (by: number[, around: any][, consideringCurrentRotation: bool=false][, transformingContent: bool=true][, consideringParentsRotation: bool=false])
Rotate the page item

ParameterTypeDescription
bynumberAngle by which to rotate the page item
aroundAnchorPoint
Array of 2 Units
The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentRotationboolIf true then the object's current rotation and new rotation will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContentboolIf true then both the object and items within it are rotated (Optional) (default: true)
consideringParentsRotationboolIf true then the object is rotated relative to its parent page item. If false it is rotated relative to the spread. Cannot rotate with considering current rotation and considering parents rotation both set at the same time. (Optional) (default: false)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE])
Select this object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE
How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE)

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

void sendToBack ()
Sends the FormField to the back.

void shear (by: number[, around: any][, consideringCurrentShear: bool=false][, transformingContent: bool=true][, consideringParentsShear: bool=false])
Shear the page item

ParameterTypeDescription
bynumberAngle by which to shear the object
aroundAnchorPoint
Array of 2 Units
The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentShearboolIf true then the object's current shear and new shear will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContentboolIf true then both the object and items within it are sheared (Optional) (default: true)
consideringParentsShearboolIf true then the object is sheared relative to its parent page item. If false it is sheared relative to the spread. Cannot shear with considering current shear and considering parents shear both set at the same time. (Optional) (default: false)

Asset store (using: Library)
Store a page item in a library

ParameterTypeDescription
usingLibraryThe library in which to store

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

ParameterTypeDescription
with Array of PageItemThe object(s) to subtract.

void unlink (from: UnlinkFrom)
Detaches an overridden master page item from the page or from the master

ParameterTypeDescription
fromUnlinkFrom:
UnlinkFrom.PAGE
UnlinkFrom.MASTER_SPREAD
What to unlink from

Element of

Behavior.parent

CloseWindowBehavior.parent

GotoAnchorBehavior.parent

GotoFirstPageBehavior.parent

GotoLastPageBehavior.parent

GotoNextPageBehavior.parent

GotoNextViewBehavior.parent

GotoPreviousPageBehavior.parent

GotoPreviousViewBehavior.parent

GotoURLBehavior.parent

MovieBehavior.parent

OpenFileBehavior.parent

Page.tabOrder

QuitBehavior.parent

ShowHideFieldsBehavior.fieldsToHide

ShowHideFieldsBehavior.fieldsToShow

ShowHideFieldsBehavior.parent

SoundBehavior.parent

ViewZoomBehavior.parent

Return

FormField FormField.duplicate ()

Jongware, 27-Jun-2010 v3.0.3dContents :: Index