Ovals
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Oval [] (index:
number)
Returns the Oval with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Oval add ([layer:
Layer][, at:
LocationOptions=LocationOptions.UNKNOWN][, reference:
varies][, withProperties:
Object])
Creates a new Oval
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the Oval. (Optional) |
| at | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location at which to insert the Oval relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
| reference | Document Layer MasterSpread Page PageItem Spread | 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 Oval (Optional) |
Oval anyItem ()
Returns any Oval in the collection.
number count ()
Displays the number of elements in the Oval.
Array of Oval everyItem ()
Returns every Oval in the collection.
Oval firstItem ()
Returns the first Oval in the collection.
Oval item (index:
varies)
Returns the Oval with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
Oval itemByID (id:
number)
Returns the Oval with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
Oval itemByName (name:
string)
Returns the Oval with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of Oval itemByRange (from:
varies, to:
varies)
Returns the Ovals within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer Oval String | The Oval, index, or name at the beginning of the range. Can accept: Oval, Long Integer or String. |
| to | Long Integer Oval String | The Oval, index, or name at the end of the range. Can accept: Oval, Long Integer or String. |
Oval lastItem ()
Returns the last Oval in the collection.
Oval middleItem ()
Returns the middle Oval in the collection.
Oval nextItem (obj:
Oval)
Returns the Oval whose index follows the specified Oval in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Oval | The Oval whose index comes before the desired Oval. |
Oval previousItem (obj:
Oval)
Returns the Oval with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Oval | The index of the Oval that follows the desired Oval. |
string toSource ()
Generates a string which, if executed, will return the Oval.
Element of
Button.ovals
Cell.ovals
Character.ovals
CheckBox.ovals
ComboBox.ovals
Document.ovals
Footnote.ovals
GraphicLine.ovals
Group.ovals
InsertionPoint.ovals
Layer.ovals
Line.ovals
ListBox.ovals
MasterSpread.ovals
MultiStateObject.ovals
Oval.ovals
Page.ovals
Paragraph.ovals
PlaceGun.ovals
Polygon.ovals
RadioButton.ovals
Rectangle.ovals
SignatureField.ovals
Snippet.ovals
SplineItem.ovals
Spread.ovals
State.ovals
Story.ovals
Table.ovals
Text.ovals
TextBox.ovals
TextColumn.ovals
TextFrame.ovals
TextStyleRange.ovals
Word.ovals
XmlStory.ovals
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |