FormField
A form field. Base Class: PageItem
Superclass of Button
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| 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. |
| allPageItems | Array of PageItem | readonly | Lists all page items contained by the FormField. |
| appearanceName | string | readonly | The appearance applied to the button. |
| associatedXMLElement | XMLElement | readonly | Returns the associated XML element |
| behaviors | Behaviors | readonly | A collection of behavior objects. |
| blendMode | BlendMode: 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/w | The blend mode used to combine the background with the color of the FormField. |
| closeWindowBehaviors | CloseWindowBehaviors | readonly | A collection of close window behavior objects. |
| cornerEffect | CornerEffects: CornerEffects.NONE CornerEffects.ROUNDED_CORNER CornerEffects.INVERSE_ROUNDED_CORNER CornerEffects.INSET_CORNER CornerEffects.BEVEL_CORNER CornerEffects.FANCY_CORNER |
r/w | The 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. |
| cornerRadius | number | r/w | The radius of the corner |
| description | string | r/w | The description of the FormField. |
| endCap | EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP |
r/w | The end shape of an open path. |
| endJoin | EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN |
r/w | The corner join applied to the FormField. |
| featherCornerType | FeatherCornerType: FeatherCornerType.SHARP FeatherCornerType.ROUNDED FeatherCornerType.DIFFUSION |
r/w | The type of feathering. |
| featherMode | FeatherMode: FeatherMode.NONE FeatherMode.STANDARD |
r/w | The feather-enabling mode. |
| featherWidth | number | r/w | The width of the feathering |
| fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of 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.) |
| 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 Measurement Unit (Number or String) | 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 | Length of ramp for a linear gradient or radius of a radial gradient on the fill |
| gradientFillStart | Array of Measurement Unit (Number or String) | 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 | Length of ramp for a linear gradient or radius of a radial gradient on the stroke |
| gradientStrokeStart | Array of Measurement Unit (Number or String) | 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. |
| isolateBlending | bool | r/w | If true, the FormField blends in isolation. |
| itemLayer | Layer | r/w | The layer that the FormField is on. |
| knockoutGroup | bool | r/w | If true, the FormField is a knockout group. |
| label | string | r/w | A property that can be set to any string. |
| leftLineEnd | ArrowHead: 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/w | The arrowhead applied to the start of the path. |
| localDisplaySetting | DisplaySettingOptions: DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE |
r/w | Display performance options for the FormField. |
| locked | bool | r/w | If true, the FormField is locked. |
| 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. |
| opacity | number | r/w | The opacity of the object |
| 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 | PageItem | readonly | An object that was originally on a master page but was subsequently overridden. |
| parent | Cell Character Document Group InsertionPoint Layer Line MasterSpread Page Paragraph Spread Story Table Text TextColumn TextFrame TextStyleRange Word |
readonly | The parent of the FormField (a Spread, MasterSpread, Group, TextFrame, Story, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, Document, Layer, InsertionPoint or Page). |
| 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: 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/w | The arrowhead applied to the end of the path. |
| rotationAngle | number | r/w | The rotatation angle of the FormField. (Range: -360 to 360) |
| shadowBlendMode | BlendMode: 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/w | The blend mode to use for drawing the shadow. |
| shadowBlurRadius | number | r/w | The radius of the shadow blur. |
| shadowColor | Swatch | r/w | The swatch (color or mixed ink) applied to the shadow. |
| shadowMode | ShadowMode: ShadowMode.NONE ShadowMode.DROP |
r/w | The shadow mode. |
| shadowOpacity | number | r/w | The opacity of the shadow |
| shadowXOffset | number | r/w | The horizontal offset of the shadow. |
| shadowYOffset | number | r/w | The vertical offset of the shadow. |
| 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: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
r/w | The stroke alignment applied to the FormField. |
| strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the FormField. Can also accept: String. |
| strokeCornerAdjustment | StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS |
r/w | The corner adjustment applied to the FormField. |
| strokeDashAndGap | Array of Measurement Unit (Number or String) | 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.) |
| strokeType | StrokeStyle | r/w | The stroke type |
| 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. |
| 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: VisibilityInPdf.VISIBLE_IN_PDF VisibilityInPdf.HIDDEN_IN_PDF VisibilityInPdf.VISIBLE_BUT_DOES_NOT_PRINT_IN_PDF VisibilityInPdf.HIDDEN_BUT_PRINTABLE_IN_PDF |
r/w | The field's visibility in the PDF document. |
| visibleBounds | Array of Measurement Unit (Number or String) | 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
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.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The 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.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) to exclude. |
void exportFile (format:
any, to:
File[, showingOptions:
bool=false][, using:
PDFExportPreset])
Exports the object(s) to a file.
| Parameter | Type | Description |
|---|---|---|
| format | ExportFormat String | The export format. Can accept: ExportFormat enumerator or String. |
| to | File | The path of the export file. |
| showingOptions | bool | If true, prompts the user to select export options. (Optional) (default: false) |
| using | PDFExportPreset | The export style to use. (Optional) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.
| Parameter | Type | Description |
|---|---|---|
| given | FitOptions: 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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The 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.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The 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.
| 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. |
PageItem minusBack (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 Measurement Unit (Number or String)])
Move Page Item to a new location. One of the To or By parameters is required.
| Parameter | Type | Description |
|---|---|---|
| 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
| Parameter | Type | Description |
|---|---|---|
| destinationPage | Page | The 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.
| Parameter | Type | Description |
|---|---|---|
| fileName | File | The 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) |
| showingOptions | bool | Whether to display the import options dialog (Optional) (default: false) |
| autoflowing | bool | Whether to autoflow placed text (Optional) (default: false) |
| retainingFormatting | bool | Whether to keep formatting of placed text files (Optional) (default: true) |
| convertingQuotes | bool | Whether to convert to typographer's quotes (Optional) (default: true) |
| withProperties | Object | Initial 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.
| Parameter | Type | Description |
|---|---|---|
| using | XMLElement | The 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.
| Parameter | Type | Description |
|---|---|---|
| horizontalScale | number | The percentage of horizontal scale (Optional) |
| verticalScale | number | The percentage of vertical scale (Optional) |
| around | AnchorPoint Array of 2 Units | The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
| consideringCurrentScale | bool | If 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) |
| transformingContent | bool | If true then both the object and items within it are scaled (Optional) (default: true) |
| consideringParentsScale | bool | If 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
| Parameter | Type | Description |
|---|---|---|
| by | number | Angle by which to rotate the page item |
| around | AnchorPoint Array of 2 Units | The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
| consideringCurrentRotation | bool | If 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) |
| transformingContent | bool | If true then both the object and items within it are rotated (Optional) (default: true) |
| consideringParentsRotation | bool | If 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.
| Parameter | Type | Description |
|---|---|---|
| existingSelection | SelectionOptions: 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
| Parameter | Type | Description |
|---|---|---|
| by | number | Angle by which to shear the object |
| around | AnchorPoint Array of 2 Units | The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
| consideringCurrentShear | bool | If 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) |
| transformingContent | bool | If true then both the object and items within it are sheared (Optional) (default: true) |
| consideringParentsShear | bool | If 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
| Parameter | Type | Description |
|---|---|---|
| using | Library | The 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.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) to subtract. |
void unlink (from:
UnlinkFrom)
Detaches an overridden master page item from the page or from the master
| Parameter | Type | Description |
|---|---|---|
| from | UnlinkFrom: 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.3d | Contents :: Index |