Layer
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allGraphics | Array of Graphic | readonly | Lists all graphics contained by the Layer. |
| allPageItems | Array of PageItem | readonly | Lists all page items contained by the Layer. |
| buttons | Buttons Button | readonly | A collection of buttons. |
| checkBoxes | CheckBoxes | readonly | A collection of checkboxes. |
| comboBoxes | ComboBoxes | readonly | A collection of comboboxes. |
| epstexts | EPSTexts EPSText | readonly | EPSTexts |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| formFields | FormFields FormField | readonly | A collection of form fields. |
| graphicLines | GraphicLines GraphicLine | readonly | A collection of graphic lines. |
| groups | Groups Group | readonly | A collection of groups. |
| guides | Guides Guide | readonly | A collection of guides. |
| id | number | readonly | The unique ID of the Layer. |
| ignoreWrap | bool | readonly | If true, text wrap settings applied to objects on the layer will not affect text on other layers when the layer is hidden. |
| index | number | readonly | The index of the Layer within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| layerColor | 3 Reals (0 - 255) UIColors |
readonly | The color of the layer, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. |
| listBoxes | ListBoxes | readonly | A collection of listboxes. |
| lockGuides | bool | readonly | If true, the guide positions on the layer are locked. |
| locked | bool | readonly | If true, the Layer is locked. |
| multiStateObjects | MultiStateObjects MultiStateObject | readonly | A collection of multi-state objects. |
| name | string | readonly | The name of the Layer. |
| ovals | Ovals Oval | readonly | A collection of ellipses. |
| pageItems | PageItems PageItem | readonly | The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
| parent | Document | readonly | The parent of the Layer (a Document). |
| polygons | Polygons Polygon | readonly | A collection of polygons. |
| printable | bool | readonly | If true, the layer will print. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| radioButtons | RadioButtons RadioButton | readonly | A collection of radio buttons. |
| rectangles | Rectangles Rectangle | readonly | A collection of rectangles. |
| showGuides | bool | readonly | If true, guides are visible on the layer. |
| signatureFields | SignatureFields SignatureField | readonly | A collection of signature fields. |
| splineItems | SplineItems SplineItem | readonly | The spline items collection. |
| textBoxes | TextBoxes | readonly | A collection of text boxes. |
| textFrames | TextFrames TextFrame | readonly | A collection of text frames. |
| visible | bool | r/w | If true, the Layer is visible. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array
of Layer getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the Layer.
Element of
Button.itemLayer
CheckBox.itemLayer
ComboBox.itemLayer
EPS.itemLayer
EPSText.itemLayer
FormField.itemLayer
Graphic.itemLayer
GraphicLine.itemLayer
Group.itemLayer
Guide.itemLayer
HtmlItem.itemLayer
Image.itemLayer
ImportedPage.itemLayer
ListBox.itemLayer
MediaItem.itemLayer
Movie.itemLayer
MultiStateObject.itemLayer
Oval.itemLayer
PDF.itemLayer
PICT.itemLayer
PageItem.itemLayer
Polygon.itemLayer
RadioButton.itemLayer
Rectangle.itemLayer
SignatureField.itemLayer
Sound.itemLayer
SplineItem.itemLayer
TextBox.itemLayer
TextFrame.itemLayer
WMF.itemLayer
Used in:
Button Buttons.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
CheckBox CheckBoxes.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
ComboBox ComboBoxes.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
HtmlItem HtmlItems.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Layer Layers.nextItem (obj: Layer)
Layer Layers.previousItem (obj: Layer)
ListBox ListBoxes.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Movie Movies.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
MultiStateObject MultiStateObjects.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
RadioButton RadioButtons.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
SignatureField SignatureFields.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Sound Sounds.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
TextBox TextBoxes.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Return
Array of Layer Layer.getElements ()
Layer Layers.[] (index: number)
Layer Layers.anyItem ()
Array of Layer Layers.everyItem ()
Layer Layers.firstItem ()
Layer Layers.item (index: varies)
Layer Layers.itemByID (id: number)
Layer Layers.itemByName (name: string)
Array of Layer Layers.itemByRange (from: varies, to: varies)
Layer Layers.lastItem ()
Layer Layers.middleItem ()
Layer Layers.nextItem (obj: Layer)
Layer Layers.previousItem (obj: Layer)
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |