InDesign DOM 2023-2026

http://indesign.cs5.xyz/dom/
Admin
InDesign DOM 2023-2026 is an interactive document object model map and reference guide for scripting...
Tokens:1,355,169
Snippets:5,856
Trust Score:7
Update:5 days ago
Show doc for...
Tokens:
Raw
### Guides.anyItem()

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns any Guide object from the collection.

```APIDOC
## Guides.anyItem()

### Description
Returns any Guide object from the collection.

### Method
- **anyItem()** - Returns a Guide object.

### Returns
- **Guide** - An arbitrary Guide object from the collection.

### Example
```javascript
var anyGuide = app.activeDocument.guides.anyItem();
```
```

--------------------------------

### Guides.everyItem()

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns an array of all Guide objects in the collection.

```APIDOC
## Guides.everyItem()

### Description
Returns an array of all Guide objects in the collection.

### Method
- **everyItem()** - Returns an array of Guide objects.

### Returns
- **Guide (Array)** - An array containing all Guide objects.

### Example
```javascript
var allGuides = app.activeDocument.guides.everyItem();
```
```

--------------------------------

### Guides.firstItem()

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the first Guide object in the collection.

```APIDOC
## Guides.firstItem()

### Description
Returns the first Guide object in the collection.

### Method
- **firstItem()** - Returns a Guide object.

### Returns
- **Guide** - The first Guide object.

### Example
```javascript
var firstGuide = app.activeDocument.guides.firstItem();
```
```

--------------------------------

### Guides.nextItem(obj)

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the Guide object immediately after the specified object.

```APIDOC
## Guides.nextItem(obj)

### Description
Returns the Guide object immediately after the specified object.

### Method
- **nextItem(obj)** - Returns a Guide object.

### Parameters
- **obj** (Guide) - Required - The reference Guide object.

### Returns
- **Guide** - The Guide object that follows the specified object.

### Example
```javascript
var nextGuide = app.activeDocument.guides.nextItem(someGuide);
```
```

--------------------------------

### Guides.itemByName(name)

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the Guide object with the specified name.

```APIDOC
## Guides.itemByName(name)

### Description
Returns the Guide object with the specified name.

### Method
- **itemByName(name)** - Returns a Guide object.

### Parameters
- **name** (String) - Required - The name of the Guide object.

### Returns
- **Guide** - The Guide object with the given name.

### Example
```javascript
var guide = app.activeDocument.guides.itemByName("MyGuide");
```
```

--------------------------------

### Guides.previousItem(obj)

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the Guide object immediately before the specified object.

```APIDOC
## Guides.previousItem(obj)

### Description
Returns the Guide object immediately before the specified object.

### Method
- **previousItem(obj)** - Returns a Guide object.

### Parameters
- **obj** (Guide) - Required - The reference Guide object.

### Returns
- **Guide** - The Guide object that precedes the specified object.

### Example
```javascript
var prevGuide = app.activeDocument.guides.previousItem(someGuide);
```
```

--------------------------------

### Guides.item(index)

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the Guide object specified by index or name.

```APIDOC
## Guides.item(index)

### Description
Returns the Guide object specified by index or name.

### Method
- **item(index)** - Returns a Guide object.

### Parameters
- **index** (Number, String) - Required - The index or name of the Guide object.

### Returns
- **Guide** - The Guide object at the specified index or with the specified name.

### Example
```javascript
var guide = app.activeDocument.guides.item(0);
```
```

--------------------------------

### Guide Object Methods

Source: http://indesign.cs5.xyz/dom/Guide.html

Methods available on the Guide object for manipulating guides in InDesign.

```APIDOC
## addEventListener(eventType, handler, [captures])

### Description
Creates an EventListener for the Guide object.

### Method
addEventListener

### Parameters
- **eventType** (string) - Required - The event type to listen for.
- **handler** (File, JavaScript function) - Required - The handler function or file.
- **captures** (boolean) - Optional - Deprecated.

### Returns
- **EventListener** - The created EventListener.

## detach()

### Description
Detaches an overridden master page item from the master.

### Method
detach

### Parameters
None

### Returns
None

## duplicate()

### Description
Duplicates the Guide object and returns the duplicate.

### Method
duplicate

### Parameters
None

### Returns
- **Guide** - The duplicated Guide object.

## extractLabel(key)

### Description
Retrieves the value associated with the given key.

### Method
extractLabel

### Parameters
- **key** (string) - Required - The key to look up.

### Returns
- **string** - The value associated with the key.

## getElements()

### Description
Returns an array of Guide objects that match the object reference.

### Method
getElements

### Parameters
None

### Returns
- **Array of Guide** - The array of Guide objects.

## insertLabel(key, value)

### Description
Sets a value for the given key.

### Method
insertLabel

### Parameters
- **key** (string) - Required - The key.
- **value** (string) - Required - The value to set.

### Returns
None

## move([to], [by])

### Description
Moves the guide. Either 'to' or 'by' is required.

### Method
move

### Parameters
- **to** (Array of 2 numbers or length values) - Optional - The destination coordinates.
- **by** (Array of 2 numbers or length values) - Optional - The relative offset.

### Returns
None

## override(destinationPage)

### Description
Overrides a master page item on the specified page.

### Method
override

### Parameters
- **destinationPage** (Page) - Required - The page where the override is placed.

### Returns
- **Object** - The created object.

## remove()

### Description
Deletes the Guide object.

### Method
remove

### Parameters
None

### Returns
None

## removeEventListener(eventType, handler, [captures])

### Description
Removes an EventListener from the Guide object.

### Method
removeEventListener

### Parameters
- **eventType** (string) - Required - The event type.
- **handler** (File, JavaScript function) - Required - The handler function or file.
- **captures** (boolean) - Optional - Deprecated.

### Returns
- **boolean** - True if the listener was removed successfully.

## removeOverride()

### Description
Removes the override from the guide.

### Method
removeOverride

### Parameters
None

### Returns
None

## resolve(location, in, [consideringRulerUnits])

### Description
Gets the coordinates of the given location in the specified coordinate system.

### Method
resolve

### Parameters
- **location** (varies) - Required - The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
- **in** (CoordinateSpaces) - Required - The coordinate space to use.
- **consideringRulerUnits** (boolean) - Optional - Whether to use ruler units (default false).

### Returns
- **varies** - The coordinates in the specified coordinate system.

## select([existingSelection])

### Description
Selects the guide.

### Method
select

### Parameters
- **existingSelection** (SelectionOptions) - Optional - How to handle existing selection (default SelectionOptions.REPLACE_WITH).

### Returns
None

## toSource()

### Description
Returns a string representing the source code of the object.

### Method
toSource

### Parameters
None

### Returns
- **string** - The source code string.

## toSpecifier()

### Description
Retrieves the object specifier.

### Method
toSpecifier

### Parameters
None

### Returns
- **string** - The object specifier.

## transformValuesOf(in)

### Description
Gets the transformation values in the specified coordinate space.

### Method
transformValuesOf

### Parameters
- **in** (CoordinateSpaces) - Required - The coordinate space to use.

### Returns
- **Array of TransformationMatrix** - The transformation values.
```

--------------------------------

### createGuides([numberOfRows], [numberOfColumns], [rowGutter], [columnGutter], [guideColor], [fitMargins], [removeExisting], [layer])

Source: http://indesign.cs5.xyz/dom/Spread.html

Creates guides on the spread with configurable rows, columns, gutters, color, margin fitting, and layer.

```APIDOC
## createGuides([numberOfRows], [numberOfColumns], [rowGutter], [columnGutter], [guideColor], [fitMargins], [removeExisting], [layer])

### Description
Creates guides on the spread.

### Method
createGuides

### Parameters
- **[numberOfRows]** (number) - Optional - Number of rows (0-40, default 0).
- **[numberOfColumns]** (number) - Optional - Number of columns (0-40, default 0).
- **[rowGutter]** (length) - Optional - Row gutter (0-1440 pt, default 0).
- **[columnGutter]** (length) - Optional - Column gutter (0-1440 pt, default 0).
- **[guideColor]** (Array of [r,g,b] or UIColors) - Optional - Guide color (RGB values 0-255).
- **[fitMargins]** (boolean) - Optional - Whether to snap to page margins. Default: false.
- **[removeExisting]** (boolean) - Optional - Whether to remove existing guides. Default: false.
- **[layer]** (Layer) - Optional - The layer to create guides on.

### Returns
- None
```

--------------------------------

### Guides.add([layer], [withProperties])

Source: http://indesign.cs5.xyz/dom/Guide.html

Creates a new Guide object and returns it. Optionally specifies the layer and initial properties.

```APIDOC
## Guides.add([layer], [withProperties])

### Description
Creates a new Guide object and returns it. Optionally specifies the layer and initial properties.

### Method
- **add([layer], [withProperties])** - Returns a Guide object.

### Parameters
- **layer** (Layer) - Optional - The layer on which to create the guide.
- **withProperties** (Object) - Optional - Property values to set on the new guide.

### Returns
- **Guide** - The newly created Guide object.

### Example
```javascript
var newGuide = app.activeDocument.guides.add();
```
```

--------------------------------

### get(name)

Source: http://indesign.cs5.xyz/dom/ScriptArg.html

指定されたキーの値を取得します。

```APIDOC
## get(name)

### Description
値を取得します。

### Method
get

### Parameters
- **name** (文字列値) - 必須 - キーの名前

### Returns
文字列値
```

--------------------------------

### place(fileName, [showingOptions], [withProperties])

Source: http://indesign.cs5.xyz/dom/Sound.html

Places a file into the sound object and returns the placed object(s).

```APIDOC
## place(fileName, [showingOptions], [withProperties])

### Description
Places a file into the sound object and returns the placed object(s).

### Method
place

### Parameters
- **fileName** (File) - Required - The file to place.
- **[showingOptions]** (Boolean) - Optional - Whether to show options dialog (default false).
- **[withProperties]** (Object) - Optional - Properties to set.

### Returns
Array of varies (any)
```

--------------------------------

### memoryStatistics()

Source: http://indesign.cs5.xyz/dom/Application.html

Gets memory statistics.

```APIDOC
## memoryStatistics()

### Description
Gets memory statistics.

### Parameters
None

### Returns
Array of any
```

--------------------------------

### place(fileName, [showingOptions], [withProperties])

Source: http://indesign.cs5.xyz/dom/Text.html

Places a file into the text. Returns an array of placed objects.

```APIDOC
## place(fileName, [showingOptions], [withProperties])

### Description
Places a file into the text.

### Method
place

### Parameters
- **fileName** (ファイル) - Required - ファイル名
- **[showingOptions]** (真偽値) - Optional - オプションのダイアログを表示させるか (既定値=false)
- **[withProperties]** (Object) - Optional - プロパティを設定

### Returns
Array( varies=any )
```

--------------------------------

### Guides.middleItem()

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the middle Guide object in the collection.

```APIDOC
## Guides.middleItem()

### Description
Returns the middle Guide object in the collection.

### Method
- **middleItem()** - Returns a Guide object.

### Returns
- **Guide** - The middle Guide object.

### Example
```javascript
var middleGuide = app.activeDocument.guides.middleItem();
```
```

--------------------------------

### place(fileName, [showingOptions], [withProperties])

Source: http://indesign.cs5.xyz/dom/WMF.html

Places a file into the WMF object and returns the placed objects.

```APIDOC
## place(fileName, [showingOptions], [withProperties])

### Description
Places a file into the WMF object and returns the placed objects.

### Method
place

### Parameters
- **fileName** (ファイル) - Required - The file to place.
- **[showingOptions]** (真偽値) - Optional - Whether to show the options dialog (default false).
- **[withProperties]** (Object) - Optional - Properties to set.

### Response
Returns Array( varies=any ).
```

--------------------------------

### Guides.lastItem()

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the last Guide object in the collection.

```APIDOC
## Guides.lastItem()

### Description
Returns the last Guide object in the collection.

### Method
- **lastItem()** - Returns a Guide object.

### Returns
- **Guide** - The last Guide object.

### Example
```javascript
var lastGuide = app.activeDocument.guides.lastItem();
```
```

--------------------------------

### place(fileName, [placePoint], [destinationLayer], [showingOptions], [autoflowing], [withProperties])

Source: http://indesign.cs5.xyz/dom/MasterSpread.html

Places a file into the MasterSpread and returns the placed objects.

```APIDOC
## place(fileName, [placePoint], [destinationLayer], [showingOptions], [autoflowing], [withProperties])

### Description
Places a file into the MasterSpread and returns the placed objects.

### Parameters
- **fileName** (File) - Required - The file to place.
- **placePoint** (Array of 2 numbers) - Optional - The coordinates (x, y) for the placement.
- **destinationLayer** (Layer) - Optional - The layer to place onto.
- **showingOptions** (boolean) - Optional - Whether to show the options dialog. Default is false.
- **autoflowing** (boolean) - Optional - Whether to autoflow. Default is false.
- **withProperties** (Object) - Optional - Properties to set on the placed object.

### Returns
- Array of varies (any) - The placed objects.
```

--------------------------------

### place(fileName, [showingOptions], [withProperties])

Source: http://indesign.cs5.xyz/dom/Image.html

Places a file into the image, returning the placed objects.

```APIDOC
## place(fileName, [showingOptions], [withProperties])

### Description
Places a file into the image. Returns an array of placed objects.

### Method
place

### Parameters
- **fileName** (File) - Required - The file to place.
- **[showingOptions]** (Boolean) - Optional - Whether to show the options dialog (default false).
- **[withProperties]** (Object) - Optional - Properties to set.

### Returns
Array(any) - The placed objects.
```

--------------------------------

### Guides.length

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the number of Guide objects in the collection.

```APIDOC
## Guides.length

### Description
Returns the number of Guide objects in the collection.

### Property
- **length** (Number) - Read-only - The number of objects in the collection.

### Example
```javascript
var count = app.activeDocument.guides.length;
```
```

--------------------------------

### place(fileName, [showingOptions], [withProperties])

Source: http://indesign.cs5.xyz/dom/EPS.html

Places a file into the EPS object and returns the placed objects.

```APIDOC
## place(fileName, [showingOptions], [withProperties])

### Description
Places a file into the EPS object and returns the placed objects.

### Method
place

### Parameters
- **fileName** (ファイル) - Required - The file to place.
- **[showingOptions]** (真偽値) - Optional - Whether to show the options dialog. Default is false.
- **[withProperties]** (Object) - Optional - Properties to set on the placed object.

### Return Value
Array( varies=any ) - The placed objects.
```

--------------------------------

### getAllOverlays(portraitDocumentForCheckingOverlays, landscapeDocumentForCheckingOverlays, [miniFolioParams])

Source: http://indesign.cs5.xyz/dom/Application.html

Gets all overlays.

```APIDOC
## getAllOverlays(portraitDocumentForCheckingOverlays, landscapeDocumentForCheckingOverlays, [miniFolioParams])

### Description
Gets all overlays.

### Method
Function call

### Parameters
- **portraitDocumentForCheckingOverlays** (Document) - Required - The portrait document.
- **landscapeDocumentForCheckingOverlays** (Document) - Required - The landscape document.
- **miniFolioParams** (Array) - Optional - Options for exporting a mini folio. dataField: String, dataValue: Any Type.

### Return Value
Array of any - The overlays.
```

--------------------------------

### Guides.itemByID(id)

Source: http://indesign.cs5.xyz/dom/Guide.html

Returns the Guide object with the specified ID.

```APIDOC
## Guides.itemByID(id)

### Description
Returns the Guide object with the specified ID.

### Method
- **itemByID(id)** - Returns a Guide object.

### Parameters
- **id** (Number) - Required - The unique ID of the Guide object.

### Returns
- **Guide** - The Guide object with the given ID.

### Example
```javascript
var guide = app.activeDocument.guides.itemByID(123);
```
```

--------------------------------

### place(fileName, [showingOptions], [withProperties])

Source: http://indesign.cs5.xyz/dom/Word.html

Places a file into the Word object and returns the placed object.

```APIDOC
## place(fileName, [showingOptions], [withProperties])

### Description
Places a file into the Word object.

### Method
place

### Parameters
- **fileName** (File) - Required - File name.
- **showingOptions** (boolean) - Optional - Show options dialog (default false).
- **withProperties** (Object) - Optional - Properties to set.

### Returns
Array of varies (any)

```

--------------------------------

### ParagraphDestination.extractLabel(key)

Source: http://indesign.cs5.xyz/dom/ParagraphDestination.html

Gets the value associated with the specified key.

```APIDOC
## ParagraphDestination.extractLabel(key)

### Description
Gets the value associated with the specified key.

### Method
extractLabel

### Parameters
- **key** (String) - Required - The key.

### Returns
String - The value associated with the key.
```

--------------------------------

### HyperlinkPageItemSource.extractLabel(key)

Source: http://indesign.cs5.xyz/dom/HyperlinkPageItemSource.html

Gets the value associated with the specified key.

```APIDOC
## HyperlinkPageItemSource.extractLabel(key)

### Description
Gets the value associated with the specified key.

### Method
extractLabel

### Parameters
- **key** (String) - Required - The key.

### Returns
String
```

--------------------------------

### place(fileName, [showingOptions], [withProperties])

Source: http://indesign.cs5.xyz/dom/Polygon.html

Places a file into the polygon, returning the placed objects.

```APIDOC
## place(fileName, [showingOptions], [withProperties])

### Description
Places a file into the polygon, returning the placed objects.

### Method
Method call

### Parameters
- **fileName** (File) - Required - The file to place.
- **showingOptions** (boolean) - Optional - Whether to show the options dialog (default=false).
- **withProperties** (Object) - Optional - Properties to set.

### Returns
Array(any) - The placed objects.
```

--------------------------------

### open(from, [showingWindow], [openOption])

Source: http://indesign.cs5.xyz/dom/Application.html

Opens a document, book, or library. The from parameter can be a file or an array of files. The showingWindow parameter controls whether the window is shown, and openOption specifies the open mode.

```APIDOC
## open(from, [showingWindow], [openOption])

### Description
Opens a document, book, or library. The from parameter can be a file or an array of files. The showingWindow parameter controls whether the window is shown, and openOption specifies the open mode.

### Parameters
- **from** (File or Array of File) - Required - The file name(s).
- **showingWindow** (Boolean) - Optional - Whether to show the window. Default is true.
- **openOption** (OpenOptions) - Optional - The open option. Possible values: DEFAULT_VALUE, OPEN_COPY, OPEN_ORIGINAL. Default is DEFAULT_VALUE.

### Returns
Document, Book, or Library
```

--------------------------------

### getApplicationAtIndex(indexOfApp, [withProperties])

Source: http://indesign.cs5.xyz/dom/EPubExportPreviewAppPreference.html

Gets the application at the specified index.

```APIDOC
## getApplicationAtIndex(indexOfApp, [withProperties])

### Description
Get the application at index.

### Method
getApplicationAtIndex

### Parameters
- **indexOfApp** (Boolean) - Required - The index of the application to get information for.
- **[withProperties]** (Object) - Optional - Properties to set.

### Returns
any (varies)
```

--------------------------------

### transformValuesOf

Source: http://indesign.cs5.xyz/dom/ComboBox.html

Gets the transformation values in the specified coordinate space.

```APIDOC
## transformValuesOf

### Description
Gets the transformation values in the specified coordinate space.

### Method
transformValuesOf

### Parameters
#### Required Parameters
- **in** (CoordinateSpaces) - The coordinate space to use. Possible values: INNER_COORDINATES, PAGE_COORDINATES, PARENT_COORDINATES, PASTEBOARD_COORDINATES, SPREAD_COORDINATES.

### Returns
Array of TransformationMatrix
```
Tokens:
Raw