Adobe InDesign CS2 (4.0) Object Model JS: Application

InDesign CS2

previous page next page

Class

Application

The application.

QuickLinks

activate, cascadeWindows, copy, cut, deleteUnusedTags, doScript, exportPresets, getElements, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importCellStyles, importFile, importStyles, importTableStyles, loadSwatches, loadXMLTags, open, paste, pasteInPlace, pasteInto, pasteWithoutFormatting, place, print, quit, redo, saveSwatches, saveXMLTags, search, select, tileWindows, toSource, toSpecifier, undo, updateFonts

Hierarchy

Application

Application

Properties

Property	Type	Access	Description
activeDocument	Document	r/w	The front-most document.
activeScript	File	readonly	The current script running from the Scripts panel.
activeWindow	LayoutWindow StoryWindow Window	r/w	The front-most window. Can return: Window, LayoutWindow or StoryWindow.
anchoredObjectDefaults	AnchoredObjectDefault	readonly	Anchored object default settings.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
autoCorrectPreferences	AutoCorrectPreference	readonly	Auto-correct preferences.
autoCorrectTables	AutoCorrectTables	readonly	A collection of auto-correct tables.
baselineFrameGridOptions	BaselineFrameGridOption	readonly	Baseline frame grid option settings.
books	Books	readonly	A collection of books.
buttonPreferences	ButtonPreference	readonly	Button preference settings.
cellStyles	CellStyles	readonly	All cell styles
changePreferences	ChangePreference NothingEnum	r/w	The change preference properties that define the default text or attributes to which to change found text or attributes. Can also accept: NothingEnum enumerator.
characterStyles	CharacterStyles	readonly	A collection of character styles.
clipboardPreferences	ClipboardPreference	readonly	Clipboard preference properties that define the way that the application interacts with the system clipboard.
colorSettings	ColorSetting	readonly	Color setting properties that define color management defaults.
colors	Colors	readonly	A collection of colors.
dashedStrokeStyles	DashedStrokeStyles	readonly	A collection of dashed stroke styles.
dataMergeOptions	DataMergeOption	readonly	The data merge option properties that define the data merge.
dialogs	Dialogs	readonly	A collection of dialogs.
dictionaryPreferences	DictionaryPreference	readonly	User dictionary preference settings.
displayPerformancePreferences	DisplayPerformancePreference	readonly	Display performance settings.
displaySettings	DisplaySettings	readonly	Display setting properties.
documentPreferences	DocumentPreference	readonly	Document preference settings.
documentPresets	DocumentPresets	readonly	A collection of document presets.
documents	Documents	readonly	A collection of documents.
dottedStrokeStyles	DottedStrokeStyles	readonly	A collection of dotted stroke styles.
epsExportPreferences	EPSExportPreference	readonly	EPS export preferences.
epsImportPreferences	EPSImportPreference	readonly	EPS import preferences.
excelImportPreferences	ExcelImportPreference	readonly	Excel import preferences.
featureSet	FeatureSetOptions: FeatureSetOptions.ROMAN FeatureSetOptions.JAPANESE FeatureSetOptions.RIGHTTOLEFT	readonly	The feature set.
filePath	File	readonly	The full path to the file.
findPreferences	FindPreference NothingEnum	r/w	The find preference properties that define default text or attribute searches. Can also accept: NothingEnum enumerator.
flattenerPresets	FlattenerPresets	readonly	A collection of transparency flattener presets.
fonts	Fonts	readonly	A collection of fonts.
footnoteOptions	FootnoteOption	readonly	Footnote option settings.
fullName	File	readonly	The full path to the Application, including the name of the Application.
galleyPreferences	GalleyPreference	readonly	Galley preference settings.
generalPreferences	GeneralPreference	readonly	General preference settings.
grabberPreferences	GrabberPreference	readonly	Grabber preference properties that define display performance quality during scrolling.
gradients	Gradients	readonly	A collection of gradients.
gridPreferences	GridPreference	readonly	Grid preference settings.
guidePreferences	GuidePreference	readonly	Guide preference settings.
imageIOPreferences	ImageIOPreference	readonly	The image I/O preference properties that define preferences for importing images.
imePreferences	IMEPreference	readonly	IME preference settings.
indexGenerationOptions	IndexOptions	readonly	The index options properties that define how an index is formatted.
inks	Inks	readonly	A collection of inks.
jpegExportPreferences	JPEGExportPreference	readonly	JPEG export preferences.
languagesWithVendors	LanguagesWithVendors	readonly	A collection of languages with vendors.
layoutAdjustmentPreferences	LayoutAdjustmentPreference	readonly	Layout sdjustment preference settings.
layoutWindows	LayoutWindows	readonly	A collection of layout windows.
libraries	Libraries	readonly	A collection of object libraries.
locale	Locale: Locale.DANISH_LOCALE Locale.ENGLISH_LOCALE Locale.INTERNATIONAL_ENGLISH_LOCALE Locale.FINNISH_LOCALE Locale.FRENCH_LOCALE Locale.GERMAN_LOCALE Locale.ITALIAN_LOCALE Locale.PORTUGUESE_LOCALE Locale.SPANISH_LOCALE Locale.SWEDISH_LOCALE Locale.JAPANESE_LOCALE	readonly	The locale of the application.
marginPreferences	MarginPreference	readonly	Margin preference settings.
mixedInkGroups	MixedInkGroups	readonly	A collection of mixed ink groups.
mixedInks	MixedInks	readonly	A collection of mixed inks.
modalState	bool	readonly	If true, a modal dialog or alert is active.
name	string	readonly	The name of the Application.
notePreferences	NotePreference	readonly	Note preference settings.
objectStyles	ObjectStyles	readonly	A collection of object styles.
palettesVisible	bool	r/w	If true, displays the palettes.
paragraphStyles	ParagraphStyles	readonly	A collection of paragraph styles.
parent	Application	readonly	The parent of the Application (a Application).
pasteboardPreferences	PasteboardPreference	readonly	Pasteboard preference settings.
pdfExportPreferences	PDFExportPreference	readonly	A collection of PDF export preferences.
pdfExportPresets	PDFExportPresets	readonly	A collection of PDF export presets.
pdfPlacePreferences	PDFPlacePreference	readonly	The PDF place preference properties that define how PDF files are placed in the current document.
placeableFileExtensions	Array of string	readonly	Lists the extensions of file types that can be placed.
placeableFileTypes	Array of string	readonly	Lists the types of files that can be placed.
polygonPreferences	PolygonPreference	readonly	Polygon preference properties to use to define default settings for creating a polygon.
printerPresets	PrinterPresets	readonly	A collection of printer presets.
properties	Object	r/w	A property that allows setting of several properties at the same time.
redoHistory	Array of string	readonly	The names of the items in the redo stack.
redoName	string	readonly	The name of the action on the top of the redo stack.
scriptArgs	ScriptArg	readonly	Arguments to pass to a script.
scriptPreferences	ScriptPreference	readonly	Script preferences.
selection	Array of Objects NothingEnum Object	r/w	The selection. Can return: Object, Array of Objects or NothingEnum enumerator.
spellPreferences	SpellPreference	readonly	Spell-check preferences.
storyExportPreferences	StoryExportPreference	readonly	Story export preference settings.
storyPreferences	StoryPreference	readonly	Story preference settings.
storyWindows	StoryWindows	readonly	A collection of story windows.
stripedStrokeStyles	StripedStrokeStyles	readonly	A collection of striped stroke styles.
strokeStyles	StrokeStyles	readonly	A collection of stroke styles.
svgExportPreferences	SVGExportPreference	readonly	SVG export preferences.
swatches	Swatches	readonly	A collection of swatches.
tableStyles	TableStyles	readonly	All table styles
taggedTextExportPreferences	TaggedTextExportPreference	readonly	Tagged text export preferences.
taggedTextImportPreferences	TaggedTextImportPreference	readonly	Tagged text import preferences.
textDefaults	TextDefault	readonly	Text default settings.
textEditingPreferences	TextEditingPreference	readonly	Text editing preference settings.
textExportPreferences	TextExportPreference	readonly	Text export preferences.
textFramePreferences	TextFramePreference	readonly	Text frame preference settings.
textImportPreferences	TextImportPreference	readonly	Text import preferences.
textPreferences	TextPreference	readonly	Text preference settings.
tints	Tints	readonly	A collection of tints.
transformPreferences	TransformPreference	readonly	Transform preference properties that define default behaviors when transforming objects. Note: Transforming includes rotation, scaling, flipping, and shearing.
transparencyPreferences	TransparencyPreference	readonly	Transparency preference settings.
trapPresets	TrapPresets	readonly	A collection of trap presets.
undoHistory	Array of string	readonly	The names of the items in the undo stack.
undoName	string	readonly	The name of the action on the top of the undo stack.
unusedSwatches	Array of Swatch	readonly	The swatches that are not being used.
userColor	3 Reals (0 - 255) InCopyUIColors	r/w	The color assigned to the tracked changes and notes created by the user, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
userDictionaries	UserDictionaries	readonly	A collection of user dictionaries.
userName	string	r/w	The user associated with the tracked changes and notes.
version	string	readonly	The application version.
viewPreferences	ViewPreference	readonly	View preference settings.
visible	bool	readonly	If true, the Application is visible.
windows	Windows	readonly	A collection of windows.
wordRTFImportPreferences	WordRTFImportPreference	readonly	Word and RTF import preferences.
xmlExportMaps	XMLExportMaps	readonly	A collection of XML export maps.
xmlExportPreferences	XMLExportPreference	readonly	XML export preference settings.
xmlImportMaps	XMLImportMaps	readonly	A collection of XML import maps.
xmlImportPreferences	XMLImportPreference	readonly	XML import preference settings.
xmlPreferences	XMLPreference	readonly	The XML preference settings.
xmlTags	XMLTags	readonly	A collection of XML tags.
xmlViewPreferences	XMLViewPreference	readonly	XML view preference settings.

Methods

Instances

void activate ()
Makes the application the front-most or active window.

void cascadeWindows ()
Cascades all document windows.

void copy ()
Copies the selection in the active document window to the clipboard.

void cut ()
Cuts the selection in the active document window and stores it in the clipboard.

void deleteUnusedTags ()
Deletes unused XML markup tags.

any doScript (script: any[, language: ScriptLanguage=ScriptLanguage.UNKNOWN])
Runs a script in a specified language.

Parameter	Type	Description
script	File String	The script. Can accept: File or String.
language	ScriptLanguage: ScriptLanguage.UNKNOWN ScriptLanguage.VISUAL_BASIC ScriptLanguage.JAVASCRIPT	The language of the script. Note: If not specified, uses the language used to call this method. (Optional) (default: ScriptLanguage.UNKNOWN)

void exportPresets (format: ExportPresetFormat, to: File)
Export the file's presets to the specified file.

Parameter	Type	Description
format	ExportPresetFormat: ExportPresetFormat.PDF_EXPORT_PRESETS_FORMAT ExportPresetFormat.PRINTER_PRESETS_FORMAT ExportPresetFormat.FLATTENER_PRESETS_FORMAT ExportPresetFormat.DOCUMENT_PRESETS_FORMAT	The type of preset to export.
to	File	The file to export the presets to.

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

Color importAdobeSwatchbookProcessColor (name: string)
Imports a process color swatch from a preloaded Adobe color book.

Parameter	Type	Description
name	string	The process color to load.

Color importAdobeSwatchbookSpotColor (name: string)
Imports a spot color swatch from an Adobe color book.

Parameter	Type	Description
name	string	The spot color to load.

void importCellStyles (from: File, replaceOption: ReplaceOption)
Used to load cell styles from another document

Parameter	Type	Description
from	File	The file to load styles from
replaceOption	ReplaceOption: ReplaceOption.OVERWRITE ReplaceOption.RENAME	overwrite, or rename

void importFile (format: ExportPresetFormat, from: File)
Imports presets from the specified file.

Parameter	Type	Description
format	ExportPresetFormat: ExportPresetFormat.PDF_EXPORT_PRESETS_FORMAT ExportPresetFormat.PRINTER_PRESETS_FORMAT ExportPresetFormat.FLATTENER_PRESETS_FORMAT ExportPresetFormat.DOCUMENT_PRESETS_FORMAT	The type of preset to import.
from	File	The file to import presets from.

void importStyles (format: ImportFormat, from: File[, globalStrategy: GlobalClashResolutionStrategy=GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE])
Imports the specified styles.

Parameter	Type	Description
format	ImportFormat: ImportFormat.CHARACTER_STYLES_FORMAT ImportFormat.PARAGRAPH_STYLES_FORMAT ImportFormat.TEXT_STYLES_FORMAT ImportFormat.TOC_STYLES_FORMAT ImportFormat.OBJECT_STYLES_FORMAT ImportFormat.STROKE_STYLES_FORMAT	The types of styles to import.
from	File	The file containing the styles you want to import.
globalStrategy	GlobalClashResolutionStrategy: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE GlobalClashResolutionStrategy.LOAD_ALL_WITH_RENAME GlobalClashResolutionStrategy.DO_NOT_LOAD_THE_STYLE	The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) (default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE)

void importTableStyles (from: File, replaceOption: ReplaceOption)
Used to load table styles from another document

Parameter	Type	Description
from	File	The file to load styles from
replaceOption	ReplaceOption: ReplaceOption.OVERWRITE ReplaceOption.RENAME	overwrite, or rename

void loadSwatches (from: File)
Load swatches from the specified file.

Parameter	Type	Description
from	File	The swatch file or InDesign document.

void loadXMLTags (from: File)
Loads a set of XML markup tags from the specified file.

Parameter	Type	Description
from	File	The path to the file that contains the tags.

any open (from: any[, showingWindow: bool=true])
Opens the specified document, book, or library.

Parameter	Type	Description
from	Array of Files File	The file path(s) to the document, book, or library. Can accept: File or Array of Files.
showingWindow	bool	If true, opens the document in a window. If false, the document is opened but is not displayed in a window. (Optional) (default: true)

void paste ()
Pastes data from the clipboard into the active document window.

void pasteInPlace ()
Pastes data from the clipboard into the active document window at the same position that the data held in its original document.

void pasteInto ()
Pastes data from the clipboard into the selected object in the active document window.

void pasteWithoutFormatting ()
Pastes data (minus formatting) from the clipboard into the active document window.

void place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Place a file following the behavior of the place menu item

Parameter	Type	Description
fileName	File	The file to place
showingOptions	bool	Whether to display the import options dialog (Optional) (default: false)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

void print (from: any[, printDialog: bool][, using: any])
Prints the specified file(s).

Parameter	Type	Description
from	Array of Files File	One or more file paths. Can accept: File or Array of Files.
printDialog	bool	Whether to invoke the print dialog (Optional)
using	PrinterPreset PrinterPresetTypes	Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

void quit ([saving: SaveOptions=SaveOptions.ASK])
Quits the application.

Parameter	Type	Description
saving	SaveOptions: SaveOptions.NO SaveOptions.ASK SaveOptions.YES	The option to use for saving changes to open documents before quitting. (Optional) (default: SaveOptions.ASK)

void redo ()
Redoes the last action.

void saveSwatches (to: File, swatchList: Array of Swatch)
Saves the specified swatches to a file.

Parameter	Type	Description
to	File	The swatch file. Note: The format must be either .ase (Adobe Swatches Exchange) or a format native to the application that will use the file.
swatchList	Array of Swatch	The swatches to save.

void saveXMLTags (to: File)
Saves the XML markup tags as an XML file.

Parameter	Type	Description
to	File	The name and location of the XML file.

Array of Text search ([for: string][, wholeWord: bool][, caseSensitive: bool][, replacingWith: string][, withFindAttributes: Object][, withChangeAttributes: Object])
Look for occurrences of text that matches specific criteria

Parameter	Type	Description
for	string	What to look for (Optional)
wholeWord	bool	If true, then disregard text embedded within a larger word (Optional)
caseSensitive	bool	If true, then search only for text that matches case (Optional)
replacingWith	string	What to replace the found text with, either a string or a special character (Optional)
withFindAttributes	Object	A record of find preference settings to use (Optional)
withChangeAttributes	Object	A record of change preference settings to use (Optional)

void select (selectableItems: any[, existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).

Parameter	Type	Description
selectableItems	Array of Objects NothingEnum Object SelectAll	The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection	SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the Application in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)