EndnoteTextFrames

A collection of endnote text frames.

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

EndnoteTextFrame [] (index:Number)

Returns the EndnoteTextFrame with the specified index.

Parameter

Type

Description

index

Number

The index.

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

Creates a new EndnoteTextFrame

Parameter

Type

Description

layer

Layer

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

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location at which to insert the EndnoteTextFrame 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 EndnoteTextFrame (Optional)

EndnoteTextFrame anyItem ()

Returns any EndnoteTextFrame in the collection.

Number count ()

Displays the number of elements in the EndnoteTextFrame.

EndnoteTextFrame everyItem ()

Returns every EndnoteTextFrame in the collection.

EndnoteTextFrame firstItem ()

Returns the first EndnoteTextFrame in the collection.

EndnoteTextFrame item (index:Varies LongInteger String)

Returns the EndnoteTextFrame with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

EndnoteTextFrame itemByID (id:Number)

Returns the EndnoteTextFrame with the specified ID.

Parameter

Type

Description

id

Number

The ID.

EndnoteTextFrame itemByName (name:String)

Returns the EndnoteTextFrame with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the EndnoteTextFrames within the specified range.

Parameter

Type

Description

from

EndnoteTextFrame

LongInteger

String

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

to

EndnoteTextFrame

LongInteger

String

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

EndnoteTextFrame lastItem ()

Returns the last EndnoteTextFrame in the collection.

EndnoteTextFrame middleItem ()

Returns the middle EndnoteTextFrame in the collection.

EndnoteTextFrame nextItem (obj:EndnoteTextFrame)

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

Parameter

Type

Description

obj

EndnoteTextFrame

The EndnoteTextFrame whose index comes before the desired EndnoteTextFrame.

EndnoteTextFrame previousItem (obj:EndnoteTextFrame)

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

Parameter

Type

Description

obj

EndnoteTextFrame

The index of the EndnoteTextFrame that follows the desired EndnoteTextFrame.

String toSource ()

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

Object of

Document.endnoteTextFrames

Button.endnoteTextFrames

State.endnoteTextFrames

MultiStateObject.endnoteTextFrames

Layer.endnoteTextFrames

Spread.endnoteTextFrames

MasterSpread.endnoteTextFrames

Oval.endnoteTextFrames

Rectangle.endnoteTextFrames

GraphicLine.endnoteTextFrames

Polygon.endnoteTextFrames

Group.endnoteTextFrames

SplineItem.endnoteTextFrames

Cell.endnoteTextFrames

Table.endnoteTextFrames

Text.endnoteTextFrames

Character.endnoteTextFrames

Word.endnoteTextFrames

Line.endnoteTextFrames

TextColumn.endnoteTextFrames

Paragraph.endnoteTextFrames

TextStyleRange.endnoteTextFrames

InsertionPoint.endnoteTextFrames

TextFrame.endnoteTextFrames

Story.endnoteTextFrames

EndnoteTextFrame.endnoteTextFrames

XmlStory.endnoteTextFrames