application

The InDesign application.

application elements

Name Refer to By
auto correct tables by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
books by numeric index, as a range of elements, before/after another element, satisfying a
test
character styles by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
colors by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
dashed stroke styles by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
dialogs by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
display settings by numeric index, as a range of elements, before/after another element, satisfying a
test
document presets by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
documents by numeric index, as a range of elements, before/after another element, satisfying a
test
dotted stroke styles by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
flattener presets by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
fonts by numeric index, as a range of elements, before/after another element, satisfying a
test
gradients by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
inks by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
languages with vendors by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
layout windows by numeric index, as a range of elements, before/after another element, satisfying a
test
libraries by numeric index, as a range of elements, before/after another element, satisfying a
test
mixed ink groups by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
mixed inks by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
object styles by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
paragraph styles by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
p d f export presets by numeric index, as a range of elements, before/after another element, satisfying a
test
printer presets by numeric index, as a range of elements, before/after another element, satisfying a
test
story windows by numeric index, as a range of elements, before/after another element, satisfying a
test
striped stroke styles by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
stroke styles by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
swatches by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
tints by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
trap presets by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
user dictionaries by numeric index, as a range of elements, before/after another element, satisfying a
test
windows by numeric index, as a range of elements, before/after another element, satisfying a
test
x m l export maps by numeric index, as a range of elements, before/after another element, satisfying a
test
x m l import maps by numeric index, as a range of elements, before/after another element, satisfying a
test
x m l tags by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID

application properties

Property Type Access Description
active document document r/w The active (front-most) document.
active script alias or string read The file path to the script running from the Scripts palette.
active window window, layout window, story window r/w The active (front-most) window.
anchored object defaults anchored object default read Anchored object defaults.
anchored object settings anchored object setting read Anchored object settings for the object.
auto correct preferences auto correct preference read Auto correct preferences.
baseline frame grid options baseline frame grid option read The baseline frame grid options.
button preferences button preference read Button preferences.
change preferences change preference, nothing enum enumeration r/w The current change settings for InDesign’s find/change feature. This object corresponds
to options found in the Find/Change panel (including the options in the Change Format
Settings section of that panel).
enumerations
nothing
class integer read The class descriptor type.
clipboard preferences clipboard preference read Clipboard preferences.
color settings color setting read Color management settings.
data merge options data merge option read Data merge options.
diagnostics diagnostics object read The Diagnostics object.
dictionary preferences dictionary preference read User dictionary preferences. This object corresponds to the Dictionary panel of the
Preferences dialog box.
display performance preferences display performance preference read Display performance preferences. This object corresponds to the Display Performance
panel of the Preferences dialog box.
document preferences document preference read Document preferences. This object corresponds to the document panel of the Preferences
dialog box.
EPS export preferences EPS export preference read EPS export preferences.
EPS import preferences EPS import preference read EPS import preferences.
excel import preferences excel import preference read The application’s default Excel Import preferences. This object corresponds to the
Excel Import dialog box (which appears when a user imports an Excel document and has
turned on the Show Options option in the Place dialog box).
feature set feature set options enumeration read Feature set of the application (Roman or Japanese).
enumerations
roman, japanese
file path alias or string read The complete path to the folder that contains the application.
find preferences find preference, nothing enum enumeration r/w The current find settings for InDesign’s find/change feature. This object corresponds
to options found in the Find/Change panel (including the options in the Find Format
Settings section of that panel).
enumerations
nothing
footnote options footnote option read Footnote options.
full name alias or string read The file path to the application, including the file name.
galley preferences galley preference read Story Editor preferences. This object corresponds to the Story Editor Display panel of
the Preferences dialog box.
general preferences general preference read General preferences. This object corresponds to the General panel of the Preferences
dialog box.
grabber preferences grabber preference read Hand tool scrolling preferences. This object corresponds to the settings in the
Scrolling section of the Display Performance panel of the Preferences dialog box.
grid preferences grid preference read Grid preferences. This object corresponds to the Grids panel of the Preferences dialog
box.
guide preferences guide preference read Guide preferences. This object corresponds to the Guides and Pasteboard panel of the
Preferences dialog box.
image IO preferences image IO preference read Image IO preferences.
IME preferences IME preference read Input Method Editor (IME) preferences.
index generation options index options read The options controlling index generation. This object corresponds to the Generate index
dialog box. (To display this dialog box, choose Generate index from the index palette
menu).
JPEG export preferences JPEG export preference read JPEG export preferences.
layout adjustment preferences layout adjustment preference read The application’s default layout adjustment preferences. The properties in this object
correspond to the options shown in the Layout Adjustment dialog box. (Choose Layout
Adjustment from the Layout menu to display this dialog box).
locale locale enumeration read The locale of the application.
enumerations
danish locale, english locale, international english locale, finnish locale,
french locale, german locale, italian locale, portuguese locale, spanish locale,
swedish locale, japanese locale
margin preferences margin preference read Margin preferences. These settings affect all new documents that you create, but have no
effect on the margin preferences of existing documents. This object corresponds to the
options found in the Margins and columns dialog box.
modal state boolean read If true, a modal dialog (or alert) is active.
name string read The name of the object.
object reference object read An object reference for this object.
palettes visible boolean r/w If true, the palettes are displayed.
parent object read The parent of the object.
pasteboard preferences pasteboard preference read Pasteboard preferences. The properties of this object correspond to the
pasteboard-related options in the Guides and Pasteboard panel of the Preferences dialog
box.
PDF export preferences PDF export preference read PDF export preferences.
PDF place preferences PDF place preference read PDF place preferences.
placeable file extensions list of strings read A list of file types (extensions) that can be placed.
placeable file types list of strings read A list of file types that can be placed.
polygon preferences polygon preference read Polygon preferences. This object corresponds to the Polygon Settings dialog box. (To
display this dialog box, double-click the Polygon tool in the Tools palette.).
properties record r/w Property that allows setting of several properties at the same time.
QA scripting object QAScript read QA scripting object.
redo history list of strings read A list of events in the redo queue.
redo name string read The name of the event at the top of the redo queue.
script args script arg read Script arguments.
script preferences script preference read Scripting environment preferences.
selection object, list of objects, nothing enum enumeration r/w The current selection.
enumerations
nothing
spell preferences spell preference read Spelling preferences. This object corresponds to the Spelling panel of the Preferences
dialog box.
story preferences story preference read Story preferences. This object corresponds to the Story palette. These settings affect
all new documents, but have no effect on the story preferences in existing documents.
SVG export preferences SVG export preference read SVG export preferences.
tagged text export preferences tagged text export preference read Tagged text export preferences. This object corresponds to the Tagged Text Export
dialog box, which appears when you export tagged text.
tagged text import preferences tagged text import preference read Tagged text import preferences. This object corresponds to the Tagged Text Import
dialog box (which appears when you import a tagged text file and have turned on the Show
Options option in the Place dialog box).
test is running boolean read Whether a test is currently running.
test time accumulator fixed r/w QA test time accumulator property.
text defaults text default read The default text formatting for the application. This affects all new documents, and has
no effect on existing documents.
text editing preferences text editing preference read Text editing preferences.
text export preferences text export preference read The text export preferences.
text frame preferences text frame preference read Text frame preferences.
text import preferences text import preference read The text import preferences.
text preferences text preference read Text preferences.
transform preferences transform preference read Transform preferences.
transparency preferences transparency preference read Transparency preferences.
undo history list of strings read The names of the events in the undo queue.
undo name string read The name of the most recent event in the undo queue.
unused swatches list of swatches read A list of unused swatches.
user color list of 3 fixed (0 – 255), InCopy UI colors enumeration r/w The user color for tracked changes and notes.
enumerations
canary, lemon, electrolyte, lime, forest, lichen, jade, aqua, cirrus, ether,
slate, ultramarine, midnight, blueberry, eggplant, grape, fuchsia, iris, carnation,
mocha, wheat, mustard, amber, cornstarch, powder, smoke, graphite, gunmetal, light
blue, red, green, blue, yel-low, magenta, cyan, gray, black, orange, dark green,
teal, tan, brown, violet, gold, dark blue, pink, lavender, brick red, olive green,
peach, burgundy, grass green, ochre, purple, light gray, charcoal, grid blue, grid
orange, fiesta, light olive, lipstick, cute teal, sulphur, grid green, white
user name string r/w The user name for tracked changes and notes.
version string read Version of the application.
view preferences view preference read View preferences.
visible boolean read If true, the application is visible.
word RTF import preferences word RTF import preference read Word and RTF import preferences.
XML export preferences XML export preference read XML export preferences.
XML import preferences XML import preference read XML import preferences.
XML preferences XML preference read XML preferences.
XML view preferences XML view preference read XML view preferences.

application methods

Method Returns Description
activate Nothing Brings the application to the front.
cascade windows Nothing Arranges the open windows in a “cascade” (i.e., overlapping windows).
copy Nothing Copies the selection.
cut Nothing Cuts the selection.
delete unused tags Nothing Deletes all unused XML markup tags.
do script anything Runs a script. The script can be either a file or a string.
Parameter Type Description
[language] script
language enumeration		 The language of the script to execute. If not
speci-fied, the language used to call this method is
used.
enumerations
applescript language,
javascript
script alias or string
or string		 The script to execute.
export presets Nothing Export the presets to a
file.
Parameter Type Description
format export
preset format enu-meration		 The preset
format.
enumerations
PDF export presets
format, printer presets format, flattener presets format, document presets
format
to alias or string A
file to which to export the object.
import Nothing Import a presets file into InDesign.
Parameter Type Description
format export
preset format enu-meration		 The preset
format.
enumerations
PDF export presets format,
printer presets format, flattener presets format, document presets
format
from alias or string A
file to import.
import Adobe swatchbook process color color Import a process color from a preloaded Adobe color book.
Parameter Type Description
name string Name
of a swatch book process color.
import Adobe swatchbook spot color color Import a spot color from a preloaded Adobe color book.
Parameter Type Description
name string Name
of a swatch book spot color.
import styles Nothing Import styles from a file.
Parameter Type Description
format import
format enu-meration		 The
format.
enumerations
character styles format,
paragraph styles format, text styles format, TOC styles format, object styles
format, stroke styles
format
from alias or string An
InDesign file to import from.
[global strategy] global
clash resolution strategy enu-meration		 The global clash resolution
strategy.
enumerations
load all with overwrite,
load all with rename, do not load the
style
load swatches Nothing Load swatches from a file.
Parameter Type Description
from alias or
string		 The file to load swatches from.
load XML tags Nothing Load a set of XML tags from a file.
Parameter Type Description
from alias or
string		 What to import from.
open document, book, library or list of documents, books or libraries Opens a document, book, or library.
Parameter Type Description
from alias or
string or list of aliases or strings		 One or more file
paths.
[showing window] boolean Whether to show the
document in a window.
paste Nothing Pastes data from the clipboard.
paste in place Nothing Paste data from the clipboard into front document window at the same position as the
original.
paste into Nothing Pastes data from the clipboard into the selected object.
paste without formatting Nothing Paste data without formatting from the clipboard into front document window.
place Nothing Places a file.
Parameter Type Description
file name alias
or string		 The file to place.
[showing
options]		 boolean Whether to display the import options
dialog.
[with prop-erties] record Initial values for
properties of the new object.
print Nothing Print one or more documents.
Parameter Type Description
from alias or
string or list of aliases or strings		 One or more file
paths.
[print dialog] boolean Whether to invoke the
print dialog.
[using] default/cus-tom or printer
preset		 Printer preset to use.
publish terminology Nothing Generate an AppleScript dictionary.
Parameter Type Description
version fixed The
version to publish.
QATest string QA test event.
Parameter Type Description
named string Name
of test.
[with pa-rameter] string Parameter(s) of
test.
quit Nothing Quits the application.
Parameter Type Description
[saving] save
options enumeration		 Whether to save changes before closing open
documents.
enumerations
no, ask,
yes
redo Nothing Redo the last action.
save swatches Nothing Saves the specified swatches to a swatchbook file.
Parameter Type Descriptions
watch list list
of swatches		 The list of swatches to save.
to alias
or string		 The swatchbook file to save to.
save XML tags Nothing Saves XML tags to a file.
Parameter Type Description
to alias or
string		 Where to export to.
search list of texts Searches for text and returns a list of text objects matching the search string and/or
formatting specified by the find preferences. Search can also replace the text and/or
formatting. This command corresponds to InDesign’s Find/Change feature.
Parameter Type Description
[case
sensi-tive]		 boolean If true, then search only for text that matches
case.
[for] string What to look
for.
[replacing with] string What to replace the
found text with, either a string or a special character.
[whole
word]		 boolean If true, then disregard text embedded within a larger
word.
[with change at-tributes] record A record of
change preference settings to use.
[with find
attributes]		 record A record of find preference settings to
use.
select Nothing Selects the object.
Parameter Type Description
[existing
selection]		 selection options enu-meration How to handle the existing
selection.
enumerations
add to, remove from,
replace with
selectable
items		 object, list of objects, noth-ing or all The object(s) to
select.
tile windows Nothing Arranges the open windows in a “tiled” layout (i.e., non-overlapping windows).
undo Nothing Undo the last action.
update fonts Nothing Forces a check for new fonts in the various Fonts folders.

Leave a Comment

Previous post:

Next post: