Scripting Guide for Studio for InDesign & InCopy

Application

Application methods

browseQuery
getDossiersForItem
getEntMetaData
jsonRequest
namedQuery
offlineQuery
openObject
openObjects
performSimpleRequest
queryObjects
sendObjectToNext
setEntMetaData
storedUserQuery
updateGeometry
updatePanels

Application properties

entSession
woodwingLogging
studioPreferences
studioPlugins

Document

Document properties

activeEdition
studioDocumentPreferences
defaultEditions
entMetaData
entWorkflow
managedAdverts
managedArticles
managedImages
managedLayoutModules

Dossier

Dossier methods

addItem
create
refresh
remove
removeItem
save

Dossier properties

entMetaData
items

Dossiers

Dossiers methods

add
count
retrieve

EntIssue

EntIssue properties

id
name

EntMetaData

EntMetaData methods

count
get
has
item
refresh
remove
set

EntMetaData properties

length

EntPublication

EntPublication properties

id
name

EntSection

EntSection properties

id
name

ManagedAdvert

ManagedAdvert properties

entMetaData
pageItem

ManagedAdverts

ManagedAdverts methods

count

ManagedArticle

ManagedArticle methods

abortCheckOut
checkIn
checkOut
create
detach
detachComponent
detachFrame
refresh
unplacedComponents

ManagedArticle properties

components
entMetaData

ManagedArticles

ManagedArticles methods

add
count

ManagedImage

ManagedImage methods

checkIn
checkOut
create

ManagedImage properties

entMetaData
pageItem

ManagedImages

ManagedImages methods

add
count

ManagedLayoutModule

ManagedLayoutModule properties

entMetaData
pageItem

ManagedLayoutModules

ManagedLayoutModules methods

count

PageItem

PageItem methods

replaceEnterpriseImage
placeObject
updateCaptionAndCredit

PageItem properties

frameData
allIndesignArticleIds
editions
elementLabel
managedAdvert
managedArticle
managedImage
managedLayoutModule

Session

Session methods

forkLogin
getCategories
getCategory
getIssue
getIssues
getPublication
getPublications
getServers
getTerm
getUserGroups
getUsers
login
logout
reLogin
quickLogin
getBrands
getBrand
getCurrentIssue
getPreviousIssue
getNextIssue
getSections
getSection

Session properties

activeServer
activeTicket
activeUrl
activeUser

StudioDocumentPreference

StudioDocumentPreference properties

applyObjectStyle

StudioPreference

StudioPreference properties

applyObjectStyle
autoAddPlacedAssetsImageToStudio
bringInCopyArticlesToFrontInLayoutView
displayLayoutNameInCreateArticle
documentPaneFontSize
dossierPanelShowRelatedDossiers
enableSmartCaching
playSoundWhenRoutingMessageArrives
previewPaneFontSize
showImportOptionsDialogOnPlace
showRoutingMessageAlert
updatePlacedImagesWhenOpeningLayout

Story

Story properties

managedArticle
textLock

StudioPlugins

StudioPlugins properties

version

PluginVersion

PluginVersion properties

major
minor
patch
build
release

Workflow

Workflow methods

abortCheckOut
checkIn
placeObject
restoreFromArchive
saveAs
saveVersion
replaceEnterpriseFile
setPdfProfile
updateAllContent

Workflow properties

defaultDossier
relations

Scripting Events

Overrule placement of Article and Dossiers
Overrule adding created images to a Dossier
Custom menu items

PageItem

Properties

allIndesignArticleIds
editions
elementLabel
frameData
managedAdvert
managedArticle
managedImage
managedLayoutModule

Methods

placeObject
replaceEnterpriseImage
updateCaptionAndCredit