Topics
A collection of index topics.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
Topic [] (index:Number)
Returns the Topic with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Topic add (name:String, sortBy:String, withProperties:Object)
Creates a new index topic.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name of the topic. Note: This is the text that appears in the index. |
|
|
sortBy |
The string to sort this topic by instead of the topic name. Note: The actual topic text, rather than the sort order text, appears in the index. (Optional) |
|
|
withProperties |
Initial values for properties of the new Topic (Optional) |
Topic anyItem ()
Returns any Topic in the collection.
Number count ()
Displays the number of elements in the Topic.
Topic everyItem ()
Returns every Topic in the collection.
Topic firstItem ()
Returns the first Topic in the collection.
Topic item (index:Varies LongInteger String)
Returns the Topic with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
Topic itemByName (name:String)
Returns the Topic with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Topic itemByRange (from:Varies LongInteger Topic String, to:Varies LongInteger Topic String)
Returns the Topics within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The Topic, index, or name at the beginning of the range. Can accept: Topic, Long Integer or String. |
|
to |
LongInteger |
The Topic, index, or name at the end of the range. Can accept: Topic, Long Integer or String. |
Topic lastItem ()
Returns the last Topic in the collection.
Topic middleItem ()
Returns the middle Topic in the collection.
Topic nextItem (obj:Topic)
Returns the Topic whose index follows the specified Topic in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Topic whose index comes before the desired Topic. |
Topic previousItem (obj:Topic)
Returns the Topic with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Topic that follows the desired Topic. |
String toSource ()
Generates a string which, if executed, will return the Topic.
Object of
Index.topics
Topic.topics
IndexSection.topics