CrossReferenceSources
A collection of cross reference text sources.
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 |
---|---|---|---|
readonly |
The number of objects in the collection. |
Method Listing
CrossReferenceSource [] (index:Number)
Returns the CrossReferenceSource with the specified index.
Parameter |
Type |
Description |
---|---|---|
index |
The index. |
CrossReferenceSource add (source:Text, appliedFormat:CrossReferenceFormat, withProperties:Object)
Creates a new cross reference text source.
Parameter |
Type |
Description |
---|---|---|
source |
The text or insertion point to create the source. |
|
appliedFormat |
Format used for cross reference source. |
|
withProperties |
Initial values for properties of the new CrossReferenceSource (Optional) |
CrossReferenceSource anyItem ()
Returns any CrossReferenceSource in the collection.
Number count ()
Displays the number of elements in the CrossReferenceSource.
CrossReferenceSource everyItem ()
Returns every CrossReferenceSource in the collection.
CrossReferenceSource firstItem ()
Returns the first CrossReferenceSource in the collection.
CrossReferenceSource item (index:Varies LongInteger String)
Returns the CrossReferenceSource with the specified index or name.
Parameter |
Type |
Description |
---|---|---|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
CrossReferenceSource itemByID (id:Number)
Returns the CrossReferenceSource with the specified ID.
Parameter |
Type |
Description |
---|---|---|
id |
The ID. |
CrossReferenceSource itemByName (name:String)
Returns the CrossReferenceSource with the specified name.
Parameter |
Type |
Description |
---|---|---|
name |
The name. |
CrossReferenceSource itemByRange (from:Varies CrossReferenceSource LongInteger String, to:Varies CrossReferenceSource LongInteger String)
Returns the CrossReferenceSources within the specified range.
Parameter |
Type |
Description |
---|---|---|
from |
LongInteger |
The CrossReferenceSource, index, or name at the beginning of the range. Can accept: CrossReferenceSource, Long Integer or String. |
to |
LongInteger |
The CrossReferenceSource, index, or name at the end of the range. Can accept: CrossReferenceSource, Long Integer or String. |
CrossReferenceSource lastItem ()
Returns the last CrossReferenceSource in the collection.
CrossReferenceSource middleItem ()
Returns the middle CrossReferenceSource in the collection.
CrossReferenceSource nextItem (obj:CrossReferenceSource)
Returns the CrossReferenceSource whose index follows the specified CrossReferenceSource in the collection.
Parameter |
Type |
Description |
---|---|---|
obj |
The CrossReferenceSource whose index comes before the desired CrossReferenceSource. |
CrossReferenceSource previousItem (obj:CrossReferenceSource)
Returns the CrossReferenceSource with the index previous to the specified index.
Parameter |
Type |
Description |
---|---|---|
obj |
The index of the CrossReferenceSource that follows the desired CrossReferenceSource. |
String toSource ()
Generates a string which, if executed, will return the CrossReferenceSource.
Object of
Document.crossReferenceSources