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

Property	Type	Access	Description
allCellStyles	Array of CellStyle	readonly	All Cell styles
allCharacterStyles	Array of CharacterStyle	readonly	Lists all character styles (regardless of their group).
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Document.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Document.
allParagraphStyles	Array of ParagraphStyle	readonly	Lists all paragraph styles (regardless of their group).
allTableStyles	Array of TableStyle	readonly	All Table styles
anchoredObjectDefaults	AnchoredObjectDefault	readonly	Anchored object default settings.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
assignments	Assignments Assignment	readonly	A collection of assignments.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Document.
baselineFrameGridOptions	BaselineFrameGridOption	readonly	Baseline frame grid option settings.
buttons	Buttons Button	readonly	A collection of buttons.
cellStyleGroups	CellStyleGroups CellStyleGroup	readonly	A collection of cell style groups.
cellStyles	CellStyles CellStyle	readonly	A collection of cell styles.
characterStyleGroups	CharacterStyleGroups CharacterStyleGroup	readonly	A collection of character style groups.
characterStyles	CharacterStyles CharacterStyle	readonly	A collection of character styles.
checkBoxes	CheckBoxes	readonly	A collection of checkboxes.
colors	Colors Color	readonly	A collection of colors.
comboBoxes	ComboBoxes	readonly	A collection of comboboxes.
conditionSets	ConditionSets ConditionSet	readonly	A collection of condition sets for conditional text.
conditionalTextPreferences	ConditionalTextPreference	readonly	Conditional text preferences.
conditions	Conditions Condition	readonly	A collection of conditions for conditional text.
converted	bool	readonly	If true, the Document was converted.
crossReferenceFormats	CrossReferenceFormats CrossReferenceFormat	readonly	A collection of cross reference formats.
crossReferenceSources	CrossReferenceSources CrossReferenceSource	readonly	A collection of cross reference text sources.
dictionaryPreferences	DictionaryPreference	readonly	User dictionary preference settings.
documentPreferences	DocumentPreference	readonly	Document preference settings.
dtds	DTDs DTD	readonly	A collection of DTDs.
editingState	EditingState: EditingState.EDITING_UNKNOWN EditingState.EDITING_NOWHERE EditingState.EDITING_REMOTELY EditingState.EDITING_LOCALLY EditingState.EDITING_LOCALLY_LOCKED EditingState.EDITING_CONFLICT	readonly	The Version Cue editing state of the file.
epstexts	EPSTexts EPSText	readonly	EPSTexts
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
exportForWebPreferences	ExportForWebPreference	readonly	The default export for web preferences.
filePath	File	readonly	The full path to the file.
fonts	Fonts Font	readonly	A collection of fonts.
footnoteOptions	FootnoteOption	readonly	Footnote option settings.
formFields	FormFields FormField	readonly	A collection of form fields.
frameFittingOptions	FrameFittingOption	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.
fullName	File	readonly	The full path to the Document, including the name of the Document.
galleyPreferences	GalleyPreference	readonly	Galley preference settings.
gradients	Gradients Gradient	readonly	A collection of gradients.
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
gridPreferences	GridPreference	readonly	Grid preference settings.
groups	Groups Group	readonly	A collection of groups.
guidePreferences	GuidePreference	readonly	Guide preference settings.
guides	Guides Guide	readonly	A collection of guides.
hyperlinkExternalPageDestinations	HyperlinkExternalPageDestinations HyperlinkExternalPageDestination	readonly	A collection of hyperlink external page destinations.
hyperlinkPageItemSources	HyperlinkPageItemSources HyperlinkPageItemSource	readonly	A collection of hyperlink page item sources.
hyperlinkTextDestinations	HyperlinkTextDestinations HyperlinkTextDestination	readonly	A collection of hyperlink text destinations.
hyperlinkTextSources	HyperlinkTextSources HyperlinkTextSource	readonly	A collection of hyperlink text sources.
hyperlinkURLDestinations	HyperlinkURLDestinations HyperlinkURLDestination	readonly	A collection of hyperlink URL destinations.
hyperlinks	Hyperlinks Hyperlink	readonly	A collection of hyperlinks.
hyphenationExceptions	HyphenationExceptions HyphenationException	readonly	A collection of hyphenation exceptions lists.
id	number	readonly	The unique ID of the Document.
index	number	readonly	The index of the Document within its containing object.
indexingSortOptions	IndexingSortOptions IndexingSortOption	readonly	A collection of indexing sort options.
inks	Inks Ink	readonly	A collection of inks.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
kinsokuTables	KinsokuTables KinsokuTable	readonly	A collection of kinsoku tables.
label	string	r/w	A property that can be set to any string.
languages	Languages Language	readonly	A collection of languages.
layers	Layers Layer	readonly	A collection of layers.
links	Links Link	readonly	A collection of links.
listBoxes	ListBoxes	readonly	A collection of listboxes.
marginPreferences	MarginPreference	readonly	Margin preference settings.
masterSpreads	MasterSpreads MasterSpread	readonly	A collection of master spreads.
metadataPreferences	MetadataPreference	readonly	Metadata preference settings.
mixedInkGroups	MixedInkGroups MixedInkGroup	readonly	A collection of mixed ink groups.
mixedInks	MixedInks MixedInk	readonly	A collection of mixed inks.
modified	bool	readonly	If true, the Document has been modified since it was last saved.
mojikumiTables	MojikumiTables MojikumiTable	readonly	A collection of mojikumi tables.
mojikumiUIPreferences	MojikumiUiPreference	readonly	Mojikumi user interface preference settings.
multiStateObjects	MultiStateObjects MultiStateObject	readonly	A collection of multi-state objects.
name	string	readonly	The name of the Document.
numberingLists	NumberingLists NumberingList	readonly	A collection of numbered lists.
ovals	Ovals Oval	readonly	A collection of ellipses.
pageItemDefaults	PageItemDefault	readonly	The default page item formatting for the Document.
pageItems	PageItems PageItem	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.
pages	Pages Page	readonly	A collection of pages.
paragraphDestinations	ParagraphDestinations ParagraphDestination	readonly	A collection of paragraph destinations.
paragraphStyleGroups	ParagraphStyleGroups ParagraphStyleGroup	readonly	A collection of paragraph style groups.
paragraphStyles	ParagraphStyles ParagraphStyle	readonly	A collection of paragraph styles.
parent	Application	readonly	The parent of the Document (a Application).
pasteboardPreferences	PasteboardPreference	readonly	Pasteboard preference settings.
placeGuns	PlaceGun	readonly	The place gun.
polygons	Polygons Polygon	readonly	A collection of polygons.
preferences	Preferences Preference	readonly	A collection of preferences objects.
properties	Object	r/w	A property that allows setting of several properties at the same time.
radioButtons	RadioButtons RadioButton	readonly	A collection of radio buttons.
readOnly	bool	readonly	If true, the Document is read-only.
recovered	bool	readonly	If true, the Document was recovered.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
redoHistory	Array of string	readonly	The names of the items in the redo stack.
redoName	string	readonly	The name of the action on the top of the redo stack.
saved	bool	readonly	If true, the Document has been saved since it was created.
sections	Sections Section	readonly	A collection of sections.
selection	Array of Object	r/w	The selected object(s). Can also accept: Object or NothingEnum enumerator.
signatureFields	SignatureFields SignatureField	readonly	A collection of signature fields.
splineItems	SplineItems SplineItem	readonly	The spline items collection.
spreads	Spreads Spread	readonly	A collection of spreads.
stories	Stories Story	readonly	A collection of stories.
storyPreferences	StoryPreference	readonly	Story preference settings.
strokeStyles	StrokeStyles StrokeStyle	readonly	A collection of stroke styles.
swatches	Swatches	readonly	A collection of swatches.
tableStyleGroups	TableStyleGroups TableStyleGroup	readonly	A collection of table style groups.
tableStyles	TableStyles TableStyle	readonly	A collection of table styles.
textBoxes	TextBoxes	readonly	A collection of text boxes.
textDefaults	TextDefault	readonly	Text default settings.
textFramePreferences	TextFramePreference	readonly	Text frame preference settings.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textPreferences	TextPreference	readonly	Text preference settings.
textVariables	TextVariables TextVariable	readonly	A collection of text variables.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
tints	Tints Tint	readonly	A collection of tints.
trapPresets	TrapPresets TrapPreset	readonly	A collection of trap presets.
undoHistory	Array of string	readonly	The names of the items in the undo stack.
undoName	string	readonly	The name of the action on the top of the undo stack.
unusedSwatches	Array of Swatch	readonly	The swatches that are not being used.
validationErrors	ValidationErrors ValidationError	readonly	A collection of XML validation errors.
versionState	VersionState: VersionState.VERSION_UNKNOWN VersionState.PROJECT_FILE_NEWER VersionState.LOCAL_PROJECT_MATCH VersionState.LOCAL_NEWER VersionState.VERSION_CONFLICT VersionState.NO_RESOURCE	readonly	The Version Cue version state of the file.
viewPreferences	ViewPreference	readonly	View preference settings.
visible	bool	readonly	If true, the Document is visible.
windows	Windows Window	readonly	A collection of windows.
xmlComments	XMLComments XMLComment	readonly	A collection of XML comments.
xmlElements	XMLElements XMLElement	readonly	A collection of XML elements.
xmlExportMaps	XMLExportMaps XMLExportMap	readonly	A collection of XML export maps.
xmlExportPreferences	XMLExportPreference	readonly	XML export preference settings.
xmlImportMaps	XMLImportMaps XMLImportMap	readonly	A collection of XML import maps.
xmlImportPreferences	XMLImportPreference	readonly	XML import preference settings.
xmlInstructions	XMLInstructions XMLInstruction	readonly	A collection of XML instructions.
xmlItems	XMLItems XMLItem	readonly	A collection of XML items.
xmlPreferences	XMLPreference	readonly	The XML preference settings.
xmlStories	XmlStories XmlStory	readonly	A collection of xml stories.
xmlTags	XMLTags XMLTag	readonly	A collection of XML tags.
xmlViewPreferences	XMLViewPreference	readonly	XML view preference settings.

Class

Property	Type	Access	Description
AFTER_ACTIVATE	string	readonly	Dispatched after the Document becomes active. This event bubbles. This event is not cancelable. (default: afterActivate)
AFTER_EXPORT	string	readonly	Dispatched after a Document is exported. This event bubbles. This event is not cancelable. (default: afterExport)
AFTER_IMPORT	string	readonly	Dispatched after importing a file into a Document. This event bubbles. This event is not cancelable. (default: afterImport)
AFTER_LINKS_CHANGED	string	readonly	Dispatched 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_NEW	string	readonly	Dispatched after a Document is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_OPEN	string	readonly	Dispatched after a Document is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_PRINT	string	readonly	Dispatched after a Document is printed. This event bubbles. This event is not cancelable. (default: afterPrint)
AFTER_REVERT	string	readonly	Dispatched after a Document is reverted. This event bubbles. This event is not cancelable. (default: afterRevert)
AFTER_SAVE	string	readonly	Dispatched after a Document is saved. This event bubbles. This event is not cancelable. (default: afterSave)
AFTER_SAVE_AS	string	readonly	Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable. (default: afterSaveAs)
AFTER_SAVE_A_COPY	string	readonly	Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable. (default: afterSaveACopy)
BEFORE_CLOSE	string	readonly	Dispatched before a Document is closed. This event bubbles. This event is not cancelable. (default: beforeClose)
BEFORE_DEACTIVATE	string	readonly	Dispatched before the Document becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate)
BEFORE_EXPORT	string	readonly	Dispatched before a Document is exported. This event bubbles. This event is cancelable. (default: beforeExport)
BEFORE_IMPORT	string	readonly	Dispatched before importing a file into a Document. This event bubbles. This event is cancelable. (default: beforeImport)
BEFORE_PRINT	string	readonly	Dispatched before a Document is printed. This event bubbles. This event is cancelable. (default: beforePrint)
BEFORE_REVERT	string	readonly	Dispatched before a Document is reverted. This event bubbles. This event is cancelable. (default: beforeRevert)
BEFORE_SAVE	string	readonly	Dispatched before a Document is saved. This event bubbles. This event is cancelable. (default: beforeSave)
BEFORE_SAVE_AS	string	readonly	Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable. (default: beforeSaveAs)
BEFORE_SAVE_A_COPY	string	readonly	Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable. (default: beforeSaveACopy)
FAILED_EXPORT	string	readonly	Dispatched 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.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
reverseOrder	bool	If 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.

Parameter	Type	Description
reverseOrder	bool	If 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.

Parameter	Type	Description
reverseOrder	bool	If 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.

Parameter	Type	Description
reverseOrder	bool	If 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.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

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

Parameter	Type	Description
versionComments	string	The comment for this version (Optional)
forceSave	bool	Forcibly save a version (Optional) (default: false)

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

Parameter	Type	Description
saving	SaveOptions: SaveOptions.NO SaveOptions.ASK SaveOptions.YES	Whether to save changes before closing the Document (Optional) (default: SaveOptions.ASK)
savingIn	File	The file in which to save the Document (Optional)
versionComments	string	The comment for this version (Optional)
forceSave	bool	Forcibly 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.

Parameter	Type	Description
format	ExportFormat 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.
to	File	The path to the export file.
showingOptions	bool	If true, displays the export options dialog. (Optional) (default: false)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

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

Parameter	Type	Description
key	string	The key.

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

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

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

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

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

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

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

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

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

Parameter	Type	Description
reverseOrder	bool	If 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.

Parameter	Type	Description
name	string	The process color to load.

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

Parameter	Type	Description
name	string	The spot color to load.

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

Parameter	Type	Description
from	File	The path to the DTD file.

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

Parameter	Type	Description
from	File	The file whose formats to import.

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

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

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

Parameter	Type	Description
from	File	The XML file.

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

Parameter	Type	Description
key	string	The key.
value	string	The value.

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

Parameter	Type	Description
from	File	The path to the file that contains the conditions.
loadConditionSets	bool	If 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.

Parameter	Type	Description
from	File	The InDesign file to load the masters from.
globalStrategyForMasterPage	GlobalClashResolutionStrategyForMasterPage: 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.

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

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

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

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

Parameter	Type	Description
printDialog	bool	Whether 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
forceRevert	bool	Forcibly reverts to the project version. (Optional) (default: false)

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

Parameter	Type	Description
to	File	The 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)
fileType	SaveFileType: 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

Parameter	Type	Description
to	File	The path for the copy. Note: Leaves the original document open and does not open the copy. (Optional)
fileType	SaveFileType: 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.

Parameter	Type	Description
to	File	The swatchbook file to save to.
swatchList	Array of Swatch	The swatch(es) to save.
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If 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.

Parameter	Type	Description
to	File	The full path to the file in which to save the tags.
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

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

Parameter	Type	Description
selectableItems	Array of Objects NothingEnum Object SelectAll	The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection	SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the 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.

Parameter	Type	Description
syncConflictResolution	SyncConflictResolution: 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)
versionComments	string	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.

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, 29-Apr-2012 v3.0.3i

Contents :: Index