HtmlItems

A collection of embedded HTML page items.

Go to Property Listing | Method Listing

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

HtmlItem [] (index:Number)

Returns the HtmlItem with the specified index.

Parameter	Type	Description
index	Number	The index.

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

Creates a new HtmlItem

Parameter	Type	Description
layer	Layer	The layer on which to create the HtmlItem. (Optional)
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location at which to insert the HtmlItem 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 HtmlItem (Optional)

HtmlItem anyItem ()

Returns any HtmlItem in the collection.

Number count ()

Displays the number of elements in the HtmlItem.

HtmlItem everyItem ()

Returns every HtmlItem in the collection.

HtmlItem firstItem ()

Returns the first HtmlItem in the collection.

HtmlItem item (index:Varies LongInteger String)

Returns the HtmlItem with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

HtmlItem itemByID (id:Number)

Returns the HtmlItem with the specified ID.

Parameter	Type	Description
id	Number	The ID.

HtmlItem itemByName (name:String)

Returns the HtmlItem with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the HtmlItems within the specified range.

Parameter	Type	Description
from	HtmlItem LongInteger String	The HtmlItem, index, or name at the beginning of the range. Can accept: HtmlItem, Long Integer or String.
to	HtmlItem LongInteger String	The HtmlItem, index, or name at the end of the range. Can accept: HtmlItem, Long Integer or String.

Parameter

Type

Description

from

HtmlItem

LongInteger

String

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

HtmlItem

LongInteger

String

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

HtmlItem lastItem ()

Returns the last HtmlItem in the collection.

HtmlItem middleItem ()

Returns the middle HtmlItem in the collection.

HtmlItem nextItem (obj:HtmlItem)

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

Parameter	Type	Description
obj	HtmlItem	The HtmlItem whose index comes before the desired HtmlItem.

HtmlItem previousItem (obj:HtmlItem)

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

Parameter	Type	Description
obj	HtmlItem	The index of the HtmlItem that follows the desired HtmlItem.

String toSource ()

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

Object of

Oval.htmlItems

Rectangle.htmlItems

GraphicLine.htmlItems

Polygon.htmlItems

SplineItem.htmlItems