TypefiElementInstances

A list of Typefi element instances

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

TypefiElementInstance [] (index:Number)

Returns the TypefiElementInstance with the specified index.

Parameter	Type	Description
index	Number	The index.

TypefiElementInstance add (definition:Varies TypefiElementDefinition String, externalId:String, [variantName:String=String], withProperties:Object)

Create a new TypefiElementInstance

Parameter	Type	Description
definition	TypefiElementDefinition String	Definition. Can accept: TypefiElementDefinition or String.
externalId	String	The id to identify the instance
variantName	String	Optional variant name (Optional) (default: )
withProperties	Object	Initial values for properties of the new TypefiElementInstance (Optional)

TypefiElementInstance anyItem ()

Returns any TypefiElementInstance in the collection.

Number count ()

Displays the number of elements in the TypefiElementInstance.

TypefiElementInstance everyItem ()

Returns every TypefiElementInstance in the collection.

TypefiElementInstance firstItem ()

Returns the first TypefiElementInstance in the collection.

TypefiElementInstance item (index:Varies LongInteger String)

Returns the TypefiElementInstance 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.

TypefiElementInstance itemByID (id:Number)

Returns the TypefiElementInstance with the specified ID.

Parameter	Type	Description
id	Number	The ID.

TypefiElementInstance itemByName (name:String)

Returns the TypefiElementInstance with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the TypefiElementInstances within the specified range.

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

Parameter

Type

Description

from

LongInteger

TypefiElementInstance

String

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

LongInteger

TypefiElementInstance

String

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

TypefiElementInstance lastItem ()

Returns the last TypefiElementInstance in the collection.

TypefiElementInstance middleItem ()

Returns the middle TypefiElementInstance in the collection.

TypefiElementInstance nextItem (obj:TypefiElementInstance)

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

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

TypefiElementInstance previousItem (obj:TypefiElementInstance)

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

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

String toSource ()

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

Object of

Document.typefiElementInstances