Adobe InDesign CS3 (5.0) Object Model JS: FormField

InDesign CS3

Class

FormField

 

A form field. Base Class: PageItem

Superclass of Button

QuickLinks

addPath, applyObjectStyle, autoTag, bringForward, bringToFront, changeObject, checkIn, checkOut, clearObjectStyleOverrides, clearTransformations, convertShape, detach, duplicate, excludeOverlapPath, exportFile, extractLabel, findObject, fit, flipItem, getElements, insertLabel, intersectPath, makeCompoundPath, markup, minusBack, move, override, place, placeXML, redefineScaling, releaseCompoundPath, remove, removeOverride, resolve, revert, select, sendBackward, sendToBack, store, subtractPath, toSource, toSpecifier, transform, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually, transformValuesOf

Hierarchy

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

Properties

PropertyTypeAccessDescription
absoluteFlipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wIndicates whether the FormField has been flipped independently of its parent object and, if yes, the direction in which the FormField was flipped.
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.
allowOverridesbool r/wIf true, the master page item can be overridden.
anchoredObjectSettingsAnchoredObjectSetting readonlyAnchored object settings.
appearanceNamestring readonlyThe appearance applied to the button.
appliedObjectStyleObjectStyle r/wThe object style applied to the FormField.
associatedXMLElementXMLItem readonlyThe XML element associated with the FormField.
behaviorsBehaviors readonlyA collection of behavior objects.
closeWindowBehaviorsCloseWindowBehaviors readonlyA collection of close window behavior objects.
contentTransparencySettingsContentTransparencySetting readonlyTransparency settings for the content of the FormField.
cornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe 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.
cornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect.
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.
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.)
fillTransparencySettingsFillTransparencySetting readonlyTransparency settings for the fill applied to the FormField.
flipFlip:
Flip.NONE
Flip.HORIZONTAL
Flip.VERTICAL
Flip.HORIZONTAL_AND_VERTICAL
Flip.BOTH
r/wThe direction in which to flip the printed image.
frameFittingOptionsFrameFittingOption readonlyThe frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
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)
gradientFillLengthMeasurement Unit (Number or String) r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the FormField.
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)
gradientStrokeLengthMeasurement Unit (Number or String) r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the FormField.
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.
itemLayerLayer r/wThe layer that the FormField is on.
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.
lockStateLockStateValues:
LockStateValues.NONE
LockStateValues.UNMANAGED_STORY
LockStateValues.CHECKED_IN_STORY
LockStateValues.CHECKED_OUT_STORY
LockStateValues.LOCKED_STORY
LockStateValues.EMBEDDED_STORY
LockStateValues.MISSING_LOCK_STATE
LockStateValues.MIXED_LOCK_STATE
readonlyThe lock state.
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.
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.
overriddenMasterPageItemGraphic
Guide
Movie
PageItem
Sound
readonlyAn object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
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)
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.)
strokeTransparencySettingsStrokeTransparencySetting readonlyTransparency settings for the stroke.
strokeTypeString
StrokeStyle
r/wThe name of the stroke style to apply. Can also accept: String.
strokeWeightMeasurement Unit (Number or String) 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.
transparencySettingsTransparencySetting readonlyTransparency settings.
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 applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
Applies the specified object style.

ParameterTypeDescription
usingObjectStyleThe object style to apply.
clearingOverridesboolIf true, clears the FormField's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyleboolIf 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.

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

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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

ParameterTypeDescription
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf 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: Measurement Unit (Number or String)])
Converts the FormField to a different shape.

ParameterTypeDescription
givenConvertShapeOptions:
ConvertShapeOptions.CONVERT_TO_RECTANGLE
ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE
ConvertShapeOptions.CONVERT_TO_OVAL
ConvertShapeOptions.CONVERT_TO_TRIANGLE
ConvertShapeOptions.CONVERT_TO_POLYGON
ConvertShapeOptions.CONVERT_TO_LINE
ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE
ConvertShapeOptions.CONVERT_TO_OPEN_PATH
ConvertShapeOptions.CONVERT_TO_CLOSED_PATH
The FormField's new shape.
numberOfSidesnumber (range: 3 - 100)The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentagenumber (range: 0 - 100)The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadiusMeasurement Unit (Number or String) (range: 0 - 800)The corner radius of the resulting rectangle. (Optional)

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

PageItem duplicate ([to: any][, by: Array of Measurement Unit (Number or String)])
Duplicates the FormField at the specified location or offset.

ParameterTypeDescription
to Array of 2 Units
Layer
Page
Spread
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 Measurement Unit (Number or String)Amount by which to offset the new FormField from the original FormField's position. (Optional)

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][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
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.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
usingPDFExportPresetThe export style. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

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

ParameterTypeDescription
keystringThe key.

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

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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
FitOptions.FILL_PROPORTIONALLY
The fit option to use.

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

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

Array of FormField getElements ()
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.

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)])
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.

ParameterTypeDescription
to Array of 2 Units
Layer
Page
Spread
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 Measurement Unit (Number or String)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.

ParameterTypeDescription
destinationPagePageThe document page that contains the master page item to override.

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

ParameterTypeDescription
fileNameFileThe file to place
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
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.

void redefineScaling ([to: Array of number])
Apply an item's scaling to its content if possible.

ParameterTypeDescription
to Array of numberThe scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

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.

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

ParameterTypeDescription
locationAnchorPoint
AnchorPoint
Array of 2 Reals
Array of Arrays of 2 Reals
BoundingBoxLimits
CoordinateSpaces
Long Integers
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.
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
The coordinate space to use.
consideringRulerUnitsboolIf 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=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
The selection status of the FormField in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

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

void sendToBack ()
Sends the FormField to the back.

Asset store (using: Library[, withProperties: Object])
Stores the object in the specified library.

ParameterTypeDescription
usingLibraryThe library in which to store the object.
withPropertiesObjectInitial values for properties of the new FormField (Optional)

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.

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.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
The coordinate space to use
fromAnchorPoint
AnchorPoint
Array of 2 Reals
Array of Arrays of 2 Reals
BoundingBoxLimits
CoordinateSpaces
Long Integers
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 Array of MatrixContent
Long Integer
MatrixContent
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)
consideringRulerUnitsboolIf 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 TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
The coordinate space to use

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

Used in:

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

FormField FormFields.nextItem (obj: FormField)

FormField FormFields.previousItem (obj: FormField)

Return

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)

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