Adobe InDesign CS6 (8.0) Object Model JS: SignatureFields

InDesign CS6

Class

SignatureFields

 A collection of signature fields.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

SignatureField [] (index: number)
Returns the SignatureField with the specified index.

ParameterTypeDescription
indexnumberThe index.

SignatureField add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new SignatureField

ParameterTypeDescription
layerLayerThe layer on which to create the SignatureField. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the SignatureField relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
PageItem
Spread
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withPropertiesObjectInitial 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.

Array of SignatureField everyItem ()
Returns every SignatureField in the collection.

SignatureField firstItem ()
Returns the first SignatureField in the collection.

SignatureField item (index: varies)
Returns the SignatureField with the specified index or name.

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

SignatureField itemByID (id: number)
Returns the SignatureField with the specified ID.

ParameterTypeDescription
idnumberThe ID.

SignatureField itemByName (name: string)
Returns the SignatureField with the specified name.

ParameterTypeDescription
namestringThe name.

Array of SignatureField itemByRange (from: varies, to: varies)
Returns the SignatureFields within the specified range.

ParameterTypeDescription
fromLong Integer
SignatureField
String
The SignatureField, index, or name at the beginning of the range. Can accept: SignatureField, Long Integer or String.
toLong Integer
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.

ParameterTypeDescription
objSignatureFieldThe SignatureField whose index comes before the desired SignatureField.

SignatureField previousItem (obj: SignatureField)
Returns the SignatureField with the index previous to the specified index.

ParameterTypeDescription
objSignatureFieldThe index of the SignatureField that follows the desired SignatureField.

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

Element of

Cell.signatureFields

Character.signatureFields

Document.signatureFields

GraphicLine.signatureFields

Group.signatureFields

InsertionPoint.signatureFields

Layer.signatureFields

Line.signatureFields

MasterSpread.signatureFields

Oval.signatureFields

Page.signatureFields

Page.tabOrder

Paragraph.signatureFields

PlaceGun.signatureFields

Polygon.signatureFields

Rectangle.signatureFields

ShowHideFieldsBehavior.fieldsToHide

ShowHideFieldsBehavior.fieldsToShow

Snippet.signatureFields

SplineItem.signatureFields

Spread.signatureFields

Story.signatureFields

Table.signatureFields

Text.signatureFields

TextColumn.signatureFields

TextFrame.signatureFields

TextStyleRange.signatureFields

Word.signatureFields

XmlStory.signatureFields

Jongware, 28-Apr-2012 v3.0.3hContents :: Index