Brushes

app.activeDocument.brushes

Description

A collection of brush objects in a document.


Properties

Brushes.length

app.activeDocument.brushes.length

Description

The number of objects in the collection

Type

Number; read-only.


Brushes.parent

app.activeDocument.brushes.parent

Description

The document that contains this brushes collection.

Type

Object; read-only.


Brushes.typename

app.activeDocument.brushes.typename

Description

The class name of the referenced object.

Type

String; read-only.


Methods

Brushes.getByName()

app.activeDocument.brushes.getByName(name)

Description

Gets the first element in the collection with the specified name.

Parameters

Parameter

Type

Description

name

String

Name of element to get

Returns

Brush


Brushes.index()

app.activeDocument.brushes.index(itemKey)

Description

Gets an element from the collection.

Parameters

Parameter

Type

Description

itemKey

String, Number

String or number key

Returns

Brush


Example

Counting brushes

// Counts all brushes in the active document

if (app.documents.length > 0) {
  var numberOfBrushes = app.activeDocument.brushes.length;
}