Documents

A collections class allowing for array access into the application's list of documents that are currently open, while also providing familiar methods from ExtendScript, like getByName.

// Iterate through all the documents
app.documents.forEach(h => console.log(h.title));

Indexable

▪ [index: number]: Document

Used to access the documents in the collection.

// Iterate through all the documents
app.documents.forEach(h => console.log(h.title));

Properties

Methods

add

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

<br/> async : Promise<Document>

Create a new document.

No options will create a document of 7 x 5 inches at 300 pixels per inch. This is the same as the "Default Photoshop Size" preset.

An object with a 'preset' string parameter can be used to specify any of the other presets that come installed with Photoshop or created by users.

An object with one or more parameters can also be supplied. Any parameter missing will be set to the default of: width 2100 pixels, height 1500 pixels, resolution 300 pixels per inch, mode: @RGBColorMode and a fill of white with no transparency.

// "Default Photoshop Size" 7x5 inches at 300ppi
let newDoc1 = await app.documents.add();
let newDoc2 = await app.documents.add({
   width: 800, 
   height: 600, 
   resolution: 300, 
   mode: "RGBColorMode", 
   fill: "transparent"
});
let newDoc3 = await app.documents.add({preset: "My Default Size 1"});

Parameters

getByName

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">22.5</span>

<br/> Document

Find the first document with the matching name.

Parameters