Acrobat and PDFL Developer Guides

Acrobat-PDFL SDK: JavaScript Reference

Acrobat JavaScript API Reference
Changes Across Versions
JavaScript APIs
- Alerter
  - Alerter methods
    - dispatch
- AlternatePresentation
  - AlternatePresentation properties
    - active
    - type
  - AlternatePresentation methods
    - start
    - stop
- annotAttachment
  - annotAttachment properties
    - contentStream
    - creationDate
    - MIMEtype
    - modDate
    - name
    - pathname
    - size
- Annotation
  - Annotation types
  - Annotation properties
    - alignment
    - attachment
    - AP
    - arrowBegin
    - arrowEnd
    - attachIcon
    - author
    - borderEffectIntensity
    - borderEffectStyle
    - callout
    - cAttachmentPath
    - caretSymbol
    - contents
    - creationDate
    - dash
    - delay
    - doc
    - doCaption
    - fillColor
    - gestures
    - hidden
    - inReplyTo
    - intent
    - leaderExtend
    - leaderLength
    - lineEnding
    - lock
    - modDate
    - name
    - noteIcon
    - noView
    - opacity
    - overlayText
    - page
    - point
    - points
    - popupOpen
    - popupRect
    - print
    - quads
    - rect
    - readOnly
    - refType
    - repeat
    - richContents
    - richDefaults
    - rotate
    - seqNum
    - soundIcon
    - state
    - stateModel
    - strokeColor
    - style
    - subject
    - textFont
    - textSize
    - toggleNoView
    - type
    - vertices
    - width
  - Annotation methods
- AnnotRichMedia
  - AnnotRichMedia properties
    - activated
    - context3D
    - name
    - page
    - rect
    - subtype
  - AnnotRichMedia methods
    - callAS
- Annot3D
  - Annot3D properties
    - activated
    - context3D
    - innerRect
    - name
    - page
    - rect
- app
  - app properties
  - app methods
    - addMenuItem
    - addSubMenu
    - addToolButton
    - alert
    - beep
    - beginPriv
    - browseForDoc
    - clearInterval
    - clearTimeOut
    - endPriv
    - execDialog
    - execMenuItem
    - getNthPlugInName
    - getPath
    - goBack
    - goForward
    - hideMenuItem
    - hideToolbarButton
    - launchURL
    - listMenuItems
    - listToolbarButtons
    - loadPolicyFile
    - mailGetAddrs
    - mailMsg
    - newDoc
    - newCollection
    - newFDF
    - openDoc
    - openFDF
    - popUpMenu
    - popUpMenuEx
    - removeToolButton
    - response
    - setInterval
    - setTimeOut
    - trustedFunction
    - trustPropagatorFunction
- app.media
  - app.media properties
    - align
    - canResize
    - closeReason
    - defaultVisible
    - ifOffScreen
    - layout
    - monitorType
    - openCode
    - over
    - pageEventNames
    - raiseCode
    - raiseSystem
    - renditionType
    - status
    - trace
    - version
    - windowType
  - app.media methods
- Bookmark
  - Bookmark properties
    - children
    - color
    - doc
    - name
    - open
    - parent
    - style
  - Bookmark methods
    - createChild
    - execute
    - insertChild
    - remove
    - setAction
- catalog
  - catalog properties
    - isIdle
    - jobs
  - catalog methods
    - getIndex
    - remove
- CatalogJob
  - CatalogJob properties
    - path
    - type
    - status
- Certificate
  - Certificate properties
- Collab
  - Collab methods
- color
- colorConvertAction
  - colorConvertAction properties
- Collection
  - Collection properties
  - Collection methods
- collectionField
  - collectionField properties
    - name
    - order
    - readOnly
    - sort
    - text
    - type
- Column
  - Column properties
    - columnNum
    - name
    - type
    - typeName
    - value
- ColumnInfo
  - ColumnInfo properties
    - name
    - description
    - type
    - typeName
- console
  - console methods
    - clear
    - hide
    - println
    - show
- Data
  - Data properties
    - creationDate
    - description
    - MIMEType
    - modDate
    - name
    - path
    - size
  - Data methods
    - getFieldValue
    - setFieldValue
- DataSourceInfo
  - DataSourceInfo properties
    - name
    - description
- dbg
  - dbg properties
    - bps
  - dbg methods
    - c
    - cb
    - q
    - sb
    - si
    - sn
    - so
    - sv
- Dialog
  - Dialog methods
    - enable
    - end
    - load
    - store
- DirConnection
  - DirConnection properties
  - DirConnection methods
    - search
    - setOutputFields
- Directory
  - Directory properties
    - info
  - Directory methods
    - connect
- Embedded PDF
  - Embedded PDF properties
    - messageHandler
  - Embedded PDF methods
    - postMessage
- Error
  - Error properties
    - fileName
    - lineNumber
    - extMessage
    - message
    - name
  - Error methods
    - toString
- event
- EventListener
  - EventListener methods
    - afterBlur
    - afterClose
    - afterDestroy
    - afterDone
    - afterError
    - afterEscape
    - afterEveryEvent
    - afterFocus
    - afterPause
    - afterPlay
    - afterReady
    - afterScript
    - afterSeek
    - afterStatus
    - afterStop
    - onBlur
    - onClose
    - onDestroy
    - onDone
    - onError
    - onEveryEvent
    - onGetRect
    - onPause
    - onPlay
    - onReady
    - onScript
    - onSeek
    - onStatus
    - onStop
- Events
  - Events methods
    - add
    - dispatch
    - remove
- FDF
  - FDF properties
  - FDF methods
- Field
- FullScreen
  - FullScreen properties
- global
- HostContainer
  - HostContainer properties
    - messageHandler
  - HostContainer methods
    - postMessage
- Icon
- Icon Stream
- identity
  - identity properties
    - corporation
    - email
    - loginName
    - name
- Index
  - Index properties
    - available
    - name
    - path
    - selected
  - Index methods
    - build
- Link
  - Link properties
  - Link methods
    - setAction
- Monitor
  - Monitor properties
    - colorDepth
    - isPrimary
    - rect
    - workRect
- Monitors
  - Monitors methods
    - bestColor
    - bestFit
    - desktop
    - document
    - filter
    - largest
    - leastOverlap
    - mostOverlap
    - nonDocument
    - primary
    - secondary
    - select
    - tallest
    - widest
- Net
  - Net properties
    - SOAP
    - Discovery
    - HTTP
  - Net methods
- Net.HTTP
  - Net.HTTP methods
    - request
- OCG
  - OCG properties
    - constants
    - initState
    - locked
    - name
    - state
  - OCG methods
  - PlayerInfo properties
    - id
    - mimeTypes
    - name
    - version
  - PlayerInfo methods
- PlayerInfoList
  - PlayerInfoList methods
    - select
- PlugIn
  - PlugIn properties
    - certified
    - loaded
    - name
    - path
    - version
- PrintParams
  - PrintParams properties
    - binaryOK
    - bitmapDPI
    - booklet
    - colorProfile
    - constants
    - downloadFarEastFonts
    - DuplexType
    - fileName
    - firstPage
    - flags
    - fontPolicy
    - gradientDPI
    - interactive
    - lastPage
    - nUpAutoRotate
    - nUpNumPagesH
    - nUpNumPagesV
    - nUpPageBorder
    - nUpPageOrder
    - NumCopies
    - pageHandling
    - pageSubset
    - printAsImage
    - printContent
    - printRange
    - printerName
    - psLevel
    - rasterFlags
    - reversePages
    - tileLabel
    - tileMark
    - tileOverlap
    - tileScale
    - transparencyLevel
    - usePrinterCRD
    - useT1Conversion
- RDN
- ReadStream
- Rendition
  - Rendition properties
    - altText
    - doc
    - fileName
    - type
    - uiName
  - Rendition methods
- Report
  - Report properties
    - absIndent
    - color
    - size
    - style
  - Report methods
    - breakPage
    - divide
    - indent
    - mail
    - open
    - outdent
    - Report
    - save
    - writeText
- Row
- ScreenAnnot
  - ScreenAnnot properties
    - altText
    - alwaysShowFocus
    - display
    - doc
    - events
    - extFocusRect
    - innerDeviceRect
    - noTrigger
    - outerDeviceRect
    - page
    - player
    - rect
  - ScreenAnnot methods
    - hasFocus
    - setFocus
- search
  - search properties
    - attachments
    - available
    - bookmarks
    - docInfo
    - docText
    - docXMP
    - ignoreAccents
    - ignoreAsianCharacterWidth
    - indexes
    - jpegExif
    - legacySearch
    - markup
    - matchCase
    - matchWholeWord
    - maxDocs
    - objectMetadata
    - proximity
    - proximityRange
    - refine
    - stem
    - wordMatching
  - search methods
- security
- SecurityHandler
  - SecurityHandler properties
    - appearances
    - digitalIDs
    - directories
    - directoryHandlers
    - docDecrypt
    - docEncrypt
    - isLoggedIn
    - loginName
    - loginPath
    - name
    - signAuthor
    - signFDF
    - signInvisible
    - signValidate
    - signVisible
    - uiName
    - validateFDF
  - SecurityHandler methods
- SecurityPolicy
  - SecurityPolicy properties
- SignatureInfo
  - SignatureInfo properties
- SOAP
  - SOAP properties
    - wireDump
  - SOAP methods
- Sound
  - Sound properties
    - name
  - Sound methods
    - pause
    - play
    - stop
- Span
  - Span properties
    - alignment
    - fontFamily
    - fontStretch
    - fontStyle
    - fontWeight
    - strikethrough
    - subscript
    - superscript
    - text
    - textColor
    - textSize
    - underline
- spell
  - spell properties
  - spell methods
- TableInfo
- Template
  - Template properties
    - hidden
    - name
  - Template methods
    - spawn
- Thermometer
  - Thermometer properties
    - cancelled
    - duration
    - text
    - value
  - Thermometer methods
    - begin
    - end
- this
- TTS
  - TTS properties
    - available
    - numSpeakers
    - pitch
    - soundCues
    - speaker
    - speechCues
    - speechRate
    - volume
  - TTS methods
    - getNthSpeakerName
    - pause
    - qSilence
    - qSound
    - qText
    - reset
    - resume
    - stop
    - talk
- util
  - util methods
- XFA
- XMLData
  - XMLData methods
    - applyXPath
    - parse
Doc and Doc.Media APIs
- Doc
  - Doc properties
    - alternatePresentations
    - author
    - baseURL
    - bookmarkRoot
    - calculate
    - collection
    - creationDate
    - creator
    - dataObjects
    - delay
    - dirty
    - disclosed
    - docID
    - documentFileName
    - dynamicXFAForm
    - external
    - filesize
    - hidden
    - hostContainer
    - icons
    - info
    - innerAppWindowRect
    - innerDocWindowRect
    - isModal
    - keywords
    - layout
    - media
    - metadata
    - modDate
    - mouseX
    - mouseY
    - noautocomplete
    - numFields
    - numPages
    - numTemplates
    - path
    - outerAppWindowRect
    - outerDocWindowRect
    - pageNum
    - pageWindowRect
    - permStatusReady
    - producer
    - requiresFullSave
    - securityHandler
    - selectedAnnots
    - sounds
    - spellDictionaryOrder
    - spellLanguageOrder
    - subject
    - templates
    - title
    - URL
    - viewState
    - xfa
    - XFAForeground
    - zoom
    - zoomType
  - Doc methods
- Doc.media
  - Doc.media properties
    - canPlay
  - Doc.media methods
Preflight APIs
Media and Marker APIs
- Marker
  - Marker properties
    - frame
    - index
    - name
    - time
- Markers
  - Markers properties
    - player
  - Markers methods
    - get
- MediaOffset
  - MediaOffset properties
    - frame
    - marker
    - time
- MediaPlayer
  - MediaPlayer properties
    - annot
    - defaultSize
    - doc
    - events
    - hasFocus
    - id
    - innerRect
    - isOpen
    - isPlaying
    - markers
    - outerRect
    - page
    - settings
    - uiSize
    - visible
  - MediaPlayer methods
    - close
    - open
    - pause
    - play
    - seek
    - setFocus
    - stop
    - triggerGetRect
    - where
- MediaReject
  - MediaReject properties
    - rendition
- MediaSelection
  - MediaSelection properties
- MediaSettings
  - MediaSettings properties
    - autoPlay
    - baseURL
    - bgColor
    - bgOpacity
    - data
    - duration
    - endAt
    - floating
    - layout
    - monitor
    - monitorType
    - page
    - palindrome
    - players
    - rate
    - repeat
    - showUI
    - startAt
    - visible
    - volume
    - windowType
Master Doc Search and TOC

Acrobat Developer Home Document Services SDK Acrobat Sign SDK Acrobat SDK PDF Library SDK

Console

Acrobat-PDFL SDK: JavaScript Reference

»
Acrobat-PDFL SDK: JavaScript APIs

Acrobat-PDFL SDK: JavaScript APIs¶