A document.
Go to Property Listing | Method Listing
addEventListener, align, changeGlyph, changeGrep, changeObject, changeText, checkIn, close, createTOC, deleteUnusedTags, distribute, exportFile, exportStrokeStyles, extractLabel, findGlyph, findGrep, findObject, findText, getElements, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importDtd, importStyles, importXML, insertLabel, loadMasters, loadSwatches, loadXMLTags, mapStylesToXMLTags, mapXMLTagsToStyles, packageForPrint, place, print, printBooklet, recompose, redo, removeEventListener, revert, revertToProject, save, saveSwatches, saveXMLTags, select, synchronizeWithVersionCue, toSource, toSpecifier, undo
AnchoredObjectDefault, AnchoredObjectSetting, Assignments, BaselineFrameGridOption, Bookmarks, Boolean, ButtonPreference, Buttons, CellStyle, CellStyleGroups, CellStyles, ChapterNumberPreference, CharacterStyle, CharacterStyleGroups, CharacterStyles, ColorSettingsPolicy, Colors, DTDs, DashedStrokeStyles, DataMerge, DataMergeImagePlaceholders, DataMergeOption, DataMergeTextPlaceholders, DictionaryPreference, DocumentPreference, DottedStrokeStyles, EditingState, EventListeners, Events, ExportForWebPreference, File, Fonts, FootnoteOption, FormFields, FrameFittingOption, GalleyPreference, Gradients, Graphic, GraphicLines, GridPreference, Groups, GuidePreference, Guides, HyperlinkExternalPageDestinations, HyperlinkPageDestinations, HyperlinkPageItemSources, HyperlinkTextDestinations, HyperlinkTextSources, HyperlinkURLDestinations, Hyperlinks, HyphenationExceptions, IndexOptions, Indexes, IndexingSortOptions, Inks, Languages, Layer, Layers, LayoutAdjustmentPreference, LayoutWindows, Links, MarginPreference, MasterSpreads, MetadataPreference, MixedInkGroups, MixedInks, NothingEnum, Number, NumberingLists, Object, ObjectStyle, ObjectStyleGroups, ObjectStyles, Ovals, PageItem, PageItemDefault, PageItems, Pages, ParagraphStyle, ParagraphStyleGroups, ParagraphStyles, PasteboardPreference, Polygons, PrintBookletOption, PrintBookletPrintPreference, PrintPreference, Rectangles, RenderingIntent, Sections, Spreads, Stories, StoryPreference, StoryWindows, String, StripedStrokeStyles, StrokeStyles, Swatch, Swatches, TOCStyles, TableStyle, TableStyleGroups, TableStyles, TextDefault, TextFramePreference, TextFrames, TextPreference, TextVariables, Tints, TransparencyPreference, TrapPresets, ValidationErrors, VersionState, ViewPreference, Windows, XMLComments, XMLElements, XMLExportMaps, XMLExportPreference, XMLImportMaps, XMLImportPreference, XMLInstructions, XMLItem, XMLItems, XMLPreference, XMLTags, XMLViewPreference, XmlStories
BaselineFrameGridOption, ButtonPreference, ChapterNumberPreference, DataMergeOption, DictionaryPreference, DocumentPreference, ExportForWebPreference, FootnoteOption, FrameFittingOption, GalleyPreference, GridPreference, GuidePreference, HyphenationExceptions, IndexOptions, IndexingSortOptions, LayoutAdjustmentPreference, MarginPreference, MetadataPreference, PasteboardPreference, PrintBookletOption, PrintBookletPrintPreference, PrintPreference, StoryPreference, TextFramePreference, TextPreference, TransparencyPreference, ViewPreference, XMLExportPreference, XMLImportPreference, XMLPreference, XMLViewPreference
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
read/write |
If true, uses LAB alternates for spot colors when available. |
||
|
read/write |
The active layer. Can also accept: String. |
||
|
read/write |
The rendering intent for colors that result from transparency interactions on the page after blending. |
||
|
readonly |
All Cell styles |
||
|
readonly |
Lists all character styles (regardless of their group). |
||
|
readonly |
Lists all graphics contained by the Document. |
||
|
Array of ObjectStyle |
readonly |
All object styles contained by the Document. |
|
|
readonly |
Lists all page items contained by the Document. |
||
|
readonly |
Lists all paragraph styles (regardless of their group). |
||
|
Array of TableStyle |
readonly |
All Table styles |
|
|
readonly |
Anchored object default settings. |
||
|
readonly |
Anchored object settings. |
||
|
readonly |
A collection of assignments. |
||
|
readonly |
The XML element associated with the Document. |
||
|
readonly |
Baseline frame grid option settings. |
||
|
readonly |
A collection of bookmarks. |
||
|
readonly |
Button preference settings. |
||
|
readonly |
A collection of buttons. |
||
|
readonly |
A collection of cell style groups. |
||
|
readonly |
A collection of cell styles. |
||
|
readonly |
Chapter numbering preferences. |
||
|
readonly |
A collection of character style groups. |
||
|
readonly |
A collection of character styles. |
||
|
read/write |
The policy for handling colors in a CMYK color model, including reading and embedding color profiles, mismatches between embedded color profiles and the working space, and moving colors from one document to another. |
||
|
read/write |
The current CMYK profile. |
||
|
readonly |
A list of valid CMYK profiles. |
||
|
readonly |
A collection of colors. |
||
|
readonly |
If true, the Document was converted. |
||
|
readonly |
A collection of dashed stroke styles. |
||
|
readonly |
A collection of data merge image placeholders. |
||
|
readonly |
The data merge option properties that define the data merge. |
||
|
readonly |
Data merge properties that define data merge fields and preferences. |
||
|
readonly |
A collection of data merge text placeholders. |
||
|
read/write |
The rendering intent for bitmap images. |
||
|
readonly |
User dictionary preference settings. |
||
|
readonly |
Document preference settings. |
||
|
readonly |
A collection of dotted stroke styles. |
||
|
readonly |
A collection of DTDs. |
||
|
readonly |
The Version Cue editing state of the file. |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
The default export for web preferences. |
||
|
readonly |
The full path to the file. |
||
|
readonly |
A collection of fonts. |
||
|
readonly |
Footnote option settings. |
||
|
readonly |
A collection of form fields. |
||
|
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 Document, including the name of the Document. |
||
|
readonly |
Galley preference settings. |
||
|
readonly |
A collection of gradients. |
||
|
readonly |
A collection of graphic lines. |
||
|
readonly |
Grid preference settings. |
||
|
readonly |
A collection of groups. |
||
|
readonly |
Guide preference settings. |
||
|
readonly |
A collection of guides. |
||
|
HyperlinkExternalPageDestinations HyperlinkExternalPageDestination |
readonly |
A collection of hyperlink external page destinations. |
|
|
readonly |
A collection of hyperlink page destinations. |
||
|
readonly |
A collection of hyperlink page item sources. |
||
|
readonly |
A collection of hyperlink text destinations. |
||
|
readonly |
A collection of hyperlink text sources. |
||
|
readonly |
A collection of hyperlink URL destinations. |
||
|
readonly |
A collection of hyperlinks. |
||
|
readonly |
A collection of hyphenation exceptions lists. |
||
|
readonly |
The index of the Document within its containing object. |
||
|
readonly |
The index options properties that define how an index is formatted. |
||
|
readonly |
A collection of indexes. |
||
|
readonly |
A collection of indexing sort options. |
||
|
readonly |
A collection of inks. |
||
|
read/write |
A property that can be set to any string. |
||
|
readonly |
A collection of languages. |
||
|
readonly |
A collection of layers. |
||
|
readonly |
Layout sdjustment preference settings. |
||
|
readonly |
A collection of layout windows. |
||
|
readonly |
A collection of links. |
||
|
readonly |
Margin preference settings. |
||
|
readonly |
A collection of master spreads. |
||
|
readonly |
Metadata preference settings. |
||
|
readonly |
A collection of mixed ink groups. |
||
|
readonly |
A collection of mixed inks. |
||
|
readonly |
If true, the Document has been modified since it was last saved. |
||
|
readonly |
The name of the Document. |
||
|
readonly |
A collection of numbered lists. |
||
|
readonly |
A collection of object style groups. |
||
|
readonly |
A collection of object styles. |
||
|
readonly |
A collection of ellipses. |
||
|
readonly |
The default page item formatting for the Document. |
||
|
readonly |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
||
|
readonly |
A collection of pages. |
||
|
readonly |
A collection of paragraph style groups. |
||
|
readonly |
A collection of paragraph styles. |
||
|
readonly |
The parent of the Document (a Application). |
||
|
readonly |
Pasteboard preference settings. |
||
|
readonly |
A collection of polygons. |
||
|
readonly |
Booklet printing options. |
||
|
readonly |
Print booklet preferences. |
||
|
readonly |
Print preference settings. |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
If true, the Document is read-only. |
||
|
readonly |
If true, the Document was recovered. |
||
|
readonly |
A collection of rectangles. |
||
|
readonly |
The names of the items in the redo stack. |
||
|
readonly |
The name of the action on the top of the redo stack. |
||
|
read/write |
The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another. |
||
|
read/write |
The current RGB profile. |
||
|
readonly |
A list of valid RGB profiles. |
||
|
readonly |
If true, the Document has been saved since it was created. |
||
|
readonly |
A collection of sections. |
||
|
read/write |
The selected object(s). Can also accept: Object or NothingEnum enumerator. |
||
|
read/write |
The rendering intent for all vector art (areas of solid color) in native objects. |
||
|
readonly |
A collection of spreads. |
||
|
readonly |
A collection of stories. |
||
|
readonly |
Story preference settings. |
||
|
readonly |
A collection of story windows. |
||
|
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 styles. |
||
|
readonly |
Text default settings. |
||
|
readonly |
Text frame preference settings. |
||
|
readonly |
A collection of text frames. |
||
|
readonly |
Text preference settings. |
||
|
readonly |
A collection of text variables. |
||
|
readonly |
A collection of tints. |
||
|
readonly |
A collection of TOC styles. |
||
|
readonly |
Transparency preference settings. |
||
|
readonly |
A collection of trap presets. |
||
|
readonly |
The names of the items in the undo stack. |
||
|
readonly |
The name of the action on the top of the undo stack. |
||
|
readonly |
The swatches that are not being used. |
||
|
readonly |
A collection of XML validation errors. |
||
|
readonly |
The Version Cue version state of the file. |
||
|
readonly |
View preference settings. |
||
|
readonly |
If true, the Document is visible. |
||
|
readonly |
A collection of windows. |
||
|
readonly |
A collection of XML comments. |
||
|
readonly |
A collection of XML elements. |
||
|
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 |
A collection of XML instructions. |
||
|
readonly |
A collection of XML items. |
||
|
readonly |
The XML preference settings. |
||
|
readonly |
A collection of xml stories. |
||
|
readonly |
A collection of XML tags. |
||
|
readonly |
XML view preference settings. |
||
|
read/write |
The ruler origin, specified as page coordinates in the format [x, y]. |
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 align (alignDistributeItems:Array of PageItem, alignOption:AlignOptions, alignDistributeBounds:AlignDistributeBounds)
Align page items.
|
Parameter |
Type |
Description |
|---|---|---|
|
alignDistributeItems |
The page items to align or distribute. |
|
|
alignOption |
The type of alignment to apply. |
|
|
alignDistributeBounds |
The bounds within which to align or distribute the page items. (Optional) |
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) |
undefined checkIn (versionComments:String, [forceSave:Boolean=Boolean])
Check in to Version Cue.
|
Parameter |
Type |
Description |
|---|---|---|
|
versionComments |
The comment for this version (Optional) |
|
|
forceSave |
Forcibly save a version (Optional) (default: false) |
undefined close ([saving:SaveOptions=SaveOptions], savingIn:File, versionComments:String, [forceSave:Boolean=Boolean])
Close the Document
|
Parameter |
Type |
Description |
|---|---|---|
|
saving |
Whether to save changes before closing the Document (Optional) (default: SaveOptions.ASK) |
|
|
savingIn |
The file in which to save the Document (Optional) |
|
|
versionComments |
The comment for this version (Optional) |
|
|
forceSave |
Forcibly save a version (Optional) (default: false) |
Story createTOC (using:TOCStyle, [replacing:Boolean=Boolean], fromBook:Book, placePoint:Array of Number String, [includeOverset:Boolean=Boolean], destinationLayer:Layer)
Creates a table of contents.
|
Parameter |
Type |
Description |
|---|---|---|
|
using |
The TOC style to use to define the content, title, and format of the table of contents. |
|
|
replacing |
If true, replaces the existing TOC. (Optional) (default: false) |
|
|
fromBook |
The book whose documents to include in the TOC. (Optional) |
|
|
placePoint |
The point at which to place the TOC story, specified as page coordinates in the format [x, y]. (Optional) |
|
|
includeOverset |
If true, includes overset text TOC entries in the TOC. (Optional) (default: false) |
|
|
destinationLayer |
The layer on which to place the TOC. (Optional) |
undefined deleteUnusedTags ()
Deletes unused XML markup tags.
undefined distribute (alignDistributeItems:Array of PageItem, distributeOption:DistributeOptions, alignDistributeBounds:AlignDistributeBounds, useDistributeMeasurement:Boolean, absoluteDistributeMeasurement:Number String)
Distribute page items.
|
Parameter |
Type |
Description |
|---|---|---|
|
alignDistributeItems |
The page items to align or distribute |
|
|
distributeOption |
The type of distribution to apply. |
|
|
alignDistributeBounds |
The bounds within which to align or distribute the page items. (Optional) |
|
|
useDistributeMeasurement |
If true, distribute space between page items. When this property is true, the bounds setting is ignored. (Optional) |
|
|
absoluteDistributeMeasurement |
The distance to use when distributing page items. (Optional) |
undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])
Exports the object(s) to a file.
|
Parameter |
Type |
Description |
|---|---|---|
|
format |
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. |
|
|
to |
The path to the export file. |
|
|
showingOptions |
If true, displays the export options dialog. (Optional) (default: false) |
|
|
using |
The export style. (Optional) |
|
|
versionComments |
The comment for this version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
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. |
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) |
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) |
Document 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 |
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 importDtd (from:File)
Imports a DTD to use for validation.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The path to the DTD file. |
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 importXML (from:File)
Imports the specified XML file into an InDesign document.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The XML file. |
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined loadMasters (from:File, [globalStrategyForMasterPage:GlobalClashResolutionStrategyForMasterPage=GlobalClashResolutionStrategyForMasterPage])
Load masterpages from an InDesign file.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
The InDesign file to load the masters from. |
|
|
globalStrategyForMasterPage |
the global clash resolution strategy for load master page (Optional) (default: GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE) |
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. |
undefined mapStylesToXMLTags ()
Auto tag the document based on the style to tag mappings
undefined mapXMLTagsToStyles ()
Auto style the document based on the tag to style mappings
Boolean packageForPrint (to:File, copyingFonts:Boolean, copyingLinkedGraphics:Boolean, copyingProfiles:Boolean, updatingGraphics:Boolean, ignorePreflightErrors:Boolean, creatingReport:Boolean, versionComments:String, [forceSave:Boolean=Boolean])
Packages the document.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The folder, alias, or path in which to place the packaged files. |
|
|
copyingFonts |
If true, copies fonts used in the document to the package folder. |
|
|
copyingLinkedGraphics |
If true, copies linked graphics files to the package folder. |
|
|
copyingProfiles |
If true, copies color profiles to the package folder. |
|
|
updatingGraphics |
If true, updates graphics links to the package folder. |
|
|
ignorePreflightErrors |
If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist. |
|
|
creatingReport |
If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information. |
|
|
versionComments |
The comments for the version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
undefined place (fileName:Array of Varies File Files., [showingOptions:Boolean=Boolean], withProperties:Object)
Place one or more files following the behavior of the place menu item. This may load the place gun or replace the selected object, depending on current preferences.
|
Parameter |
Type |
Description |
|---|---|---|
|
fileName |
Array of Files. |
One or more files to place. Can accept: File or Array of Files. |
|
showingOptions |
Whether to display the import options dialog (Optional) (default: false) |
|
|
withProperties |
Initial values for properties of the placed object(s) (Optional) |
undefined print (printDialog:Boolean, using:Varies PrinterPresetTypes PrinterPreset)
Prints the Document(s).
|
Parameter |
Type |
Description |
|---|---|---|
|
printDialog |
Whether to invoke the print dialog (Optional) |
|
|
using |
Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) |
undefined printBooklet ([printBookletDialog:Boolean=Boolean], using:Varies PrinterPresetTypes PrinterPreset)
Print the Booklet using current document and Booklet and Print settings in the document
|
Parameter |
Type |
Description |
|---|---|---|
|
printBookletDialog |
Whether to invoke the print booklet dialog (Optional) (default: false) |
|
|
using |
Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) |
undefined recompose ()
Recomposes the text in the Document.
undefined redo ()
Redoes the last action.
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) |
Boolean revert ()
Reverts the document to its state at the last save operation.
undefined revertToProject ([forceRevert:Boolean=Boolean])
Reverts to the version of the document in Version Cue.
|
Parameter |
Type |
Description |
|---|---|---|
|
forceRevert |
Forcibly reverts to the project version. (Optional) (default: false) |
Document save (to:File, [stationery:Boolean=Boolean], versionComments:String, [forceSave:Boolean=Boolean])
Save the document
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
Where to save the document. If the document is already saved, a copy is saved at this path, the original file is closed the new copy is opened (Optional) |
|
|
stationery |
Whether to save the file as stationery (Optional) (default: false) |
|
|
versionComments |
The comment for this version (Optional) |
|
|
forceSave |
Forcibly save a version (Optional) (default: false) |
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 select (selectableItems:Array of Varies Objects NothingEnum Object SelectAll, [existingSelection:SelectionOptions=SelectionOptions])
Selects the specified object(s).
|
Parameter |
Type |
Description |
|---|---|---|
|
selectableItems |
Array of Objects |
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. |
|
existingSelection |
The selection status of the Document in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
VersionCueSyncStatus synchronizeWithVersionCue ([syncConflictResolution:SyncConflictResolution=SyncConflictResolution], versionComments:String)
Synchronizes the file with the Version Cue project.
|
Parameter |
Type |
Description |
|---|---|---|
|
syncConflictResolution |
The conflict resolution method to use during synchronization. (Optional) (default: SyncConflictResolution.SKIP_CONFLICTS) |
|
|
versionComments |
The comments that describe the version. (Optional) |
String toSource ()
Generates a string which, if executed, will return the Document.
String toSpecifier ()
Retrieves the object specifier.
undefined undo ()
Undoes the last action.
Book.styleSourceDocument
Application.activeDocument
AnchoredObjectDefault.parent
AnchoredObjectSetting.parent
Assignment.parent
BaselineFrameGridOption.parent
Bookmark.parent
Button.parent
ButtonPreference.parent
CellStyle.parent
CellStyleGroup.parent
ChapterNumberPreference.parent
CharacterStyle.parent
CharacterStyleGroup.parent
Color.parent
DTD.parent
DashedStrokeStyle.parent
DataMerge.parent
DataMergeImagePlaceholder.parent
DataMergeOption.parent
DataMergeTextPlaceholder.parent
DictionaryPreference.parent
DocumentEvent.parent
DocumentPreference.parent
DottedStrokeStyle.parent
Event.parent
EventListener.parent
ExportForWebPreference.parent
Font.parent
FootnoteOption.parent
FormField.parent
FrameFittingOption.parent
GalleyPreference.parent
Gradient.parent
GraphicLine.parent
GridPreference.parent
Group.parent
Guide.parent
GuidePreference.parent
Hyperlink.parent
HyperlinkExternalPageDestination.parent
HyperlinkPageDestination.parent
HyperlinkPageItemSource.parent
HyperlinkTextDestination.parent
HyperlinkTextSource.parent
HyperlinkURLDestination.parent
HyphenationException.parent
ImportExportEvent.parent
Index.parent
IndexOptions.parent
IndexingSortOption.parent
Ink.parent
Language.parent
Layer.parent
LayoutAdjustmentPreference.parent
LayoutWindow.parent
MarginPreference.parent
MasterSpread.parent
MetadataPreference.parent
MixedInk.parent
MixedInkGroup.parent
NumberingList.parent
ObjectStyle.parent
ObjectStyleGroup.parent
Oval.parent
Page.parent
PageItem.parent
PageItemDefault.parent
ParagraphStyle.parent
ParagraphStyleGroup.parent
PasteboardPreference.parent
Polygon.parent
PrintBookletOption.parent
PrintBookletPrintPreference.parent
PrintEvent.parent
PrintPreference.parent
Rectangle.parent
Section.parent
Spread.parent
Story.parent
StoryPreference.parent
StoryWindow.parent
StripedStrokeStyle.parent
StrokeStyle.parent
Swatch.parent
TOCStyle.parent
TableStyle.parent
TableStyleGroup.parent
TextDefault.parent
TextFrame.parent
TextFramePreference.parent
TextPreference.parent
TextVariable.parent
TextWrapPreference.parent
Tint.parent
TransparencyPreference.parent
TrapPreset.parent
ValidationError.parent
ViewPreference.parent
Window.parent
XMLComment.parent
XMLElement.parent
XMLExportMap.parent
XMLExportPreference.parent
XMLImportMap.parent
XMLImportPreference.parent
XMLInstruction.parent
XMLItem.parent
XMLPreference.parent
XMLTag.parent
XMLViewPreference.parent
XmlStory.parent