SignatureFields

A collection of signature fields.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

SignatureField [] (index:Number)

Returns the SignatureField with the specified index.

Parameter

Type

Description

index

Number

The index.

SignatureField add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)

Creates a new SignatureField

Parameter

Type

Description

layer

Layer

The layer on which to create the SignatureField. (Optional)

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location at which to insert the SignatureField relative to the reference object or within the container object. (Optional)

(default: LocationOptions.UNKNOWN)

reference

Document

Layer

MasterSpread

Page

Spread

PageItem

The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)

withProperties

Object

Initial values for properties of the new SignatureField (Optional)

SignatureField anyItem ()

Returns any SignatureField in the collection.

Number count ()

Displays the number of elements in the SignatureField.

SignatureField everyItem ()

Returns every SignatureField in the collection.

SignatureField firstItem ()

Returns the first SignatureField in the collection.

SignatureField item (index:Varies LongInteger String)

Returns the SignatureField with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

SignatureField itemByID (id:Number)

Returns the SignatureField with the specified ID.

Parameter

Type

Description

id

Number

The ID.

SignatureField itemByName (name:String)

Returns the SignatureField with the specified name.

Parameter

Type

Description

name

String

The name.

SignatureField itemByRange (from:Varies LongInteger SignatureField String, to:Varies LongInteger SignatureField String)

Returns the SignatureFields within the specified range.

Parameter

Type

Description

from

LongInteger

SignatureField

String

The SignatureField, index, or name at the beginning of the range. Can accept: SignatureField, Long Integer or String.

to

LongInteger

SignatureField

String

The SignatureField, index, or name at the end of the range. Can accept: SignatureField, Long Integer or String.

SignatureField lastItem ()

Returns the last SignatureField in the collection.

SignatureField middleItem ()

Returns the middle SignatureField in the collection.

SignatureField nextItem (obj:SignatureField)

Returns the SignatureField whose index follows the specified SignatureField in the collection.

Parameter

Type

Description

obj

SignatureField

The SignatureField whose index comes before the desired SignatureField.

SignatureField previousItem (obj:SignatureField)

Returns the SignatureField with the index previous to the specified index.

Parameter

Type

Description

obj

SignatureField

The index of the SignatureField that follows the desired SignatureField.

String toSource ()

Generates a string which, if executed, will return the SignatureField.

Object of

PlaceGun.signatureFields

Document.signatureFields

Layer.signatureFields

Spread.signatureFields

Page.signatureFields

MasterSpread.signatureFields

Oval.signatureFields

Rectangle.signatureFields

GraphicLine.signatureFields

Polygon.signatureFields

Group.signatureFields

SplineItem.signatureFields

Snippet.signatureFields

Cell.signatureFields

Table.signatureFields

Text.signatureFields

Character.signatureFields

Word.signatureFields

Line.signatureFields

TextColumn.signatureFields

Paragraph.signatureFields

TextStyleRange.signatureFields

InsertionPoint.signatureFields

TextFrame.signatureFields

Story.signatureFields

EndnoteTextFrame.signatureFields

XmlStory.signatureFields

ShowHideFieldsBehavior.fieldsToHide

Page.tabOrder

ShowHideFieldsBehavior.fieldsToShow