Adobe InCopy CS5 (7.0) Object Model JS: Document

InCopy CS5

Class

Document

 A document.

QuickLinks

addEventListener, changeComposer, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, checkIn, close, deleteUnusedTags, exportFile, extractLabel, findGlyph, findGrep, findObject, findText, findTransliterate, getElements, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importDtd, importFormats, importStyles, importXML, insertLabel, loadConditions, loadMasters, loadSwatches, loadXMLTags, mapStylesToXMLTags, mapXMLTagsToStyles, print, recompose, redo, removeEventListener, revert, revertToProject, save, saveACopy, saveSwatches, saveXMLTags, select, synchronizeWithVersionCue, toSource, toSpecifier, undo, updateCrossReferences

Hierarchy

Application
Document
AnchoredObjectDefault | AnchoredObjectSetting | Assignment | BaselineFrameGridOption | CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Color | Condition | ConditionSet | ConditionalTextPreference | CrossReferenceFormat | CrossReferenceSource | DTD | DictionaryPreference | DocumentEvent | DocumentPreference | Event | EventListener | ExportForWebPreference | Font | FootnoteOption | FrameFittingOption | GalleyPreference | Gradient | GridPreference | GuidePreference | Hyperlink | HyperlinkExternalPageDestination | HyperlinkPageItemSource | HyperlinkTextDestination | HyperlinkTextSource | HyperlinkURLDestination | HyphenationException | ImportExportEvent | IndexingSortOption | Ink | KinsokuTable | Language | Layer | MarginPreference | MasterSpread | MetadataPreference | MixedInk | MixedInkGroup | MojikumiTable | MojikumiUiPreference | MutationEvent | NumberingList | PageItemDefault | ParagraphDestination | ParagraphStyle | ParagraphStyleGroup | PasteboardPreference | PlaceGun | Preference | PrintEvent | Section | Spread | Story | StoryPreference | StrokeStyle | Swatch | TableStyle | TableStyleGroup | TextDefault | TextFramePreference | TextPreference | TextVariable | TextWrapPreference | Tint | TrapPreset | ValidationError | ViewPreference | Window | XMLComment | XMLElement | XMLExportMap | XMLExportPreference | XMLImportMap | XMLImportPreference | XMLInstruction | XMLItem | XMLPreference | XMLTag | XMLViewPreference | XmlStory

Properties

PropertyTypeAccessDescription
allCellStyles Array of CellStyle readonlyAll Cell styles
allCharacterStyles Array of CharacterStyle readonlyLists all character styles (regardless of their group).
allGraphics Array of Graphic readonlyLists all graphics contained by the Document.
allPageItems Array of PageItem readonlyLists all page items contained by the Document.
allParagraphStyles Array of ParagraphStyle readonlyLists all paragraph styles (regardless of their group).
allTableStyles Array of TableStyle readonlyAll Table styles
anchoredObjectDefaultsAnchoredObjectDefault readonlyAnchored object default settings.
anchoredObjectSettingsAnchoredObjectSetting readonlyAnchored object settings.
assignmentsAssignments readonlyA collection of assignments.
associatedXMLElementXMLItem readonlyThe XML element associated with the Document.
baselineFrameGridOptionsBaselineFrameGridOption readonlyBaseline frame grid option settings.
buttonsButtons readonlyA collection of buttons.
cellStyleGroupsCellStyleGroups readonlyA collection of cell style groups.
cellStylesCellStyles readonlyA collection of cell styles.
characterStyleGroupsCharacterStyleGroups readonlyA collection of character style groups.
characterStylesCharacterStyles readonlyA collection of character styles.
colorsColors readonlyA collection of colors.
conditionSetsConditionSets readonlyA collection of condition sets for conditional text.
conditionalTextPreferencesConditionalTextPreference readonlyConditional text preferences.
conditionsConditions readonlyA collection of conditions for conditional text.
convertedbool readonlyIf true, the Document was converted.
crossReferenceFormatsCrossReferenceFormats readonlyA collection of cross reference formats.
crossReferenceSourcesCrossReferenceSources readonlyA collection of cross reference text sources.
dictionaryPreferencesDictionaryPreference readonlyUser dictionary preference settings.
documentPreferencesDocumentPreference readonlyDocument preference settings.
dtdsDTDs readonlyA collection of DTDs.
editingStateEditingState:
EditingState.EDITING_UNKNOWN
EditingState.EDITING_NOWHERE
EditingState.EDITING_REMOTELY
EditingState.EDITING_LOCALLY
EditingState.EDITING_LOCALLY_LOCKED
EditingState.EDITING_CONFLICT
readonlyThe Version Cue editing state of the file.
epstextsEPSTexts readonlyEPSTexts
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
exportForWebPreferencesExportForWebPreference readonlyThe default export for web preferences.
filePathFile readonlyThe full path to the file.
fontsFonts readonlyA collection of fonts.
footnoteOptionsFootnoteOption readonlyFootnote option settings.
formFieldsFormFields readonlyA collection of form fields.
frameFittingOptionsFrameFittingOption readonlyThe frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
fullNameFile readonlyThe full path to the Document, including the name of the Document.
galleyPreferencesGalleyPreference readonlyGalley preference settings.
gradientsGradients readonlyA collection of gradients.
graphicLinesGraphicLines readonlyA collection of graphic lines.
gridPreferencesGridPreference readonlyGrid preference settings.
groupsGroups readonlyA collection of groups.
guidePreferencesGuidePreference readonlyGuide preference settings.
guidesGuides readonlyA collection of guides.
hyperlinkExternalPageDestinationsHyperlinkExternalPageDestinations readonlyA collection of hyperlink external page destinations.
hyperlinkPageItemSourcesHyperlinkPageItemSources readonlyA collection of hyperlink page item sources.
hyperlinkTextDestinationsHyperlinkTextDestinations readonlyA collection of hyperlink text destinations.
hyperlinkTextSourcesHyperlinkTextSources readonlyA collection of hyperlink text sources.
hyperlinkURLDestinationsHyperlinkURLDestinations readonlyA collection of hyperlink URL destinations.
hyperlinksHyperlinks readonlyA collection of hyperlinks.
hyphenationExceptionsHyphenationExceptions readonlyA collection of hyphenation exceptions lists.
idnumber readonlyThe unique ID of the Document.
indexnumber readonlyThe index of the Document within its containing object.
indexingSortOptionsIndexingSortOptions readonlyA collection of indexing sort options.
inksInks readonlyA collection of inks.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
kinsokuTablesKinsokuTables readonlyA collection of kinsoku tables.
labelstring r/wA property that can be set to any string.
languagesLanguages readonlyA collection of languages.
layersLayers readonlyA collection of layers.
linksLinks readonlyA collection of links.
marginPreferencesMarginPreference readonlyMargin preference settings.
masterSpreadsMasterSpreads readonlyA collection of master spreads.
metadataPreferencesMetadataPreference readonlyMetadata preference settings.
mixedInkGroupsMixedInkGroups readonlyA collection of mixed ink groups.
mixedInksMixedInks readonlyA collection of mixed inks.
modifiedbool readonlyIf true, the Document has been modified since it was last saved.
mojikumiTablesMojikumiTables readonlyA collection of mojikumi tables.
mojikumiUIPreferencesMojikumiUiPreference readonlyMojikumi user interface preference settings.
multiStateObjectsMultiStateObjects readonlyA collection of multi-state objects.
namestring readonlyThe name of the Document.
numberingListsNumberingLists readonlyA collection of numbered lists.
ovalsOvals readonlyA collection of ellipses.
pageItemDefaultsPageItemDefault readonlyThe default page item formatting for the Document.
pageItemsPageItems readonlyThe 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.
pagesPages readonlyA collection of pages.
paragraphDestinationsParagraphDestinations readonlyA collection of paragraph destinations.
paragraphStyleGroupsParagraphStyleGroups readonlyA collection of paragraph style groups.
paragraphStylesParagraphStyles readonlyA collection of paragraph styles.
parentApplication readonlyThe parent of the Document (a Application).
pasteboardPreferencesPasteboardPreference readonlyPasteboard preference settings.
placeGunsPlaceGun readonlyThe place gun.
polygonsPolygons readonlyA collection of polygons.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
readOnlybool readonlyIf true, the Document is read-only.
recoveredbool readonlyIf true, the Document was recovered.
rectanglesRectangles readonlyA collection of rectangles.
redoHistory Array of string readonlyThe names of the items in the redo stack.
redoNamestring readonlyThe name of the action on the top of the redo stack.
savedbool readonlyIf true, the Document has been saved since it was created.
sectionsSections readonlyA collection of sections.
selection Array of Object r/wThe selected object(s). Can also accept: Object or NothingEnum enumerator.
splineItemsSplineItems readonlyThe spline items collection.
spreadsSpreads readonlyA collection of spreads.
storiesStories readonlyA collection of stories.
storyPreferencesStoryPreference readonlyStory preference settings.
strokeStylesStrokeStyles readonlyA collection of stroke styles.
swatchesSwatches readonlyA collection of swatches.
tableStyleGroupsTableStyleGroups readonlyA collection of table style groups.
tableStylesTableStyles readonlyA collection of table styles.
textDefaultsTextDefault readonlyText default settings.
textFramePreferencesTextFramePreference readonlyText frame preference settings.
textFramesTextFrames readonlyA collection of text frames.
textPreferencesTextPreference readonlyText preference settings.
textVariablesTextVariables readonlyA collection of text variables.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
tintsTints readonlyA collection of tints.
trapPresetsTrapPresets readonlyA collection of trap presets.
undoHistory Array of string readonlyThe names of the items in the undo stack.
undoNamestring readonlyThe name of the action on the top of the undo stack.
unusedSwatches Array of Swatch readonlyThe swatches that are not being used.
validationErrorsValidationErrors readonlyA collection of XML validation errors.
versionStateVersionState:
VersionState.VERSION_UNKNOWN
VersionState.PROJECT_FILE_NEWER
VersionState.LOCAL_PROJECT_MATCH
VersionState.LOCAL_NEWER
VersionState.VERSION_CONFLICT
VersionState.NO_RESOURCE
readonlyThe Version Cue version state of the file.
viewPreferencesViewPreference readonlyView preference settings.
visiblebool readonlyIf true, the Document is visible.
windowsWindows readonlyA collection of windows.
xmlCommentsXMLComments readonlyA collection of XML comments.
xmlElementsXMLElements readonlyA collection of XML elements.
xmlExportMapsXMLExportMaps readonlyA collection of XML export maps.
xmlExportPreferencesXMLExportPreference readonlyXML export preference settings.
xmlImportMapsXMLImportMaps readonlyA collection of XML import maps.
xmlImportPreferencesXMLImportPreference readonlyXML import preference settings.
xmlInstructionsXMLInstructions readonlyA collection of XML instructions.
xmlItemsXMLItems readonlyA collection of XML items.
xmlPreferencesXMLPreference readonlyThe XML preference settings.
xmlStoriesXmlStories readonlyA collection of xml stories.
xmlTagsXMLTags readonlyA collection of XML tags.
xmlViewPreferencesXMLViewPreference readonlyXML view preference settings.

Class

PropertyTypeAccessDescription
AFTER_ACTIVATEstring readonlyDispatched after the Document becomes active. This event bubbles. This event is not cancelable. (default: afterActivate)
AFTER_EXPORTstring readonlyDispatched after a Document is exported. This event bubbles. This event is not cancelable. (default: afterExport)
AFTER_IMPORTstring readonlyDispatched after importing a file into a Document. This event bubbles. This event is not cancelable. (default: afterImport)
AFTER_LINKS_CHANGEDstring readonlyDispatched after one or more links in the Document have been added, deleted, or modified. This event bubbles. This event is not cancelable. (default: afterLinksChanged)
AFTER_NEWstring readonlyDispatched after a Document is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_OPENstring readonlyDispatched after a Document is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_PRINTstring readonlyDispatched after a Document is printed. This event bubbles. This event is not cancelable. (default: afterPrint)
AFTER_REVERTstring readonlyDispatched after a Document is reverted. This event bubbles. This event is not cancelable. (default: afterRevert)
AFTER_SAVEstring readonlyDispatched after a Document is saved. This event bubbles. This event is not cancelable. (default: afterSave)
AFTER_SAVE_ASstring readonlyDispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable. (default: afterSaveAs)
AFTER_SAVE_A_COPYstring readonlyDispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable. (default: afterSaveACopy)
BEFORE_CLOSEstring readonlyDispatched before a Document is closed. This event bubbles. This event is not cancelable. (default: beforeClose)
BEFORE_DEACTIVATEstring readonlyDispatched before the Document becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate)
BEFORE_EXPORTstring readonlyDispatched before a Document is exported. This event bubbles. This event is cancelable. (default: beforeExport)
BEFORE_IMPORTstring readonlyDispatched before importing a file into a Document. This event bubbles. This event is cancelable. (default: beforeImport)
BEFORE_PRINTstring readonlyDispatched before a Document is printed. This event bubbles. This event is cancelable. (default: beforePrint)
BEFORE_REVERTstring readonlyDispatched before a Document is reverted. This event bubbles. This event is cancelable. (default: beforeRevert)
BEFORE_SAVEstring readonlyDispatched before a Document is saved. This event bubbles. This event is cancelable. (default: beforeSave)
BEFORE_SAVE_ASstring readonlyDispatched before a Document is saved under a new name. This event bubbles. This event is cancelable. (default: beforeSaveAs)
BEFORE_SAVE_A_COPYstring readonlyDispatched before a copy of a Document is saved. This event bubbles. This event is cancelable. (default: beforeSaveACopy)
FAILED_EXPORTstring readonlyDispatched after a Document export is canceled or fails. This event bubbles. This event is not cancelable. (default: failedExport)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void changeComposer ()
Change comoser to optyca

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

void checkIn ([versionComments: string][, forceSave: bool=false])
Check in to Version Cue.

ParameterTypeDescription
versionCommentsstringThe comment for this version (Optional)
forceSaveboolForcibly save a version (Optional) (default: false)

void close ([saving: SaveOptions=SaveOptions.ASK][, savingIn: File][, versionComments: string][, forceSave: bool=false])
Close the Document

ParameterTypeDescription
savingSaveOptions:
SaveOptions.NO
SaveOptions.ASK
SaveOptions.YES
Whether to save changes before closing the Document (Optional) (default: SaveOptions.ASK)
savingInFileThe file in which to save the Document (Optional)
versionCommentsstringThe comment for this version (Optional)
forceSaveboolForcibly save a version (Optional) (default: false)

void deleteUnusedTags ()
Deletes unused XML markup tags.

void exportFile (format: varies, to: File[, showingOptions: bool=false][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
String
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.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of PageItem findObject ([reverseOrder: bool])
Finds objects that match the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of 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.

ParameterTypeDescription
namestringThe process color to load.

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

ParameterTypeDescription
namestringThe spot color to load.

void importDtd (from: File)
Imports a DTD to use for validation.

ParameterTypeDescription
fromFileThe path to the DTD file.

void importFormats (from: File)
Imports the cross reference formats from specified file.

ParameterTypeDescription
fromFileThe file whose formats to import.

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

ParameterTypeDescription
formatImportFormat:
ImportFormat.CHARACTER_STYLES_FORMAT
ImportFormat.PARAGRAPH_STYLES_FORMAT
ImportFormat.TEXT_STYLES_FORMAT
ImportFormat.TABLE_STYLES_FORMAT
ImportFormat.CELL_STYLES_FORMAT
ImportFormat.TABLE_AND_CELL_STYLES_FORMAT
The types of styles to import.
fromFileThe file containing the styles you want to import.
globalStrategyGlobalClashResolutionStrategy:
GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE
GlobalClashResolutionStrategy.LOAD_ALL_WITH_RENAME
GlobalClashResolutionStrategy.DO_NOT_LOAD_THE_STYLE
The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) (default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE)

void importXML (from: File)
Imports the specified XML file into an InDesign document.

ParameterTypeDescription
fromFileThe XML file.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void loadConditions (from: File[, loadConditionSets: bool])
Load conditions from the specified file.

ParameterTypeDescription
fromFileThe path to the file that contains the conditions.
loadConditionSetsboolIf true, load the condition sets as well. (Optional)

void loadMasters (from: File[, globalStrategyForMasterPage: GlobalClashResolutionStrategyForMasterPage=GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE])
Load masterpages from an InDesign file.

ParameterTypeDescription
fromFileThe InDesign file to load the masters from.
globalStrategyForMasterPageGlobalClashResolutionStrategyForMasterPage:
GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE
GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_RENAME
the global clash resolution strategy for load master page (Optional) (default: GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE)

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

ParameterTypeDescription
fromFileThe swatch file or InDesign document.

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

ParameterTypeDescription
fromFileThe path to the file that contains the tags.

void mapStylesToXMLTags ()
Auto tag the document based on the style to tag mappings

void mapXMLTagsToStyles ()
Auto style the document based on the tag to style mappings

void print ([printDialog: bool])
Prints the Document(s).

ParameterTypeDescription
printDialogboolWhether to invoke the print dialog (Optional)

void recompose ()
Recomposes the text in the Document.

void redo ()
Redoes the last action.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

bool revert ()
Reverts the document to its state at the last save operation.

void revertToProject ([forceRevert: bool=false])
Reverts to the version of the document in Version Cue.

ParameterTypeDescription
forceRevertboolForcibly reverts to the project version. (Optional) (default: false)

Document save ([to: File][, fileType: SaveFileType=SaveFileType.NATIVE_FILE_TYPE])
Saves the document.

ParameterTypeDescription
toFileThe file path. Note: Required only if the document has not been previously saved. If the document has previously been saved, specifying a path saves a copy and closes the original document. (Optional)
fileTypeSaveFileType:
SaveFileType.NATIVE_FILE_TYPE
SaveFileType.PUBLICATION_FILE_TYPE
SaveFileType.TEXT_FILE_TYPE
SaveFileType.RTF_FILE_TYPE
SaveFileType.INCOPY_TEMPLATE
SaveFileType.INCOPY_MARKUP
The file type. (Optional) (default: SaveFileType.NATIVE_FILE_TYPE)

void saveACopy ([to: File][, fileType: SaveFileType=SaveFileType.NATIVE_FILE_TYPE])
Save a copy of the document

ParameterTypeDescription
toFileThe path for the copy. Note: Leaves the original document open and does not open the copy. (Optional)
fileTypeSaveFileType:
SaveFileType.NATIVE_FILE_TYPE
SaveFileType.PUBLICATION_FILE_TYPE
SaveFileType.TEXT_FILE_TYPE
SaveFileType.RTF_FILE_TYPE
SaveFileType.INCOPY_TEMPLATE
SaveFileType.INCOPY_MARKUP
The file type. (Optional) (default: SaveFileType.NATIVE_FILE_TYPE)

void saveSwatches (to: File, swatchList: Array of Swatch[, versionComments: string][, forceSave: bool=false])
Saves the specified swatch(es) to a swatchbook file.

ParameterTypeDescription
toFileThe swatchbook file to save to.
swatchList Array of SwatchThe swatch(es) to save.
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

void saveXMLTags (to: File[, versionComments: string][, forceSave: bool=false])
Saves a set of tags to an external file.

ParameterTypeDescription
toFileThe full path to the file in which to save the tags.
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

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

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

VersionCueSyncStatus synchronizeWithVersionCue ([syncConflictResolution: SyncConflictResolution=SyncConflictResolution.SKIP_CONFLICTS][, versionComments: string])
Synchronizes the file with the Version Cue project.

ParameterTypeDescription
syncConflictResolutionSyncConflictResolution:
SyncConflictResolution.SKIP_CONFLICTS
SyncConflictResolution.ASK_ABOUT_CONFLICTS
SyncConflictResolution.PREFER_LOCAL
SyncConflictResolution.PREFER_PROJECT
The conflict resolution method to use during synchronization. (Optional) (default: SyncConflictResolution.SKIP_CONFLICTS)
versionCommentsstringThe comments that describe the version. (Optional)

string toSource ()
Generates a string which, if executed, will return the Document.

string toSpecifier ()
Retrieves the object specifier.

void undo ()
Undoes the last action.

void updateCrossReferences ()
Updates cross references' text source content in the document.

Element of

AnchoredObjectDefault.parent

Application.activeDocument

Assignment.parent

BaselineFrameGridOption.parent

Color.parent

Condition.parent

ConditionSet.parent

ConditionalTextPreference.parent

CrossReferenceFormat.parent

CrossReferenceSource.parent

DTD.parent

DictionaryPreference.parent

DocumentEvent.parent

DocumentPreference.parent

ExportForWebPreference.parent

Font.parent

FootnoteOption.parent

FrameFittingOption.parent

GalleyPreference.parent

Gradient.parent

GridPreference.parent

GuidePreference.parent

Hyperlink.parent

HyperlinkExternalPageDestination.parent

HyperlinkPageItemSource.parent

HyperlinkTextDestination.parent

HyperlinkTextSource.parent

HyperlinkURLDestination.parent

HyphenationException.parent

ImportExportEvent.parent

IndexingSortOption.parent

Ink.parent

KinsokuTable.parent

Language.parent

Layer.parent

MarginPreference.parent

MasterSpread.parent

MetadataPreference.parent

MixedInk.parent

MixedInkGroup.parent

MojikumiTable.parent

MojikumiUiPreference.parent

NumberingList.parent

PageItemDefault.parent

ParagraphDestination.parent

PasteboardPreference.parent

PlaceGun.parent

PrintEvent.parent

Section.parent

Spread.parent

Story.parent

StoryPreference.parent

StrokeStyle.parent

Swatch.parent

TextDefault.parent

TextFramePreference.parent

TextPreference.parent

TextVariable.parent

TextWrapPreference.parent

Tint.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

Used in:

Document Documents.nextItem (obj: Document)

Document Documents.previousItem (obj: Document)

Return

Array of Document Document.getElements ()

Document Document.save ([to: File][, fileType: SaveFileType=SaveFileType.NATIVE_FILE_TYPE])

Document Documents.[] (index: number)

Document Documents.add ([showingWindow: bool=true][, withProperties: Object])

Document Documents.anyItem ()

Array of Document Documents.everyItem ()

Document Documents.firstItem ()

Document Documents.item (index: varies)

Document Documents.itemByID (id: number)

Document Documents.itemByName (name: string)

Array of Document Documents.itemByRange (from: varies, to: varies)

Document Documents.lastItem ()

Document Documents.middleItem ()

Document Documents.nextItem (obj: Document)

Document Documents.previousItem (obj: Document)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index