The application.
Go to Property Listing | Method Listing
addEventListener, addFontDirectory, changeColor, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, clearAllErrors, clearFrameFittingOptions, colorTransform, consoleerr, consoleout, createCustomMiniFolio, deleteFindChangeQuery, deleteUnusedTags, doScript, dumpBetweenMemoryMarks, dumpFromMemoryMark, exportArticleFolio, exportDpsArticle, exportFolioToDirectory, exportFolioToDirectoryPackage, exportFolioToPackage, exportMiniFolio, exportPresets, exportSettings, exportStrokeStyles, extractLabel, findColor, findGlyph, findGrep, findKeyStrings, findObject, findText, findTransliterate, generateIDMLSchema, getAllOverlays, getContextMathMLDescription, getDigpubArticleVersion, getDigpubVersion, getElements, getPathToExportMml2svg, getSupportedArticleViewerVersions, getSupportedViewerVersions, getUntitledCount, handleMathMLMessage, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importFile, importSettings, importStyles, insertLabel, internalMethod, loadConditions, loadFindChangeQuery, loadMotionPreset, loadPreflightProfile, loadSwatches, loadXMLTags, memoryStatistics, mountProject, open, packageUCF, performanceMetric, performanceMetricLongName, performanceMetricShortName, print, quit, recover, removeEventListener, removeFontDirectory, resetPreference, saveFindChangeQuery, saveSwatches, saveXMLTags, serverTest, setApplicationPreferences, setUntitledCount, toSource, toSpecifier, translateKeyString, unpackageUCF, updateFonts
AlignDistributePreference, AnchoredObjectDefault, AnchoredObjectSetting, AutoCorrectPreference, AutoCorrectTables, BaselineFrameGridOption, Book, Books, Boolean, ButtonPreference, CellStyle, CellStyleGroups, CellStyleMappings, CellStyles, ChangeColorPreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeObjectPreference, ChangeTextPreference, ChangeTransliteratePreference, CharStyleMappings, CharacterStyle, CharacterStyleGroups, CharacterStyles, CjkGridPreference, ClipboardPreference, ColorGroups, ColorSetting, Colors, CompositeFonts, ConditionSets, ConditionalTextPreference, Conditions, ContentPlacerObject, DashedStrokeStyles, DataMergeOption, DictionaryPreference, DocumentPreference, DocumentPresets, Documents, DottedStrokeStyles, EPSExportPreference, EPSImportPreference, EPubExportPreviewAppPreference, EndnoteOption, ErrorListErrors, EventListeners, Events, ExcelImportPreference, ExportForWebPreference, FeatureSetOptions, File, FindChangeColorOption, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeTextOption, FindChangeTransliterateOption, FindColorPreference, FindGlyphPreference, FindGrepPreference, FindObjectPreference, FindTextPreference, FindTransliteratePreference, FlattenerPresets, FontLockingPreference, FontSyncPreference, Fonts, FootnoteOption, FrameFittingOption, GeneralPreference, Gradients, GridPreference, GridPrintingPreference, GuidePreference, HttpLinkConnectionManagerObject, IdleTasks, ImageIOPreference, ImagePreference, ImportedPageAttribute, InCopyExportOption, InCopyUIColors, IndexOptions, IndexingSortOptions, Inks, InteractivePDFExportPreference, JPEGExportPreference, KinsokuTables, LanguagesWithVendors, LayoutGridDataInformation, Libraries, LinkedPageItemOption, LinkedStoryOption, LinkingPreference, Locale, MarginPreference, MixedInkGroups, MixedInks, MojikumiTables, MojikumiUiPreference, MotionPresets, NamedGrids, NothingEnum, Number, NumberingLists, Object, ObjectStyle, ObjectStyleGroups, ObjectStyles, PDFExportPreference, PDFExportPresets, PDFPlacePreference, PNGExportPreference, PageItemDefault, ParaStyleMappings, ParagraphStyle, ParagraphStyleGroups, ParagraphStyles, PasteboardPreference, PolygonPreference, Preferences, PreflightBookOption, PreflightOption, PreflightProcesses, PreflightProfiles, PreflightRules, PrinterPresets, ScriptArg, ScriptPreference, ServerSetting, SpellPreference, StoryGridDataInformation, StoryPreference, String, StripedStrokeStyles, StrokeStyles, Swatch, Swatches, TableStyle, TableStyleGroups, TableStyleMappings, TableStyles, TaggedPDFPreference, TaggedTextExportPreference, TaggedTextImportPreference, TextDefault, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TextVariables, TextWrapPreference, Tints, TrackChangesPreference, TransformPreference, TransformationMatrices, TransparencyPreference, TrapPresets, UndoModes, UserDictionaries, ViewPreference, WatermarkPreference, WordRTFImportPreference, XMLExportMaps, XMLExportPreference, XMLImportMaps, XMLImportPreference, XMLPreference, XMLRuleProcessors, XMLTags
AlignDistributePreference, AutoCorrectPreference, BaselineFrameGridOption, ButtonPreference, ChangeColorPreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeObjectPreference, ChangeTextPreference, ChangeTransliteratePreference, CjkGridPreference, ClipboardPreference, ConditionalTextPreference, DataMergeOption, DictionaryPreference, DocumentPreference, EPSExportPreference, EPSImportPreference, EPubExportPreviewAppPreference, EndnoteOption, ExcelImportPreference, ExportForWebPreference, FindChangeColorOption, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeTextOption, FindChangeTransliterateOption, FindColorPreference, FindGlyphPreference, FindGrepPreference, FindObjectPreference, FindTextPreference, FindTransliteratePreference, FontLockingPreference, FontSyncPreference, FootnoteOption, FrameFittingOption, GeneralPreference, GridPreference, GridPrintingPreference, GuidePreference, ImageIOPreference, ImagePreference, InCopyExportOption, IndexOptions, IndexingSortOptions, InteractivePDFExportPreference, JPEGExportPreference, LinkedPageItemOption, LinkedStoryOption, LinkingPreference, MarginPreference, MojikumiUiPreference, NothingEnum, PDFExportPreference, PDFPlacePreference, PNGExportPreference, PasteboardPreference, PolygonPreference, Preferences, PreflightBookOption, PreflightOption, ScriptPreference, SpellPreference, StoryPreference, TaggedPDFPreference, TaggedTextExportPreference, TaggedTextImportPreference, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TextWrapPreference, TrackChangesPreference, TransformPreference, TransparencyPreference, ViewPreference, WatermarkPreference, WordRTFImportPreference, XMLExportPreference, XMLImportPreference, XMLPreference
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
read/write |
The active book. |
||
|
readonly |
The current script running from the Scripts panel. |
||
|
readonly |
The undo mode for the current script execution. |
||
|
readonly |
Preferences for alignment and distribution. |
||
|
readonly |
All Cell styles |
||
|
readonly |
Lists all character styles (regardless of their group). |
||
|
Array of ObjectStyle |
readonly |
All object styles contained by the Application. |
|
|
readonly |
Lists all paragraph styles (regardless of their group). |
||
|
readonly |
The list of all object types (strings) a preflight rule can operate on. |
||
|
readonly |
The list of all categories that have been declared by rules. |
||
|
readonly |
The list of all known (declared) rule IDs. |
||
|
Array of TableStyle |
readonly |
All Table styles |
|
|
readonly |
Anchored object default settings. |
||
|
readonly |
Anchored object settings. |
||
|
readonly |
Auto-correct preferences. |
||
|
readonly |
A collection of auto-correct tables. |
||
|
read/write |
If true, enables the auto detection of flex layout attributes when adding elements to flex container from canvas. |
||
|
readonly |
Baseline frame grid option settings. |
||
|
readonly |
A collection of books. |
||
|
readonly |
Button preference settings. |
||
|
readonly |
A collection of cell style groups. |
||
|
readonly |
A collection of cell style mappings. |
||
|
readonly |
A collection of cell styles. |
||
|
read/write |
Change color preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Change glyph preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Change grep preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Change object preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Change text preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Change transliterate preferences. Can also accept: NothingEnum enumerator. |
||
|
readonly |
A collection of char style mappings. |
||
|
readonly |
A collection of character style groups. |
||
|
readonly |
A collection of character styles. |
||
|
readonly |
CJK grid preference settings. |
||
|
read/write |
Clear overrides first before applying object style |
||
|
readonly |
Clipboard preference properties that define the way that the application interacts with the system clipboard. |
||
|
readonly |
A collection of color groups. |
||
|
readonly |
Color setting properties that define color management defaults. |
||
|
readonly |
A collection of colors. |
||
|
readonly |
A collection of composite fonts. |
||
|
readonly |
A collection of condition sets for conditional text. |
||
|
readonly |
Conditional text preferences. |
||
|
readonly |
A collection of conditions for conditional text. |
||
|
readonly |
The Content Placer. Used to get a reference to the content placer object. |
||
|
readonly |
A collection of dashed stroke styles. |
||
|
readonly |
The data merge option properties that define the data merge. |
||
|
readonly |
User dictionary preference settings. |
||
|
readonly |
Document preference settings. |
||
|
readonly |
A collection of document presets. |
||
|
readonly |
A collection of documents. |
||
|
readonly |
A collection of dotted stroke styles. |
||
|
readonly |
Endnote option settings. |
||
|
readonly |
EPS export preferences. |
||
|
readonly |
EPS import preferences. |
||
|
readonly |
EPub export preview app preference settings. |
||
|
readonly |
A collection of error list errors. |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
Excel import preferences. |
||
|
readonly |
The default export for web preferences. |
||
|
readonly |
The feature set. |
||
|
readonly |
The full path to the file. |
||
|
read/write |
Find/change color options. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find/change glyph options. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find/change grep options. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find/change object options. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find/change text options. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find/change transliterate options. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find color preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find glyph preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find grep preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find object preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find text preferences. Can also accept: NothingEnum enumerator. |
||
|
read/write |
Find transliterate preferences. Can also accept: NothingEnum enumerator. |
||
|
readonly |
A collection of transparency flattener presets. |
||
|
readonly |
Font locking preference settings. |
||
|
readonly |
The font sync preference properties that define preferences for fonts. |
||
|
readonly |
A collection of fonts. |
||
|
readonly |
Footnote option settings. |
||
|
readonly |
The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application. |
||
|
readonly |
The full path to the Application, including the name of the Application. |
||
|
readonly |
General preference settings. |
||
|
readonly |
A collection of gradients. |
||
|
readonly |
Grid preference settings. |
||
|
readonly |
Grid printing preference and export settings. |
||
|
readonly |
Guide preference settings. |
||
|
read/write |
Experimental: Connection manager property |
||
|
readonly |
All attachable idle tasks. |
||
|
readonly |
The image I/O preference properties that define preferences for importing images. |
||
|
readonly |
Image preferences. |
||
|
readonly |
Placed InDesign page attributes. |
||
|
readonly |
Export options for InCopy INCX document format. |
||
|
readonly |
The index options properties that define how an index is formatted. |
||
|
readonly |
A collection of indexing sort options. |
||
|
readonly |
A collection of inks. |
||
|
readonly |
Interactive PDF export preferences. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
readonly |
JPEG export preferences. |
||
|
readonly |
A collection of kinsoku tables. |
||
|
read/write |
A property that can be set to any string. |
||
|
readonly |
A collection of languages with vendors. |
||
|
readonly |
Default properties specific to layout grids. |
||
|
readonly |
A collection of object libraries. |
||
|
readonly |
Linked Page Item options |
||
|
readonly |
Linked story options |
||
|
readonly |
The links preference properties that define preferences for links. |
||
|
readonly |
The locale of the application. |
||
|
readonly |
Margin preference settings. |
||
|
readonly |
A collection of mixed ink groups. |
||
|
readonly |
A collection of mixed inks. |
||
|
readonly |
A collection of mojikumi tables. |
||
|
readonly |
Mojikumi user interface preference settings. |
||
|
readonly |
A collection of Motion presets. |
||
|
readonly |
The name of the Application. |
||
|
readonly |
A collection of named grids. |
||
|
readonly |
A collection of numbered lists. |
||
|
readonly |
A collection of object style groups. |
||
|
readonly |
A collection of object styles. |
||
|
readonly |
The default page item formatting for the Application. |
||
|
readonly |
A collection of para style mappings. |
||
|
readonly |
A collection of paragraph style groups. |
||
|
readonly |
A collection of paragraph styles. |
||
|
readonly |
The parent of the Application (a Application). |
||
|
readonly |
Pasteboard preference settings. |
||
|
readonly |
A collection of PDF export preferences. |
||
|
readonly |
A collection of PDF export presets. |
||
|
readonly |
The PDF place preference properties that define how PDF files are placed in the current document. |
||
|
readonly |
The available performance metrics. |
||
|
readonly |
Lists the extensions of file types that can be placed. |
||
|
readonly |
Lists the types of files that can be placed. |
||
|
readonly |
PNG export preferences. |
||
|
readonly |
Polygon preference properties to use to define default settings for creating a polygon. |
||
|
readonly |
A collection of preferences objects. |
||
|
readonly |
Preflight book option settings. |
||
|
readonly |
Preflight option settings. |
||
|
readonly |
A collection of preflight processes. |
||
|
readonly |
A collection of preflight profiles. |
||
|
readonly |
A collection of preflight rules. |
||
|
readonly |
A collection of printer presets. |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
Arguments to pass to a script. |
||
|
readonly |
Script preferences. |
||
|
readonly |
The user's serial number. |
||
|
readonly |
The socket the server uses to service administrative requests. |
||
|
readonly |
The name of the machine InDesignServer is running on; either symbolic (host.corp.com) or IP address (123.345.678.90). |
||
|
readonly |
Runtime settings specific to server. |
||
|
readonly |
Spell-check preferences. |
||
|
readonly |
Default properties specific to frame grids. |
||
|
readonly |
Story preference settings. |
||
|
readonly |
A collection of striped stroke styles. |
||
|
readonly |
A collection of stroke styles. |
||
|
readonly |
A collection of swatches. |
||
|
readonly |
A collection of table style groups. |
||
|
readonly |
A collection of table style mappings. |
||
|
readonly |
A collection of table styles. |
||
|
readonly |
Tagged PDF preferences. |
||
|
readonly |
Tagged text export preferences. |
||
|
readonly |
Tagged text import preferences. |
||
|
readonly |
Text default settings. |
||
|
readonly |
Text export preferences. |
||
|
readonly |
Text frame preference settings. |
||
|
readonly |
Text import preferences. |
||
|
readonly |
Text preference settings. |
||
|
readonly |
A collection of text variables. |
||
|
readonly |
The text wrap preference properties that define the default formatting for wrapping text around objects. |
||
|
readonly |
A collection of tints. |
||
|
readonly |
Track changes preference settings. |
||
|
readonly |
Transform preference properties that define default behaviors when transforming objects. Note: Transforming includes rotation, scaling, flipping, and shearing. |
||
|
readonly |
A collection of transformation matrices. |
||
|
readonly |
Transparency preference settings. |
||
|
readonly |
A collection of trap presets. |
||
|
readonly |
The swatches that are not being used. |
||
|
readonly |
The current user's adobe id |
||
|
Array of 3 Reals (0 - 255) |
read/write |
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. |
|
|
readonly |
A collection of user dictionaries. |
||
|
readonly |
The current user's GUID |
||
|
read/write |
The user associated with the tracked changes and notes. |
||
|
readonly |
The application version. |
||
|
readonly |
View preference settings. |
||
|
readonly |
Watermark preferences |
||
|
readonly |
Word and RTF import preferences. |
||
|
readonly |
A collection of XML export maps. |
||
|
readonly |
XML export preference settings. |
||
|
readonly |
A collection of XML import maps. |
||
|
readonly |
XML import preference settings. |
||
|
readonly |
The XML preference settings. |
||
|
readonly |
A collection of XML rule processors. |
||
|
readonly |
A collection of XML tags. |
|
Name |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
Dispatched after a Document is closed. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched when the Application is quitting. Since the quit has been committed, it can not be canceled. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched before a Document is created. This event bubbles. This event is cancelable. |
||
|
readonly |
Dispatched before a Document is opened. This event bubbles. This event is cancelable. |
||
|
readonly |
Dispatched before the Application is quit. Allows the quit to be canceled. This event bubbles. This event is cancelable. |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined addFontDirectory (fontDirectory:String, obfuscateFlag:Boolean)
[For internal use only] Add Font Directory from specific path.
|
Parameter |
Type |
Description |
|---|---|---|
|
fontDirectory |
Path to the font directory. |
|
|
obfuscateFlag |
Flag to specify. |
Number changeColor ()
Finds color that matches the find what value and replaces the color with the change to value.
Text changeGlyph (reverseOrder:Boolean)
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeGrep (reverseOrder:Boolean)
Finds text that matches the find what value and replaces the text with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
PageItem changeObject (reverseOrder:Boolean)
Finds objects that match the find what value and replace the objects with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeText (reverseOrder:Boolean)
Finds text that matches the find what value and replaces the text with the change to value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeTransliterate (reverseOrder:Boolean)
Finds text that matches the find character type value and replaces the text with the change character type value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
undefined clearAllErrors ()
Clears all errors in the error list.
undefined clearFrameFittingOptions ()
Removes the frame fittings options and resets it to the initial state.
Number colorTransform (colorValue:Array of Number, sourceColorSpace:ColorSpace, destinationColorSpace:ColorSpace)
Transforms color values
|
Parameter |
Type |
Description |
|---|---|---|
|
colorValue |
source color value |
|
|
sourceColorSpace |
source color space |
|
|
destinationColorSpace |
destination color space |
undefined consoleerr (message:String)
Outputs the specified message to std err.
|
Parameter |
Type |
Description |
|---|---|---|
|
message |
The message. |
undefined consoleout (message:String)
Outputs the specified message to std out.
|
Parameter |
Type |
Description |
|---|---|---|
|
message |
The message. |
undefined createCustomMiniFolio (miniFolioDescription:Array of Varies File LongInteger LongLongInteger Orderedarraycontainingkey:String String Value:Boolean Any Types., destination:File)
Create a mini-folio out of asset and overlay descriptions. Schema for the mini folio description: || Key || Type || Required? || Description || | contentstackid | string | yes | The explicit ID to be used for this stack | | tocImage | file | no | The TOC image for the mini-folio | | narrowdimension | int | no | Targetted export size, measured along narrow dimension | | widedimension | int | no | Targetted export size, measured along wide dimension | | smoothscrolling | @enum(SmoothScrollingOptions) | no | The smooth scrolling behavior for this stack (default is noSmoothScroll) | | locationforgeneratedassets | file | no | If included, this is an existing directory where the generated assets should be created. | | overlays | array | no | see the SDK Overlay Builder APIs | | assets | array | yes | The assets for the mini - folio, described below. | | assetDependencies | array | no | Files that are needed by the asset, that will be included in the package but not the manifest. | | metadata | array | no | The metadata for the mini-folio described below. | | showprogressbar | boolean | no | Either true or false to indicate whether we should show a progress bar (default is false) | | targetviewerversion | string | no | If provided (in the form "major.minor.revision") a folio compatible with the viewer version is produced. If omitted, the latest folio format is produced. | CS5 | The following are fields in the array for "assets": || Key || Type || Required? || Description || | file | file | yes | The asset file | | type | string | yes | The asset file type, either "web" for HTML or "image" for a raster | | width | int | yes | The asset width | | height | int | yes | The asset height | | orientation | string | yes | The asset orientation, either "portrait" or "landscape" | | thumbnail | file | no | A thumbnail of the asset to be used in browse mode | | scrubber | file | no | A thumbnail of the asset to be used in scrubber mode | The following are fields in the array for "assetDependencies": || Key || Type || Required? || Description || | file | file | no | The dependent file | | relativePath | string | no | The relative path to the file, for use in the package | The following are fields in the array for "metadata": || Key || Type || Required? || Description || | any string | string or boolean | no | any key/value where the key is a string, and the value is either a string or a boolean, such as those described in "export folio meta data" |
|
Parameter |
Type |
Description |
|---|---|---|
|
miniFolioDescription |
Array of LongInteger Array of LongLongInteger Array of Orderedarraycontainingkey:String Array of Value:Boolean Array of Any Types. |
A dictionary describing the custom mini folio to create. Can accept: Ordered array containing key:String, value:Boolean, Long Integer, Long Long Integer, String, File or Array of Any Types. |
|
destination |
The location to write the file. |
undefined deleteFindChangeQuery (queryName:String, searchMode:SearchModes)
Deletes the specified find/change query.
|
Parameter |
Type |
Description |
|---|---|---|
|
queryName |
The query to delete. |
|
|
searchMode |
The search mode. |
undefined deleteUnusedTags ()
Deletes unused XML markup tags.
Varies doScript (script:Varies File String JavaScriptFunction, [language:ScriptLanguage=ScriptLanguage], withArguments:Array of Varies, [undoMode:UndoModes=UndoModes], [undoName:String=String])
Executes the script in the specified language as a single transaction.
|
Parameter |
Type |
Description |
|---|---|---|
|
script |
JavaScriptFunction |
The script to execute. Can accept: File, String or JavaScript Function. |
|
language |
The language of the script to execute. If not specified, uses the language used to call this method. (Optional) (default: ScriptLanguage.UNKNOWN) |
|
|
withArguments |
Array of Varies |
An array of arguments passed to the script. (Optional) |
|
undoMode |
How to undo this script. (Optional) (default: UndoModes.SCRIPT_REQUEST) |
|
|
undoName |
The name of the undo step for entire script undo mode. (Optional) (default: Script) |
undefined dumpBetweenMemoryMarks (from:Array of Number, to:Array of Number)
Dumps memory allocations from all marks in the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The first mark in the range. |
|
|
to |
The last mark in the range. |
undefined dumpFromMemoryMark (from:Array of Number)
Dumps memory allocations from the specified mark.
String exportArticleFolio (destination:File, portraitDocument:Document, landscapeDocument:Document, folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, miniFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)
Export the specified documents to an article folio. Note: This method behaves identically to @method(exportMiniFolio), but differs in its return value. @method(exportMiniFolio) returns an array of warning strings whereas this method returns an XML structure.
|
Parameter |
Type |
Description |
|---|---|---|
|
destination |
The location to write the file. |
|
|
portraitDocument |
The InDesign document for the stack's portrait orientation. |
|
|
landscapeDocument |
The InDesign document for the stack's landscape orientation. |
|
|
folioMetadata |
Array of Orderedarraycontainingkey:String Array of Value:String |
Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional) |
|
miniFolioParams |
Array of OrderedarraycontainingdataField:String Array of DataValue:VariesType |
Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) |
String exportDpsArticle (destination:File, document:Document, dpsArticleParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)
Export the specified document to a DPS article. Note: This method behaves similarly to @method(exportMiniFolio), but differs in its parameters.
|
Parameter |
Type |
Description |
|---|---|---|
|
destination |
The location to write the file. |
|
|
document |
The source InDesign document. |
|
|
dpsArticleParams |
Array of OrderedarraycontainingdataField:String Array of DataValue:VariesType |
Options for exporting a DPS article. Can accept: Ordered array containing dataField:String, dataValue:Any Type. |
undefined exportFolioToDirectory (destination:File, miniFolioList:Array of Varies File Files., folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, exportFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)
Export the selected documents to a directory.
|
Parameter |
Type |
Description |
|---|---|---|
|
destination |
The directory to write the folio. |
|
|
miniFolioList |
Array of Files. |
The mini folio(es) to add to the folio. Can accept: File or Array of Files. |
|
folioMetadata |
Array of Orderedarraycontainingkey:String Array of Value:String |
Meta data for the folio. Can accept: Ordered array containing key:String, value:String. |
|
exportFolioParams |
Array of OrderedarraycontainingdataField:String Array of DataValue:VariesType |
Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) |
undefined exportFolioToDirectoryPackage (destination:File, miniFolioList:Array of Varies File Files., folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, exportFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)
Export the selected documents to a compressed folio file that contains non-compressed mini folios.
|
Parameter |
Type |
Description |
|---|---|---|
|
destination |
The location to write the package. |
|
|
miniFolioList |
Array of Files. |
The mini folio(es) to add to the folio. Can accept: File or Array of Files. |
|
folioMetadata |
Array of Orderedarraycontainingkey:String Array of Value:String |
Meta data for the folio. Can accept: Ordered array containing key:String, value:String. |
|
exportFolioParams |
Array of OrderedarraycontainingdataField:String Array of DataValue:VariesType |
Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) |
undefined exportFolioToPackage (destination:File, miniFolioList:Array of Varies File Files., folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, exportFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)
Export the selected documents to a compressed folio file that contains compressed mini folios.
|
Parameter |
Type |
Description |
|---|---|---|
|
destination |
The location to write the package. |
|
|
miniFolioList |
Array of Files. |
The mini folio(es) to add to the folio. Can accept: File or Array of Files. |
|
folioMetadata |
Array of Orderedarraycontainingkey:String Array of Value:String |
Meta data for the folio. Can accept: Ordered array containing key:String, value:String. |
|
exportFolioParams |
Array of OrderedarraycontainingdataField:String Array of DataValue:VariesType |
Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) |
String exportMiniFolio (destination:File, portraitDocument:Document, landscapeDocument:Document, folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, miniFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)
Export the specified documents to a mini-folio.
|
Parameter |
Type |
Description |
|---|---|---|
|
destination |
The location to write the file. |
|
|
portraitDocument |
The InDesign document for the stack's portrait orientation. |
|
|
landscapeDocument |
The InDesign document for the stack's landscape orientation. |
|
|
folioMetadata |
Array of Orderedarraycontainingkey:String Array of Value:String |
Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional) |
|
miniFolioParams |
Array of OrderedarraycontainingdataField:String Array of DataValue:VariesType |
Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) |
undefined exportPresets (format:ExportPresetFormat, to:File, versionComments:String, [forceSave:Boolean=Boolean])
Export the presets to a file.
|
Parameter |
Type |
Description |
|---|---|---|
|
format |
The preset format. |
|
|
to |
The file to export to. |
|
|
versionComments |
The comments for this version. (Optional) |
|
|
forceSave |
Forcibly save a version. (Optional) (default: false) |
undefined exportSettings (fileReference:String)
export the customised settings
|
Parameter |
Type |
Description |
|---|---|---|
|
fileReference |
The reference to asset |
undefined exportStrokeStyles (to:File, strokeStyleList:Array of StrokeStyle, versionComments:String, [forceSave:Boolean=Boolean])
Exports stroke styles or presets.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The file to save to |
|
|
strokeStyleList |
Array of StrokeStyle |
The list of stroke styles to save |
|
versionComments |
The comment for this version (Optional) |
|
|
forceSave |
Forcibly save a version (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
Number findColor ()
Finds color that matches the find what value.
Text findGlyph (reverseOrder:Boolean)
Finds glyphs that match the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findGrep (reverseOrder:Boolean)
Finds text that matches the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
String findKeyStrings (for:String)
Returns the locale-independent string(s) from the internal string localization database that correspond to the specified string (in the current locale).
|
Parameter |
Type |
Description |
|---|---|---|
|
for |
The string to search for. |
PageItem findObject (reverseOrder:Boolean)
Finds objects that match the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findText (reverseOrder:Boolean)
Finds text that matches the find what value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findTransliterate (reverseOrder:Boolean)
Finds text that matches the find character type value.
|
Parameter |
Type |
Description |
|---|---|---|
|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
undefined generateIDMLSchema (to:File, packageFormat:Boolean)
Generate schema for IDML.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The folder path of the schema. |
|
|
packageFormat |
If true, generate schema for package format (multiple files). Default value is false. (Optional) |
Varies getAllOverlays (portraitDocumentForCheckingOverlays:Document, landscapeDocumentForCheckingOverlays:Document, miniFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)
Get all overlays.
|
Parameter |
Type |
Description |
|---|---|---|
|
portraitDocumentForCheckingOverlays |
The portrait document for checking overlays. |
|
|
landscapeDocumentForCheckingOverlays |
The landscape document for checking overlays. |
|
|
miniFolioParams |
Array of OrderedarraycontainingdataField:String Array of DataValue:VariesType |
Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) |
String getContextMathMLDescription ()
Internal Use Only.
String getDigpubArticleVersion (digpubArticleVersion:DigpubArticleVersion)
Get the current digital publishing article version number for the given parameter.
|
Parameter |
Type |
Description |
|---|---|---|
|
digpubArticleVersion |
Version string(s) to retrieve. |
String getDigpubVersion (digpubVersion:DigpubVersion)
Get the current digital publishing version number for the given parameter.
|
Parameter |
Type |
Description |
|---|---|---|
|
digpubVersion |
Version string(s) to retrieve. |
Application getElements ()
Resolves the object specifier, creating an array of object references.
String getPathToExportMml2svg ()
Internal Use Only.
String getSupportedArticleViewerVersions ()
Get the list of article viewer versions the digital publishing plugin supports.
String getSupportedViewerVersions ()
Get the list of viewer versions the digital publishing plugin supports.
Number getUntitledCount ()
Gets the count which will be used in the name of the next untitled document.
undefined handleMathMLMessage (resyncData:String)
Internal Use Only
|
Parameter |
Type |
Description |
|---|---|---|
|
resyncData |
Internal Use Only |
Color importAdobeSwatchbookProcessColor (name:String)
Imports a process color swatch from a preloaded Adobe color book.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The process color to load. |
Color importAdobeSwatchbookSpotColor (name:String)
Imports a spot color swatch from an Adobe color book.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The spot color to load. |
undefined importFile (format:ExportPresetFormat, from:File)
Imports presets from the specified file.
|
Parameter |
Type |
Description |
|---|---|---|
|
format |
The type of preset to import. |
|
|
from |
The file to import presets from. |
undefined importSettings (fileReference:String)
import the customised settings
|
Parameter |
Type |
Description |
|---|---|---|
|
fileReference |
The reference to asset |
undefined importStyles (format:ImportFormat, from:File, [globalStrategy:GlobalClashResolutionStrategy=GlobalClashResolutionStrategy])
Imports the specified styles.
|
Parameter |
Type |
Description |
|---|---|---|
|
format |
The types of styles to import. |
|
|
from |
The file containing the styles you want to import. |
|
|
globalStrategy |
The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) (default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE) |
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
String internalMethod (internalParameter1:String, internalParameter2:String)
Internal use only: a black box method for use by InDesign Engineering team only.
|
Parameter |
Type |
Description |
|---|---|---|
|
internalParameter1 |
The first internal parameter |
|
|
internalParameter2 |
The second internal parameter |
undefined loadConditions (from:File, loadConditionSets:Boolean)
Load conditions from the specified file.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The path to the file that contains the conditions. |
|
|
loadConditionSets |
If true, load the condition sets as well. (Optional) |
undefined loadFindChangeQuery (queryName:String, searchMode:SearchModes)
Loads the specified find/change query.
|
Parameter |
Type |
Description |
|---|---|---|
|
queryName |
The query to load. |
|
|
searchMode |
The search mode. |
MotionPreset loadMotionPreset (from:File)
Load motion preset from the specified file.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The Flash motion preset file. |
PreflightProfile loadPreflightProfile (from:File)
Load preflight profile from the specified file.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The InDesign preflight profile file or InDesign document. |
undefined loadSwatches (from:File)
Load swatches from the specified file.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The swatch file or InDesign document. |
undefined loadXMLTags (from:File)
Loads a set of XML markup tags from the specified file.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The path to the file that contains the tags. |
Varies memoryStatistics ()
Gets the memory statistics from the server.
undefined mountProject (serverURL:String, projectName:String)
Mount a Version Cue project.
|
Parameter |
Type |
Description |
|---|---|---|
|
serverURL |
The URL of the Version Cue server containing the project |
|
|
projectName |
The name of the Version Cue project to mount |
Varies open (from:Array of Varies File Files., [openOption:OpenOptions=OpenOptions])
Opens the specified document, book, or library.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Array of Files. |
The file path(s) to the document, book, or library. Can accept: File or Array of Files. |
|
openOption |
How to open the document. (Optional) (default: OpenOptions.DEFAULT_VALUE) |
undefined packageUCF (sourceFolder:File, ucfFile:File, [mimeMediaType:String=String])
Package a folder into a UCF file.
|
Parameter |
Type |
Description |
|---|---|---|
|
sourceFolder |
The folder to be packaged into an IDML file. Does not validate structure of the folder pursuant to the IDML spec. Caller is responsible for making sure the files in the folder are correctly organized. |
|
|
ucfFile |
The destination UCF file. Will be overwritten if it already exists. |
|
|
mimeMediaType |
The MIME media type, default value identifies package as IDML. (Optional) (default: application/vnd.adobe.indesign-idml-package) |
Varies performanceMetric (for:Varies LongInteger PerformanceMetricOptions)
Gets the current value of the specified performance metric.
|
Parameter |
Type |
Description |
|---|---|---|
|
for |
LongInteger |
The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. |
String performanceMetricLongName (for:Varies LongInteger PerformanceMetricOptions)
Gets the long name of the specified performance metric.
|
Parameter |
Type |
Description |
|---|---|---|
|
for |
LongInteger |
The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. |
String performanceMetricShortName (for:Varies LongInteger PerformanceMetricOptions)
Gets the short name of the specified performance metric.
|
Parameter |
Type |
Description |
|---|---|---|
|
for |
LongInteger |
The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. |
undefined print (from:Array of Varies File Files., using:Varies PrinterPresetTypes PrinterPreset, [withGrids:Boolean=Boolean])
Prints the specified file(s).
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Array of Files. |
One or more file paths. Can accept: File or Array of Files. |
|
using |
Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) |
|
|
withGrids |
Whether to print grids (Optional) (default: false) |
undefined quit ([saving:SaveOptions=SaveOptions])
Quits the application.
|
Parameter |
Type |
Description |
|---|---|---|
|
saving |
The option to use for saving changes to open documents before quitting. (Optional) (default: SaveOptions.NO) |
undefined recover (from:File, to:File, recoveryparams:String)
Internal use only: Recovers the specified document.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The file path(s) to the document. |
|
|
to |
The path to the export file. |
|
|
recoveryparams |
recovery parameters (Optional) |
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined removeFontDirectory (fontDirectory:String)
[For internal use only] Remove Font Directory for specific path.
|
Parameter |
Type |
Description |
|---|---|---|
|
fontDirectory |
Path to the font directory. |
undefined resetPreference ()
reset to default preferences
undefined saveFindChangeQuery (queryName:String, searchMode:SearchModes)
Saves the specified find/change query.
|
Parameter |
Type |
Description |
|---|---|---|
|
queryName |
The query to save. |
|
|
searchMode |
The search mode. |
undefined saveSwatches (to:File, swatchList:Array of Swatch, versionComments:String, [forceSave:Boolean=Boolean])
Saves the specified swatch(es) to a swatchbook file.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The swatchbook file to save to. |
|
|
swatchList |
The swatch(es) to save. |
|
|
versionComments |
The comment for this version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
undefined saveXMLTags (to:File, versionComments:String, [forceSave:Boolean=Boolean])
Saves a set of tags to an external file.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The full path to the file in which to save the tags. |
|
|
versionComments |
The comment for this version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
undefined serverTest (testName:String)
Executes a server test.
|
Parameter |
Type |
Description |
|---|---|---|
|
testName |
The test to execute. |
undefined setApplicationPreferences (applicationPreferences:Varies File LanguageAndRegion)
Sets the application's preferences.
|
Parameter |
Type |
Description |
|---|---|---|
|
applicationPreferences |
The IDML defaults file or enumeration. Can accept: File or LanguageAndRegion enumerator. |
undefined setUntitledCount (untitledCount:Number)
Sets the count which will be used in the name of the next untitled document.
|
Parameter |
Type |
Description |
|---|---|---|
|
untitledCount |
The count to be used in the name of the next untitled document. Only positive values are expected |
String toSource ()
Generates a string which, if executed, will return the Application.
String toSpecifier ()
Retrieves the object specifier.
String translateKeyString (for:String)
Translates a key string into localized form based on current application locale.
|
Parameter |
Type |
Description |
|---|---|---|
|
for |
The key string to translate |
undefined unpackageUCF (ucfFile:File, destinationFolder:File)
Unpackage a UCF file into a folder structure.
|
Parameter |
Type |
Description |
|---|---|---|
|
ucfFile |
The UCF file to be unpackaged. |
|
|
destinationFolder |
The folder where you would like the UCF file unpackaged to. Will be created if it does not exist. |
undefined updateFonts ()
Forces a check for new fonts in the various Fonts folders.
global.app
AlignDistributePreference.parent
AnchoredObjectDefault.parent
AnchoredObjectSetting.parent
Application.parent
AutoCorrectPreference.parent
AutoCorrectTable.parent
BaselineFrameGridOption.parent
Book.parent
ButtonPreference.parent
CellStyle.parent
CellStyleGroup.parent
CellStyleMapping.parent
ChangeColorPreference.parent
ChangeGlyphPreference.parent
ChangeGrepPreference.parent
ChangeObjectPreference.parent
ChangeTextPreference.parent
ChangeTransliteratePreference.parent
CharStyleMapping.parent
CharacterStyle.parent
CharacterStyleGroup.parent
CjkGridPreference.parent
ClipboardPreference.parent
Color.parent
ColorGroup.parent
ColorSetting.parent
CompositeFont.parent
Condition.parent
ConditionSet.parent
ConditionalTextPreference.parent
ContentPlacerObject.parent
DashedStrokeStyle.parent
DataMergeOption.parent
DictionaryPreference.parent
Document.parent
DocumentEvent.parent
DocumentPreference.parent
DocumentPreset.parent
DottedStrokeStyle.parent
EPSExportPreference.parent
EPSImportPreference.parent
EPubExportPreviewAppPreference.parent
EndnoteOption.parent
ErrorListError.parent
Event.parent
EventListener.parent
ExcelImportPreference.parent
ExportForWebPreference.parent
FindChangeColorOption.parent
FindChangeGlyphOption.parent
FindChangeGrepOption.parent
FindChangeObjectOption.parent
FindChangeTextOption.parent
FindChangeTransliterateOption.parent
FindColorPreference.parent
FindGlyphPreference.parent
FindGrepPreference.parent
FindObjectPreference.parent
FindTextPreference.parent
FindTransliteratePreference.parent
FlattenerPreset.parent
Font.parent
FontLockingPreference.parent
FontSyncPreference.parent
FootnoteOption.parent
FrameFittingOption.parent
GeneralPreference.parent
Gradient.parent
GridPreference.parent
GridPrintingPreference.parent
GuidePreference.parent
HttpLinkConnectionManagerObject.parent
IdleTask.parent
ImageIOPreference.parent
ImagePreference.parent
ImportExportEvent.parent
ImportedPageAttribute.parent
InCopyExportOption.parent
IndexOptions.parent
IndexingSortOption.parent
Ink.parent
InteractivePDFExportPreference.parent
JPEGExportPreference.parent
KinsokuTable.parent
LanguageWithVendors.parent
LayoutGridDataInformation.parent
Library.parent
LinkedPageItemOption.parent
LinkedStoryOption.parent
LinkingPreference.parent
MarginPreference.parent
MixedInk.parent
MixedInkGroup.parent
MojikumiTable.parent
MojikumiUiPreference.parent
MotionPreset.parent
MutationEvent.parent
NamedGrid.parent
NumberingList.parent
ObjectStyle.parent
ObjectStyleGroup.parent
PDFExportPreference.parent
PDFExportPreset.parent
PDFPlacePreference.parent
PNGExportPreference.parent
PageItemDefault.parent
ParaStyleMapping.parent
ParagraphStyle.parent
ParagraphStyleGroup.parent
PasteboardPreference.parent
PolygonPreference.parent
Preference.parent
PreflightBookOption.parent
PreflightOption.parent
PreflightProcess.parent
PreflightProfile.parent
PreflightRule.parent
PrinterPreset.parent
ScriptArg.parent
ScriptPreference.parent
ServerSetting.parent
SpellPreference.parent
StoryGridDataInformation.parent
StoryPreference.parent
StripedStrokeStyle.parent
StrokeStyle.parent
Swatch.parent
TableStyle.parent
TableStyleGroup.parent
TableStyleMapping.parent
TaggedPDFPreference.parent
TaggedTextExportPreference.parent
TaggedTextImportPreference.parent
TextDefault.parent
TextExportPreference.parent
TextFramePreference.parent
TextImportPreference.parent
TextPreference.parent
TextVariable.parent
TextWrapPreference.parent
Tint.parent
TrackChangesPreference.parent
TransformPreference.parent
TransformationMatrix.parent
TransparencyPreference.parent
TrapPreset.parent
UserDictionary.parent
ViewPreference.parent
WatermarkPreference.parent
WordRTFImportPreference.parent
XMLExportMap.parent
XMLExportPreference.parent
XMLImportMap.parent
XMLImportPreference.parent
XMLPreference.parent
XMLRuleProcessor.parent
XMLTag.parent