Package | com.adobe.incopy |
Class | public class Document |
Inheritance | Document ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
AFTER_ACTIVATE : String [static] [read-only]
Dispatched after the Document becomes active. | Document | ||
AFTER_EXPORT : String [static] [read-only]
Dispatched after a Document is exported. | Document | ||
AFTER_IMPORT : String [static] [read-only]
Dispatched after importing a file into a Document. | Document | ||
AFTER_LINKS_CHANGED : String [static] [read-only]
Dispatched after one or more links in the Document have been added, deleted, or modified. | Document | ||
AFTER_NEW : String [static] [read-only]
Dispatched after a Document is created. | Document | ||
AFTER_OPEN : String [static] [read-only]
Dispatched after a Document is opened. | Document | ||
AFTER_PRINT : String [static] [read-only]
Dispatched after a Document is printed. | Document | ||
AFTER_REVERT : String [static] [read-only]
Dispatched after a Document is reverted. | Document | ||
AFTER_SAVE : String [static] [read-only]
Dispatched after a Document is saved. | Document | ||
AFTER_SAVE_A_COPY : String [static] [read-only]
Dispatched after a copy of a Document is saved. | Document | ||
AFTER_SAVE_AS : String [static] [read-only]
Dispatched after a Document is saved under a new name. | Document | ||
allCellStyles : Object [read-only]
All Cell styles
| Document | ||
allCharacterStyles : Object [read-only]
Lists all character styles (regardless of their group). | Document | ||
allGraphics : Object [read-only]
Lists all graphics contained by the Document. | Document | ||
allPageItems : Object [read-only]
Lists all page items contained by the Document. | Document | ||
allParagraphStyles : Object [read-only]
Lists all paragraph styles (regardless of their group). | Document | ||
allTableStyles : Object [read-only]
All Table styles
| Document | ||
anchoredObjectDefaults : AnchoredObjectDefault [read-only]
Anchored object default settings. | Document | ||
anchoredObjectSettings : AnchoredObjectSetting [read-only]
Anchored object settings. | Document | ||
assignments : Assignments [read-only]
A collection of assignments. | Document | ||
associatedXMLElement : XMLItem [read-only]
The XML element associated with the Document. | Document | ||
baselineFrameGridOptions : BaselineFrameGridOption [read-only]
Baseline frame grid option settings. | Document | ||
BEFORE_CLOSE : String [static] [read-only]
Dispatched before a Document is closed. | Document | ||
BEFORE_DEACTIVATE : String [static] [read-only]
Dispatched before the Document becomes inactive. | Document | ||
BEFORE_EXPORT : String [static] [read-only]
Dispatched before a Document is exported. | Document | ||
BEFORE_IMPORT : String [static] [read-only]
Dispatched before importing a file into a Document. | Document | ||
BEFORE_PRINT : String [static] [read-only]
Dispatched before a Document is printed. | Document | ||
BEFORE_REVERT : String [static] [read-only]
Dispatched before a Document is reverted. | Document | ||
BEFORE_SAVE : String [static] [read-only]
Dispatched before a Document is saved. | Document | ||
BEFORE_SAVE_A_COPY : String [static] [read-only]
Dispatched before a copy of a Document is saved. | Document | ||
BEFORE_SAVE_AS : String [static] [read-only]
Dispatched before a Document is saved under a new name. | Document | ||
buttons : Buttons [read-only]
A collection of buttons. | Document | ||
cellStyleGroups : CellStyleGroups [read-only]
A collection of cell style groups. | Document | ||
cellStyles : CellStyles [read-only]
A collection of cell styles. | Document | ||
characterStyleGroups : CharacterStyleGroups [read-only]
A collection of character style groups. | Document | ||
characterStyles : CharacterStyles [read-only]
A collection of character styles. | Document | ||
colors : Colors [read-only]
A collection of colors. | Document | ||
conditionalTextPreferences : ConditionalTextPreference [read-only]
Conditional text preferences. | Document | ||
conditions : Conditions [read-only]
A collection of conditions for conditional text. | Document | ||
conditionSets : ConditionSets [read-only]
A collection of condition sets for conditional text. | Document | ||
converted : Boolean [read-only]
If true, the Document was converted. | Document | ||
crossReferenceFormats : CrossReferenceFormats [read-only]
A collection of cross reference formats. | Document | ||
crossReferenceSources : CrossReferenceSources [read-only]
A collection of cross reference text sources. | Document | ||
dictionaryPreferences : DictionaryPreference [read-only]
User dictionary preference settings. | Document | ||
documentPreferences : DocumentPreference [read-only]
Document preference settings. | Document | ||
dtds : DTDs [read-only]
A collection of DTDs. | Document | ||
editingState : EditingState [read-only]
The Version Cue editing state of the file. | Document | ||
epstexts : EPSTexts [read-only]
EPSTexts
| Document | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Document | ||
events : Events [read-only]
A collection of events. | Document | ||
exportForWebPreferences : ExportForWebPreference [read-only]
The default export for web preferences. | Document | ||
FAILED_EXPORT : String [static] [read-only]
Dispatched after a Document export is canceled or fails. | Document | ||
filePath : File [read-only]
The full path to the file. | Document | ||
fonts : Fonts [read-only]
A collection of fonts. | Document | ||
footnoteOptions : FootnoteOption [read-only]
Footnote option settings. | Document | ||
formFields : FormFields [read-only]
A collection of form fields. | Document | ||
frameFittingOptions : FrameFittingOption [read-only]
The frame fitting option to apply to placed or pasted content. | Document | ||
fullName : File [read-only]
The full path to the Document, including the name of the Document. | Document | ||
galleyPreferences : GalleyPreference [read-only]
Galley preference settings. | Document | ||
gradients : Gradients [read-only]
A collection of gradients. | Document | ||
graphicLines : GraphicLines [read-only]
A collection of graphic lines. | Document | ||
gridPreferences : GridPreference [read-only]
Grid preference settings. | Document | ||
groups : Groups [read-only]
A collection of groups. | Document | ||
guidePreferences : GuidePreference [read-only]
Guide preference settings. | Document | ||
guides : Guides [read-only]
A collection of guides. | Document | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
hyperlinkExternalPageDestinations : HyperlinkExternalPageDestinations [read-only]
A collection of hyperlink external page destinations. | Document | ||
hyperlinkPageItemSources : HyperlinkPageItemSources [read-only]
A collection of hyperlink page item sources. | Document | ||
hyperlinks : Hyperlinks [read-only]
A collection of hyperlinks. | Document | ||
hyperlinkTextDestinations : HyperlinkTextDestinations [read-only]
A collection of hyperlink text destinations. | Document | ||
hyperlinkTextSources : HyperlinkTextSources [read-only]
A collection of hyperlink text sources. | Document | ||
hyperlinkURLDestinations : HyperlinkURLDestinations [read-only]
A collection of hyperlink URL destinations. | Document | ||
hyphenationExceptions : HyphenationExceptions [read-only]
A collection of hyphenation exceptions lists. | Document | ||
id : Number [read-only]
The unique ID of the Document. | Document | ||
index : Number [read-only]
The index of the Document within its containing object. | Document | ||
indexingSortOptions : IndexingSortOptions [read-only]
A collection of indexing sort options. | Document | ||
inks : Inks [read-only]
A collection of inks. | Document | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Document | ||
kinsokuTables : KinsokuTables [read-only]
A collection of kinsoku tables. | Document | ||
label : String
A property that can be set to any string. | Document | ||
languages : Languages [read-only]
A collection of languages. | Document | ||
layers : Layers [read-only]
A collection of layers. | Document | ||
links : Links [read-only]
A collection of links. | Document | ||
marginPreferences : MarginPreference [read-only]
Margin preference settings. | Document | ||
masterSpreads : MasterSpreads [read-only]
A collection of master spreads. | Document | ||
metadataPreferences : MetadataPreference [read-only]
Metadata preference settings. | Document | ||
mixedInkGroups : MixedInkGroups [read-only]
A collection of mixed ink groups. | Document | ||
mixedInks : MixedInks [read-only]
A collection of mixed inks. | Document | ||
modified : Boolean [read-only]
If true, the Document has been modified since it was last saved. | Document | ||
mojikumiTables : MojikumiTables [read-only]
A collection of mojikumi tables. | Document | ||
mojikumiUIPreferences : MojikumiUiPreference [read-only]
Mojikumi user interface preference settings. | Document | ||
multiStateObjects : MultiStateObjects [read-only]
A collection of multi-state objects. | Document | ||
name : String [read-only]
The name of the Document. | Document | ||
numberingLists : NumberingLists [read-only]
A collection of numbered lists. | Document | ||
ovals : Ovals [read-only]
A collection of ellipses. | Document | ||
pageItemDefaults : PageItemDefault [read-only]
The default page item formatting for the Document. | Document | ||
pageItems : PageItems [read-only]
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. | Document | ||
pages : Pages [read-only]
A collection of pages. | Document | ||
paragraphDestinations : ParagraphDestinations [read-only]
A collection of paragraph destinations. | Document | ||
paragraphStyleGroups : ParagraphStyleGroups [read-only]
A collection of paragraph style groups. | Document | ||
paragraphStyles : ParagraphStyles [read-only]
A collection of paragraph styles. | Document | ||
parent : Application [read-only]
The parent of the Document (a Application). | Document | ||
pasteboardPreferences : PasteboardPreference [read-only]
Pasteboard preference settings. | Document | ||
placeGuns : PlaceGun [read-only]
The place gun. | Document | ||
polygons : Polygons [read-only]
A collection of polygons. | Document | ||
preferences : Preferences [read-only]
A collection of preferences objects. | Document | ||
properties : Object
A property that allows setting of several properties at the same time. | Document | ||
readOnly : Boolean [read-only]
If true, the Document is read-only. | Document | ||
recovered : Boolean [read-only]
If true, the Document was recovered. | Document | ||
rectangles : Rectangles [read-only]
A collection of rectangles. | Document | ||
redoHistory : Object [read-only]
The names of the items in the redo stack. | Document | ||
redoName : String [read-only]
The name of the action on the top of the redo stack. | Document | ||
saved : Boolean [read-only]
If true, the Document has been saved since it was created. | Document | ||
sections : Sections [read-only]
A collection of sections. | Document | ||
selection : Object
The selected object(s). | Document | ||
splineItems : SplineItems [read-only]
The spline items collection. | Document | ||
spreads : Spreads [read-only]
A collection of spreads. | Document | ||
stories : Stories [read-only]
A collection of stories. | Document | ||
storyPreferences : StoryPreference [read-only]
Story preference settings. | Document | ||
strokeStyles : StrokeStyles [read-only]
A collection of stroke styles. | Document | ||
swatches : Swatches [read-only]
A collection of swatches. | Document | ||
tableStyleGroups : TableStyleGroups [read-only]
A collection of table style groups. | Document | ||
tableStyles : TableStyles [read-only]
A collection of table styles. | Document | ||
textDefaults : TextDefault [read-only]
Text default settings. | Document | ||
textFramePreferences : TextFramePreference [read-only]
Text frame preference settings. | Document | ||
textFrames : TextFrames [read-only]
A collection of text frames. | Document | ||
textPreferences : TextPreference [read-only]
Text preference settings. | Document | ||
textVariables : TextVariables [read-only]
A collection of text variables. | Document | ||
textWrapPreferences : TextWrapPreference [read-only]
The text wrap preference properties that define the default formatting for wrapping text around objects. | Document | ||
tints : Tints [read-only]
A collection of tints. | Document | ||
trapPresets : TrapPresets [read-only]
A collection of trap presets. | Document | ||
undoHistory : Object [read-only]
The names of the items in the undo stack. | Document | ||
undoName : String [read-only]
The name of the action on the top of the undo stack. | Document | ||
unusedSwatches : Object [read-only]
The swatches that are not being used. | Document | ||
validationErrors : ValidationErrors [read-only]
A collection of XML validation errors. | Document | ||
versionState : VersionState [read-only]
The Version Cue version state of the file. | Document | ||
viewPreferences : ViewPreference [read-only]
View preference settings. | Document | ||
visible : Boolean [read-only]
If true, the Document is visible. | Document | ||
windows : Windows [read-only]
A collection of windows. | Document | ||
xmlComments : XMLComments [read-only]
A collection of XML comments. | Document | ||
xmlElements : XMLElements [read-only]
A collection of XML elements. | Document | ||
xmlExportMaps : XMLExportMaps [read-only]
A collection of XML export maps. | Document | ||
xmlExportPreferences : XMLExportPreference [read-only]
XML export preference settings. | Document | ||
xmlImportMaps : XMLImportMaps [read-only]
A collection of XML import maps. | Document | ||
xmlImportPreferences : XMLImportPreference [read-only]
XML import preference settings. | Document | ||
xmlInstructions : XMLInstructions [read-only]
A collection of XML instructions. | Document | ||
xmlItems : XMLItems [read-only]
A collection of XML items. | Document | ||
xmlPreferences : XMLPreference [read-only]
The XML preference settings. | Document | ||
xmlStories : XmlStories [read-only]
A collection of xml stories. | Document | ||
xmlTags : XMLTags [read-only]
A collection of XML tags. | Document | ||
xmlViewPreferences : XMLViewPreference [read-only]
XML view preference settings. | Document |
Method | Defined By | ||
---|---|---|---|
addEventListenerDocument(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Document | ||
changeComposer():void
Change comoser to optyca
| Document | ||
changeGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value and replaces the glyphs with the change to value. | Document | ||
changeGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | Document | ||
changeObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value and replace the objects with the change to value. | Document | ||
changeText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | Document | ||
changeTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value and replaces the text with the change character type value. | Document | ||
checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Check in to Version Cue. | Document | ||
close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Close the Document
| Document | ||
deleteUnusedTags():void
Deletes unused XML markup tags. | Document | ||
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports the object(s) to a file. | Document | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Document | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
findGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value. | Document | ||
findGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | Document | ||
findObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value. | Document | ||
findText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | Document | ||
findTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value. | Document | ||
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object
Resolves the object specifier, creating an array of object references. | Document | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
importAdobeSwatchbookProcessColor(nameParam:String = null):Color
Imports a process color swatch from a preloaded Adobe color book. | Document | ||
importAdobeSwatchbookSpotColor(nameParam:String = null):Color
Imports a spot color swatch from an Adobe color book. | Document | ||
importDtd(fromParam:File = null):void
Imports a DTD to use for validation. | Document | ||
importFormats(fromParam:File = null):void
Imports the cross reference formats from specified file. | Document | ||
importStyles(formatParam:ImportFormat = null, fromParam:File = null, globalStrategyParam:GlobalClashResolutionStrategy = null):void
Imports the specified styles. | Document | ||
importXML(fromParam:File = null):void
Imports the specified XML file into an InDesign document. | Document | ||
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | Document | ||
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
loadConditions(fromParam:File = null, loadConditionSetsParam:Boolean):void
Load conditions from the specified file. | Document | ||
loadMasters(fromParam:File = null, globalStrategyForMasterPageParam:GlobalClashResolutionStrategyForMasterPage = null):void
Load masterpages from an InDesign file. | Document | ||
loadSwatches(fromParam:File = null):void
Load swatches from the specified file. | Document | ||
loadXMLTags(fromParam:File = null):void
Loads a set of XML markup tags from the specified file. | Document | ||
mapStylesToXMLTags():void
Auto tag the document based on the style to tag mappings
| Document | ||
mapXMLTagsToStyles():void
Auto style the document based on the tag to style mappings
| Document | ||
placeBuzzword(fileurlsParam:String = null, showingOptionsParam:Boolean = false, createLinkParam:Boolean = false, replaceSelectedParam:Boolean = true, applyGridParam:Boolean = false):void
Place the Buzzword document. | Document | ||
print(printDialogParam:Boolean):void
Prints the Document(s). | Document | ||
recompose():void
Recomposes the text in the Document. | Document | ||
redo():void
Redoes the last action. | Document | ||
removeEventListenerDocument(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Document | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
revert():Boolean
Reverts the document to its state at the last save operation. | Document | ||
revertToProject(forceRevertParam:Boolean = false):void
Reverts to the version of the document in Version Cue. | Document | ||
Saves the document. | Document | ||
saveACopy(toParam:File = null, fileTypeParam:SaveFileType = null):void
Save a copy of the document
| Document | ||
saveSwatches(toParam:File = null, swatchListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves the specified swatch(es) to a swatchbook file. | Document | ||
saveXMLTags(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves a set of tags to an external file. | Document | ||
select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Selects the specified object(s). | Document | ||
synchronizeWithVersionCue(syncConflictResolutionParam:SyncConflictResolution = null, versionCommentsParam:String = null):VersionCueSyncStatus
Synchronizes the file with the Version Cue project. | Document | ||
toSpecifier():String
Retrieves the object specifier. | Document | ||
undo():void
Undoes the last action. | Document | ||
updateCrossReferences():void
Updates cross references' text source content in the document. | Document | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
AFTER_ACTIVATE | property |
AFTER_ACTIVATE:String
[read-only] Since : | CS5 |
Dispatched after the Document becomes active. This event bubbles. This event is not cancelable.
public static function get AFTER_ACTIVATE():String
AFTER_EXPORT | property |
AFTER_EXPORT:String
[read-only] Since : | CS5 |
Dispatched after a Document is exported. This event bubbles. This event is not cancelable.
public static function get AFTER_EXPORT():String
AFTER_IMPORT | property |
AFTER_IMPORT:String
[read-only] Since : | CS5 |
Dispatched after importing a file into a Document. This event bubbles. This event is not cancelable.
public static function get AFTER_IMPORT():String
AFTER_LINKS_CHANGED | property |
AFTER_LINKS_CHANGED:String
[read-only] Since : | CS5 |
Dispatched after one or more links in the Document have been added, deleted, or modified. This event bubbles. This event is not cancelable.
public static function get AFTER_LINKS_CHANGED():String
AFTER_NEW | property |
AFTER_NEW:String
[read-only] Since : | CS5 |
Dispatched after a Document is created. This event bubbles. This event is not cancelable.
public static function get AFTER_NEW():String
AFTER_OPEN | property |
AFTER_OPEN:String
[read-only] Since : | CS5 |
Dispatched after a Document is opened. This event bubbles. This event is not cancelable.
public static function get AFTER_OPEN():String
AFTER_PRINT | property |
AFTER_PRINT:String
[read-only] Since : | CS5 |
Dispatched after a Document is printed. This event bubbles. This event is not cancelable.
public static function get AFTER_PRINT():String
AFTER_REVERT | property |
AFTER_REVERT:String
[read-only] Since : | CS5 |
Dispatched after a Document is reverted. This event bubbles. This event is not cancelable.
public static function get AFTER_REVERT():String
AFTER_SAVE | property |
AFTER_SAVE:String
[read-only] Since : | CS5 |
Dispatched after a Document is saved. This event bubbles. This event is not cancelable.
public static function get AFTER_SAVE():String
AFTER_SAVE_A_COPY | property |
AFTER_SAVE_A_COPY:String
[read-only] Since : | CS5 |
Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable.
public static function get AFTER_SAVE_A_COPY():String
AFTER_SAVE_AS | property |
AFTER_SAVE_AS:String
[read-only] Since : | CS5 |
Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable.
public static function get AFTER_SAVE_AS():String
allCellStyles | property |
allCellStyles:Object
[read-only] Since : | CS5 |
All Cell styles
public function get allCellStyles():Object
allCharacterStyles | property |
allCharacterStyles:Object
[read-only] Since : | CS5 |
Lists all character styles (regardless of their group).
public function get allCharacterStyles():Object
allGraphics | property |
allGraphics:Object
[read-only] Since : | CS5 |
Lists all graphics contained by the Document.
public function get allGraphics():Object
allPageItems | property |
allPageItems:Object
[read-only] Since : | CS5 |
Lists all page items contained by the Document.
public function get allPageItems():Object
allParagraphStyles | property |
allParagraphStyles:Object
[read-only] Since : | CS5 |
Lists all paragraph styles (regardless of their group).
public function get allParagraphStyles():Object
allTableStyles | property |
allTableStyles:Object
[read-only] Since : | CS5 |
All Table styles
public function get allTableStyles():Object
anchoredObjectDefaults | property |
anchoredObjectDefaults:AnchoredObjectDefault
[read-only] Since : | CS5 |
Anchored object default settings.
public function get anchoredObjectDefaults():AnchoredObjectDefault
anchoredObjectSettings | property |
anchoredObjectSettings:AnchoredObjectSetting
[read-only] Since : | CS5 |
Anchored object settings.
public function get anchoredObjectSettings():AnchoredObjectSetting
assignments | property |
assignments:Assignments
[read-only] Since : | CS5 |
A collection of assignments.
public function get assignments():Assignments
associatedXMLElement | property |
associatedXMLElement:XMLItem
[read-only] Since : | CS5 |
The XML element associated with the Document.
public function get associatedXMLElement():XMLItem
baselineFrameGridOptions | property |
baselineFrameGridOptions:BaselineFrameGridOption
[read-only] Since : | CS5 |
Baseline frame grid option settings.
public function get baselineFrameGridOptions():BaselineFrameGridOption
BEFORE_CLOSE | property |
BEFORE_CLOSE:String
[read-only] Since : | CS5 |
Dispatched before a Document is closed. This event bubbles. This event is not cancelable.
public static function get BEFORE_CLOSE():String
BEFORE_DEACTIVATE | property |
BEFORE_DEACTIVATE:String
[read-only] Since : | CS5 |
Dispatched before the Document becomes inactive. This event bubbles. This event is not cancelable.
public static function get BEFORE_DEACTIVATE():String
BEFORE_EXPORT | property |
BEFORE_EXPORT:String
[read-only] Since : | CS5 |
Dispatched before a Document is exported. This event bubbles. This event is cancelable.
public static function get BEFORE_EXPORT():String
BEFORE_IMPORT | property |
BEFORE_IMPORT:String
[read-only] Since : | CS5 |
Dispatched before importing a file into a Document. This event bubbles. This event is cancelable.
public static function get BEFORE_IMPORT():String
BEFORE_PRINT | property |
BEFORE_PRINT:String
[read-only] Since : | CS5 |
Dispatched before a Document is printed. This event bubbles. This event is cancelable.
public static function get BEFORE_PRINT():String
BEFORE_REVERT | property |
BEFORE_REVERT:String
[read-only] Since : | CS5 |
Dispatched before a Document is reverted. This event bubbles. This event is cancelable.
public static function get BEFORE_REVERT():String
BEFORE_SAVE | property |
BEFORE_SAVE:String
[read-only] Since : | CS5 |
Dispatched before a Document is saved. This event bubbles. This event is cancelable.
public static function get BEFORE_SAVE():String
BEFORE_SAVE_A_COPY | property |
BEFORE_SAVE_A_COPY:String
[read-only] Since : | CS5 |
Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable.
public static function get BEFORE_SAVE_A_COPY():String
BEFORE_SAVE_AS | property |
BEFORE_SAVE_AS:String
[read-only] Since : | CS5 |
Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable.
public static function get BEFORE_SAVE_AS():String
buttons | property |
buttons:Buttons
[read-only] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
cellStyleGroups | property |
cellStyleGroups:CellStyleGroups
[read-only] Since : | CS5 |
A collection of cell style groups.
public function get cellStyleGroups():CellStyleGroups
cellStyles | property |
cellStyles:CellStyles
[read-only] Since : | CS5 |
A collection of cell styles.
public function get cellStyles():CellStyles
characterStyleGroups | property |
characterStyleGroups:CharacterStyleGroups
[read-only] Since : | CS5 |
A collection of character style groups.
public function get characterStyleGroups():CharacterStyleGroups
characterStyles | property |
characterStyles:CharacterStyles
[read-only] Since : | CS5 |
A collection of character styles.
public function get characterStyles():CharacterStyles
colors | property |
colors:Colors
[read-only] Since : | CS5 |
A collection of colors.
public function get colors():Colors
conditionalTextPreferences | property |
conditionalTextPreferences:ConditionalTextPreference
[read-only] Since : | CS5 |
Conditional text preferences.
public function get conditionalTextPreferences():ConditionalTextPreference
conditions | property |
conditions:Conditions
[read-only] Since : | CS5 |
A collection of conditions for conditional text.
public function get conditions():Conditions
conditionSets | property |
conditionSets:ConditionSets
[read-only] Since : | CS5 |
A collection of condition sets for conditional text.
public function get conditionSets():ConditionSets
converted | property |
converted:Boolean
[read-only] Since : | CS5 |
If true, the Document was converted.
public function get converted():Boolean
crossReferenceFormats | property |
crossReferenceFormats:CrossReferenceFormats
[read-only] Since : | CS5 |
A collection of cross reference formats.
public function get crossReferenceFormats():CrossReferenceFormats
crossReferenceSources | property |
crossReferenceSources:CrossReferenceSources
[read-only] Since : | CS5 |
A collection of cross reference text sources.
public function get crossReferenceSources():CrossReferenceSources
dictionaryPreferences | property |
dictionaryPreferences:DictionaryPreference
[read-only] Since : | CS5 |
User dictionary preference settings.
public function get dictionaryPreferences():DictionaryPreference
documentPreferences | property |
documentPreferences:DocumentPreference
[read-only] Since : | CS5 |
Document preference settings.
public function get documentPreferences():DocumentPreference
dtds | property |
dtds:DTDs
[read-only] Since : | CS5 |
A collection of DTDs.
public function get dtds():DTDs
editingState | property |
editingState:EditingState
[read-only] Since : | CS5 |
The Version Cue editing state of the file.
public function get editingState():EditingState
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
exportForWebPreferences | property |
exportForWebPreferences:ExportForWebPreference
[read-only] Since : | CS5 |
The default export for web preferences.
public function get exportForWebPreferences():ExportForWebPreference
FAILED_EXPORT | property |
FAILED_EXPORT:String
[read-only] Since : | CS5 |
Dispatched after a Document export is canceled or fails. This event bubbles. This event is not cancelable.
public static function get FAILED_EXPORT():String
filePath | property |
filePath:File
[read-only] Since : | CS5 |
The full path to the file.
public function get filePath():File
fonts | property |
fonts:Fonts
[read-only] Since : | CS5 |
A collection of fonts.
public function get fonts():Fonts
footnoteOptions | property |
footnoteOptions:FootnoteOption
[read-only] Since : | CS5 |
Footnote option settings.
public function get footnoteOptions():FootnoteOption
formFields | property |
formFields:FormFields
[read-only] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
frameFittingOptions | property |
frameFittingOptions:FrameFittingOption
[read-only] Since : | CS5 |
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.
public function get frameFittingOptions():FrameFittingOption
fullName | property |
fullName:File
[read-only] Since : | CS5 |
The full path to the Document, including the name of the Document.
public function get fullName():File
galleyPreferences | property |
galleyPreferences:GalleyPreference
[read-only] Since : | CS5 |
Galley preference settings.
public function get galleyPreferences():GalleyPreference
gradients | property |
gradients:Gradients
[read-only] Since : | CS5 |
A collection of gradients.
public function get gradients():Gradients
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
gridPreferences | property |
gridPreferences:GridPreference
[read-only] Since : | CS5 |
Grid preference settings.
public function get gridPreferences():GridPreference
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
guidePreferences | property |
guidePreferences:GuidePreference
[read-only] Since : | CS5 |
Guide preference settings.
public function get guidePreferences():GuidePreference
guides | property |
guides:Guides
[read-only] Since : | CS5 |
A collection of guides.
public function get guides():Guides
hyperlinkExternalPageDestinations | property |
hyperlinkExternalPageDestinations:HyperlinkExternalPageDestinations
[read-only] Since : | CS5 |
A collection of hyperlink external page destinations.
public function get hyperlinkExternalPageDestinations():HyperlinkExternalPageDestinations
hyperlinkPageItemSources | property |
hyperlinkPageItemSources:HyperlinkPageItemSources
[read-only] Since : | CS5 |
A collection of hyperlink page item sources.
public function get hyperlinkPageItemSources():HyperlinkPageItemSources
hyperlinks | property |
hyperlinks:Hyperlinks
[read-only] Since : | CS5 |
A collection of hyperlinks.
public function get hyperlinks():Hyperlinks
hyperlinkTextDestinations | property |
hyperlinkTextDestinations:HyperlinkTextDestinations
[read-only] Since : | CS5 |
A collection of hyperlink text destinations.
public function get hyperlinkTextDestinations():HyperlinkTextDestinations
hyperlinkTextSources | property |
hyperlinkTextSources:HyperlinkTextSources
[read-only] Since : | CS5 |
A collection of hyperlink text sources.
public function get hyperlinkTextSources():HyperlinkTextSources
hyperlinkURLDestinations | property |
hyperlinkURLDestinations:HyperlinkURLDestinations
[read-only] Since : | CS5 |
A collection of hyperlink URL destinations.
public function get hyperlinkURLDestinations():HyperlinkURLDestinations
hyphenationExceptions | property |
hyphenationExceptions:HyphenationExceptions
[read-only] Since : | CS5 |
A collection of hyphenation exceptions lists.
public function get hyphenationExceptions():HyphenationExceptions
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Document.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Document within its containing object.
public function get index():Number
indexingSortOptions | property |
indexingSortOptions:IndexingSortOptions
[read-only] Since : | CS5 |
A collection of indexing sort options.
public function get indexingSortOptions():IndexingSortOptions
inks | property |
inks:Inks
[read-only] Since : | CS5 |
A collection of inks.
public function get inks():Inks
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
kinsokuTables | property |
kinsokuTables:KinsokuTables
[read-only] Since : | CS5 |
A collection of kinsoku tables.
public function get kinsokuTables():KinsokuTables
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
languages | property |
languages:Languages
[read-only] Since : | CS5 |
A collection of languages.
public function get languages():Languages
layers | property |
layers:Layers
[read-only] Since : | CS5 |
A collection of layers.
public function get layers():Layers
links | property |
links:Links
[read-only] Since : | CS5 |
A collection of links.
public function get links():Links
marginPreferences | property |
marginPreferences:MarginPreference
[read-only] Since : | CS5 |
Margin preference settings.
public function get marginPreferences():MarginPreference
masterSpreads | property |
masterSpreads:MasterSpreads
[read-only] Since : | CS5 |
A collection of master spreads.
public function get masterSpreads():MasterSpreads
metadataPreferences | property |
metadataPreferences:MetadataPreference
[read-only] Since : | CS5 |
Metadata preference settings.
public function get metadataPreferences():MetadataPreference
mixedInkGroups | property |
mixedInkGroups:MixedInkGroups
[read-only] Since : | CS5 |
A collection of mixed ink groups.
public function get mixedInkGroups():MixedInkGroups
mixedInks | property |
mixedInks:MixedInks
[read-only] Since : | CS5 |
A collection of mixed inks.
public function get mixedInks():MixedInks
modified | property |
modified:Boolean
[read-only] Since : | CS5 |
If true, the Document has been modified since it was last saved.
public function get modified():Boolean
mojikumiTables | property |
mojikumiTables:MojikumiTables
[read-only] Since : | CS5 |
A collection of mojikumi tables.
public function get mojikumiTables():MojikumiTables
mojikumiUIPreferences | property |
mojikumiUIPreferences:MojikumiUiPreference
[read-only] Since : | CS5 |
Mojikumi user interface preference settings.
public function get mojikumiUIPreferences():MojikumiUiPreference
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Document.
public function get name():String
numberingLists | property |
numberingLists:NumberingLists
[read-only] Since : | CS5 |
A collection of numbered lists.
public function get numberingLists():NumberingLists
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
pageItemDefaults | property |
pageItemDefaults:PageItemDefault
[read-only] Since : | CS5 |
The default page item formatting for the Document.
public function get pageItemDefaults():PageItemDefault
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
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.
public function get pageItems():PageItems
pages | property |
pages:Pages
[read-only] Since : | CS5 |
A collection of pages.
public function get pages():Pages
paragraphDestinations | property |
paragraphDestinations:ParagraphDestinations
[read-only] Since : | CS5 |
A collection of paragraph destinations.
public function get paragraphDestinations():ParagraphDestinations
paragraphStyleGroups | property |
paragraphStyleGroups:ParagraphStyleGroups
[read-only] Since : | CS5 |
A collection of paragraph style groups.
public function get paragraphStyleGroups():ParagraphStyleGroups
paragraphStyles | property |
paragraphStyles:ParagraphStyles
[read-only] Since : | CS5 |
A collection of paragraph styles.
public function get paragraphStyles():ParagraphStyles
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the Document (a Application).
public function get parent():Application
pasteboardPreferences | property |
pasteboardPreferences:PasteboardPreference
[read-only] Since : | CS5 |
Pasteboard preference settings.
public function get pasteboardPreferences():PasteboardPreference
placeGuns | property |
placeGuns:PlaceGun
[read-only] Since : | CS5 |
The place gun.
public function get placeGuns():PlaceGun
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
readOnly | property |
readOnly:Boolean
[read-only] Since : | CS5 |
If true, the Document is read-only.
public function get readOnly():Boolean
recovered | property |
recovered:Boolean
[read-only] Since : | CS5 |
If true, the Document was recovered.
public function get recovered():Boolean
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
redoHistory | property |
redoHistory:Object
[read-only] Since : | CS5 |
The names of the items in the redo stack.
public function get redoHistory():Object
redoName | property |
redoName:String
[read-only] Since : | CS5 |
The name of the action on the top of the redo stack.
public function get redoName():String
saved | property |
saved:Boolean
[read-only] Since : | CS5 |
If true, the Document has been saved since it was created.
public function get saved():Boolean
sections | property |
sections:Sections
[read-only] Since : | CS5 |
A collection of sections.
public function get sections():Sections
selection | property |
selection:Object
Since : | CS5 |
The selected object(s). Can also accept: Object or NothingEnum enumerator.
public function get selection():Object
public function set selection(value:Object):void
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
spreads | property |
spreads:Spreads
[read-only] Since : | CS5 |
A collection of spreads.
public function get spreads():Spreads
stories | property |
stories:Stories
[read-only] Since : | CS5 |
A collection of stories.
public function get stories():Stories
storyPreferences | property |
storyPreferences:StoryPreference
[read-only] Since : | CS5 |
Story preference settings.
public function get storyPreferences():StoryPreference
strokeStyles | property |
strokeStyles:StrokeStyles
[read-only] Since : | CS5 |
A collection of stroke styles.
public function get strokeStyles():StrokeStyles
swatches | property |
swatches:Swatches
[read-only] Since : | CS5 |
A collection of swatches.
public function get swatches():Swatches
tableStyleGroups | property |
tableStyleGroups:TableStyleGroups
[read-only] Since : | CS5 |
A collection of table style groups.
public function get tableStyleGroups():TableStyleGroups
tableStyles | property |
tableStyles:TableStyles
[read-only] Since : | CS5 |
A collection of table styles.
public function get tableStyles():TableStyles
textDefaults | property |
textDefaults:TextDefault
[read-only] Since : | CS5 |
Text default settings.
public function get textDefaults():TextDefault
textFramePreferences | property |
textFramePreferences:TextFramePreference
[read-only] Since : | CS5 |
Text frame preference settings.
public function get textFramePreferences():TextFramePreference
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
textPreferences | property |
textPreferences:TextPreference
[read-only] Since : | CS5 |
Text preference settings.
public function get textPreferences():TextPreference
textVariables | property |
textVariables:TextVariables
[read-only] Since : | CS5 |
A collection of text variables.
public function get textVariables():TextVariables
textWrapPreferences | property |
textWrapPreferences:TextWrapPreference
[read-only] Since : | CS5 |
The text wrap preference properties that define the default formatting for wrapping text around objects.
public function get textWrapPreferences():TextWrapPreference
tints | property |
tints:Tints
[read-only] Since : | CS5 |
A collection of tints.
public function get tints():Tints
trapPresets | property |
trapPresets:TrapPresets
[read-only] Since : | CS5 |
A collection of trap presets.
public function get trapPresets():TrapPresets
undoHistory | property |
undoHistory:Object
[read-only] Since : | CS5 |
The names of the items in the undo stack.
public function get undoHistory():Object
undoName | property |
undoName:String
[read-only] Since : | CS5 |
The name of the action on the top of the undo stack.
public function get undoName():String
unusedSwatches | property |
unusedSwatches:Object
[read-only] Since : | CS5 |
The swatches that are not being used.
public function get unusedSwatches():Object
validationErrors | property |
validationErrors:ValidationErrors
[read-only] Since : | CS5 |
A collection of XML validation errors.
public function get validationErrors():ValidationErrors
versionState | property |
versionState:VersionState
[read-only] Since : | CS5 |
The Version Cue version state of the file.
public function get versionState():VersionState
viewPreferences | property |
viewPreferences:ViewPreference
[read-only] Since : | CS5 |
View preference settings.
public function get viewPreferences():ViewPreference
visible | property |
visible:Boolean
[read-only] Since : | CS5 |
If true, the Document is visible.
public function get visible():Boolean
windows | property |
windows:Windows
[read-only] Since : | CS5 |
A collection of windows.
public function get windows():Windows
xmlComments | property |
xmlComments:XMLComments
[read-only] Since : | CS5 |
A collection of XML comments.
public function get xmlComments():XMLComments
xmlElements | property |
xmlElements:XMLElements
[read-only] Since : | CS5 |
A collection of XML elements.
public function get xmlElements():XMLElements
xmlExportMaps | property |
xmlExportMaps:XMLExportMaps
[read-only] Since : | CS5 |
A collection of XML export maps.
public function get xmlExportMaps():XMLExportMaps
xmlExportPreferences | property |
xmlExportPreferences:XMLExportPreference
[read-only] Since : | CS5 |
XML export preference settings.
public function get xmlExportPreferences():XMLExportPreference
xmlImportMaps | property |
xmlImportMaps:XMLImportMaps
[read-only] Since : | CS5 |
A collection of XML import maps.
public function get xmlImportMaps():XMLImportMaps
xmlImportPreferences | property |
xmlImportPreferences:XMLImportPreference
[read-only] Since : | CS5 |
XML import preference settings.
public function get xmlImportPreferences():XMLImportPreference
xmlInstructions | property |
xmlInstructions:XMLInstructions
[read-only] Since : | CS5 |
A collection of XML instructions.
public function get xmlInstructions():XMLInstructions
xmlItems | property |
xmlItems:XMLItems
[read-only] Since : | CS5 |
A collection of XML items.
public function get xmlItems():XMLItems
xmlPreferences | property |
xmlPreferences:XMLPreference
[read-only] Since : | CS5 |
The XML preference settings.
public function get xmlPreferences():XMLPreference
xmlStories | property |
xmlStories:XmlStories
[read-only] Since : | CS5 |
A collection of xml stories.
public function get xmlStories():XmlStories
xmlTags | property |
xmlTags:XMLTags
[read-only] Since : | CS5 |
A collection of XML tags.
public function get xmlTags():XMLTags
xmlViewPreferences | property |
xmlViewPreferences:XMLViewPreference
[read-only] Since : | CS5 |
XML view preference settings.
public function get xmlViewPreferences():XMLViewPreference
addEventListenerDocument | () | method |
public function addEventListenerDocument(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
changeComposer | () | method |
public function changeComposer():void
Since : | CS5 |
Change comoser to optyca
changeGlyph | () | method |
public function changeGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeGrep | () | method |
public function changeGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeObject | () | method |
public function changeObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value and replace the objects with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeText | () | method |
public function changeText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeTransliterate | () | method |
public function changeTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value and replaces the text with the change character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
checkIn | () | method |
public function checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Check in to Version Cue.
Parameters
versionCommentsParam:String (default = null ) — (String) The comment for this version (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) Forcibly save a version (Optional)
|
close | () | method |
public function close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Close the Document
Parameters
savingParam:SaveOptions (default = null ) — (SaveOptions) Whether to save changes before closing the Document (Optional)
| |
savingInParam:File (default = null ) — (File) The file in which to save the Document (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) Forcibly save a version (Optional)
|
deleteUnusedTags | () | method |
public function deleteUnusedTags():void
Since : | CS5 |
Deletes unused XML markup tags.
exportFile | () | method |
public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Exports the object(s) to a file.
Parameters
formatParam:Object (default = null ) — (Object) 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.
| |
toParam:File (default = null ) — (File) The path to the export file.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) If true, displays the export options dialog. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
findGlyph | () | method |
public function findGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findGrep | () | method |
public function findGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findObject | () | method |
public function findObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findText | () | method |
public function findText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findTransliterate | () | method |
public function findTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
importAdobeSwatchbookProcessColor | () | method |
public function importAdobeSwatchbookProcessColor(nameParam:String = null):Color
Since : | CS5 |
Imports a process color swatch from a preloaded Adobe color book.
Parameters
nameParam:String (default = null ) — (String) The process color to load.
|
Color |
importAdobeSwatchbookSpotColor | () | method |
public function importAdobeSwatchbookSpotColor(nameParam:String = null):Color
Since : | CS5 |
Imports a spot color swatch from an Adobe color book.
Parameters
nameParam:String (default = null ) — (String) The spot color to load.
|
Color |
importDtd | () | method |
public function importDtd(fromParam:File = null):void
Since : | CS5 |
Imports a DTD to use for validation.
Parameters
fromParam:File (default = null ) — (File) The path to the DTD file.
|
importFormats | () | method |
public function importFormats(fromParam:File = null):void
Since : | CS5 |
Imports the cross reference formats from specified file.
Parameters
fromParam:File (default = null ) — (File) The file whose formats to import.
|
importStyles | () | method |
public function importStyles(formatParam:ImportFormat = null, fromParam:File = null, globalStrategyParam:GlobalClashResolutionStrategy = null):void
Since : | CS5 |
Imports the specified styles.
Parameters
formatParam:ImportFormat (default = null ) — (ImportFormat) The types of styles to import.
| |
fromParam:File (default = null ) — (File) The file containing the styles you want to import.
| |
globalStrategyParam:GlobalClashResolutionStrategy (default = null ) — (GlobalClashResolutionStrategy) The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional)
|
importXML | () | method |
public function importXML(fromParam:File = null):void
Since : | CS5 |
Imports the specified XML file into an InDesign document.
Parameters
fromParam:File (default = null ) — (File) The XML file.
|
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
loadConditions | () | method |
public function loadConditions(fromParam:File = null, loadConditionSetsParam:Boolean):void
Since : | CS5 |
Load conditions from the specified file.
Parameters
fromParam:File (default = null ) — (File) The path to the file that contains the conditions.
| |
loadConditionSetsParam:Boolean (default = NaN ) — (Boolean) If true, load the condition sets as well. (Optional)
|
loadMasters | () | method |
public function loadMasters(fromParam:File = null, globalStrategyForMasterPageParam:GlobalClashResolutionStrategyForMasterPage = null):void
Since : | CS5 |
Load masterpages from an InDesign file.
Parameters
fromParam:File (default = null ) — (File) The InDesign file to load the masters from.
| |
globalStrategyForMasterPageParam:GlobalClashResolutionStrategyForMasterPage (default = null ) — (GlobalClashResolutionStrategyForMasterPage) the global clash resolution strategy for load master page (Optional)
|
loadSwatches | () | method |
public function loadSwatches(fromParam:File = null):void
Since : | CS5 |
Load swatches from the specified file.
Parameters
fromParam:File (default = null ) — (File) The swatch file or InDesign document.
|
loadXMLTags | () | method |
public function loadXMLTags(fromParam:File = null):void
Since : | CS5 |
Loads a set of XML markup tags from the specified file.
Parameters
fromParam:File (default = null ) — (File) The path to the file that contains the tags.
|
mapStylesToXMLTags | () | method |
public function mapStylesToXMLTags():void
Since : | CS5 |
Auto tag the document based on the style to tag mappings
mapXMLTagsToStyles | () | method |
public function mapXMLTagsToStyles():void
Since : | CS5 |
Auto style the document based on the tag to style mappings
placeBuzzword | () | method |
public function placeBuzzword(fileurlsParam:String = null, showingOptionsParam:Boolean = false, createLinkParam:Boolean = false, replaceSelectedParam:Boolean = true, applyGridParam:Boolean = false):void
Since : | CS5 |
Place the Buzzword document.
Parameters
fileurlsParam:String (default = null ) — (String) Url strings to the buzzword files seperated by space.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Whether to display the import options dialog. (Optional)
| |
createLinkParam:Boolean (default = false ) — (Boolean) Whether to create a link for the placed file. (Optional)
| |
replaceSelectedParam:Boolean (default = true ) — (Boolean) Whether to replace the selected item. (Optional)
| |
applyGridParam:Boolean (default = false ) — (Boolean) Whether to apply grid format for placed story. (Optional)
|
() | method |
public function print(printDialogParam:Boolean):void
Since : | CS5 |
Prints the Document(s).
Parameters
printDialogParam:Boolean (default = NaN ) — (Boolean) Whether to invoke the print dialog (Optional)
|
recompose | () | method |
public function recompose():void
Since : | CS5 |
Recomposes the text in the Document.
redo | () | method |
public function redo():void
Since : | CS5 |
Redoes the last action.
removeEventListenerDocument | () | method |
public function removeEventListenerDocument(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
revert | () | method |
public function revert():Boolean
Since : | CS5 |
Reverts the document to its state at the last save operation.
ReturnsBoolean |
revertToProject | () | method |
public function revertToProject(forceRevertParam:Boolean = false):void
Since : | CS5 |
Reverts to the version of the document in Version Cue.
Parameters
forceRevertParam:Boolean (default = false ) — (Boolean) Forcibly reverts to the project version. (Optional)
|
save | () | method |
public function save(toParam:File = null, fileTypeParam:SaveFileType = null):Document
Since : | CS5 |
Saves the document.
Parameters
toParam:File (default = null ) — (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)
| |
fileTypeParam:SaveFileType (default = null ) — (SaveFileType) The file type. (Optional)
|
Document |
saveACopy | () | method |
public function saveACopy(toParam:File = null, fileTypeParam:SaveFileType = null):void
Since : | CS5 |
Save a copy of the document
Parameters
toParam:File (default = null ) — (File) The path for the copy. Note: Leaves the original document open and does not open the copy. (Optional)
| |
fileTypeParam:SaveFileType (default = null ) — (SaveFileType) The file type. (Optional)
|
saveSwatches | () | method |
public function saveSwatches(toParam:File = null, swatchListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Saves the specified swatch(es) to a swatchbook file.
Parameters
toParam:File (default = null ) — (File) The swatchbook file to save to.
| |
swatchListParam:Array (default = null ) — (Array) The swatch(es) to save.
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
saveXMLTags | () | method |
public function saveXMLTags(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Saves a set of tags to an external file.
Parameters
toParam:File (default = null ) — (File) The full path to the file in which to save the tags.
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
select | () | method |
public function select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
Selects the specified object(s).
Parameters
selectableItemsParam:Object (default = null ) — (Object) The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
| |
existingSelectionParam:SelectionOptions (default = null ) — (SelectionOptions) The selection status of the Document in relation to previously selected objects. (Optional)
|
synchronizeWithVersionCue | () | method |
public function synchronizeWithVersionCue(syncConflictResolutionParam:SyncConflictResolution = null, versionCommentsParam:String = null):VersionCueSyncStatus
Since : | CS5 |
Synchronizes the file with the Version Cue project.
Parameters
syncConflictResolutionParam:SyncConflictResolution (default = null ) — (SyncConflictResolution) The conflict resolution method to use during synchronization. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comments that describe the version. (Optional)
|
VersionCueSyncStatus |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
undo | () | method |
public function undo():void
Since : | CS5 |
Undoes the last action.
updateCrossReferences | () | method |
public function updateCrossReferences():void
Since : | CS5 |
Updates cross references' text source content in the document.