Adobe InDesign CS (3.0) Object Model JS: Application

InDesign CS

previous page next page

Class

Application

The InDesign application

QuickLinks

activate, cascadeWindows, copy, cut, deleteUnusedTags, doScript, exportPresets, importFile, importStyles, loadXMLTags, open, paste, pasteInPlace, pasteInto, print, quit, saveXMLTags, search, select, tileWindows

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.
books	Books	readonly	A collection of books.
buttonPreferences	ButtonPreference	readonly	Button preference settings.
changePreferences	ChangePreference	r/w	The change preferences
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.
filePath	File	readonly	The full path to the file.
findPreferences	FindPreference	r/w	The find preference properties that define default text or attribute searches.
flattenerPresets	FlattenerPresets	readonly	A collection of transparency flattener presets.
fonts	Fonts	readonly	A collection of fonts.
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.
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 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.
name	string	readonly	The name of the Application.
notePreferences	NotePreference	readonly	Note preference settings.
packageForGoLivePreferences	PackageForGoLivePreference	readonly	The Package For GoLive preference properties that define how a document is packaged for GoLive.
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.
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.
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.
taggedTextExportPreferences	TaggedTextExportPreference	readonly	Tagged text export preferences.
taggedTextImportPreferences	TaggedTextImportPreference	readonly	Tagged text import preferences.
textDefaults	TextDefault	readonly	Text default 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.
tocStyles	TOCStyles	readonly	A collection of TOC styles.
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.
unusedSwatches	Array of Swatch	readonly	The swatches that are not being used.
userDictionaries	UserDictionaries	readonly	A collection of user dictionaries.
userInteractionLevel	UserInteractionLevels: UserInteractionLevels.NEVER_INTERACT UserInteractionLevels.INTERACT_WITH_ALL	r/w	Controls the display of dialogs and alerts during script processing.
userName	string	r/w	The user associated with the tracked changes and notes.
version	number	readonly	Version of the application
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.
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.

void doScript (script: any[, language: ScriptLanguage=ScriptLanguage.UNKNOWN])
Run a script in a specific language

Parameter	Type	Description
script	File String	The script to execute. Can accept: File or String.
language	ScriptLanguage: ScriptLanguage.UNKNOWN ScriptLanguage.VISUAL_BASIC ScriptLanguage.JAVASCRIPT	The language of the script to execute. If not specified, the language used to call this method is used. (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.

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)
Import styles.

Parameter	Type	Description
format	ImportFormat: ImportFormat.CHARACTER_STYLES_FORMAT ImportFormat.PARAGRAPH_STYLES_FORMAT ImportFormat.TEXT_STYLES_FORMAT ImportFormat.TOC_STYLES_FORMAT	The type of styles to import.
from	File	an InDesign file to import from

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 a document, book, or library.

Parameter	Type	Description
from	Array of Files File	The file path to the file to open. 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 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 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])
Select one or more objects.

Parameter	Type	Description
selectableItems	Array of Objects NothingEnum Object	The object(s) to select. Can accept: Object, Array of Objects or NothingEnum enumerator.
existingSelection	SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE	How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE)