Indesign Scripting Reference

ZoomOptions (Enum)

admin — Tue, 21 Dec 2010 19:10:35 +0000

Display size options.

Name	Description	Value
ZOOM_IN	Magnifies the view to the next preset percentage.	2053990766 = ‘zmin’
ZOOM_OUT	Reduces the view to the next preset percentage.	2054124916 = ‘zout’
FIT_SPREAD	Centers the active spread in the window.	2053534835 = ‘zfts’
FIT_PAGE	Centers the active page in the window.	2053534832 = ‘zftp’
SHOW_PASTEBOARD	Fits the entire pasteboard in the window.	2054385762 = ‘zspb’
ACTUAL_SIZE	Zooms to 100%.	2053206906 = ‘zasz’

Usage:

In function:
- void LayoutWindow.zoom (
  given:
  ZoomOptions
  )

XMLTransformFile (Enum)

admin — Tue, 21 Dec 2010 19:10:34 +0000

File used for XML transformation.

Name	Description	Value
STYLESHEET_IN_XML	Use stylesheet specified in XML	1483961208 = ‘Xssx’

XMLImportStyles (Enum)

admin — Tue, 21 Dec 2010 19:10:33 +0000

Options for incorporating imported XML content.

Name	Description	Value
APPEND_IMPORT	Appends the imported content.	1481466217 = ‘XMai’
MERGE_IMPORT	Merges the imported content.	1481469289 = ‘XMmi’

Usage:

As property:
- XMLImportPreference.importStyle

XMLFileEncoding (Enum)

admin — Tue, 21 Dec 2010 19:10:32 +0000

File encoding options for exported XML content.

Name	Description	Value
UTF8	UTF-8 encoding.	1937134904 = ‘svU8′
UTF16	UTF-16 encoding.	1937125686 = ‘sv16′
SHIFT_JIS	Shift-JIS encoding.	1249077875 = ‘Jsjs’

Usage:

As property:
- XMLExportPreference.fileEncoding

XMLExportUntaggedTablesFormat (Enum)

admin — Tue, 21 Dec 2010 19:10:31 +0000

Export options for untagged tables in tagged stories.

Name	Description	Value
NONE	Does not export untagged tables.	1852796517 = ‘none’
CALS	Exports untagged tables as CALS XML.	1484022643 = ‘Xtcs’

Usage:

As property:
- XMLExportPreference.exportUntaggedTablesFormat

XMLElementPosition (Enum)

admin — Tue, 21 Dec 2010 19:10:30 +0000

Options for specifying position relative to the reference XML element or withing the XML element.

Name	Description	Value
BEFORE_ELEMENT	Specifies the position before the XML element.	1482843494 = ‘Xbef’
AFTER_ELEMENT	Specifies the position after the XML element.	1482778228 = ‘Xaft’
ELEMENT_START	Specifies the position at the beginning of the XML element.	1482844014 = ‘Xbgn’
ELEMENT_END	Specifies the position at the end of the XML element.	1483042404 = ‘Xend’

Usage:

In function:
- Text XMLElement.insertTextAsContent (
  using:
  any, position:
  XMLElementPosition
  )

XMLElementLocation (Enum)

admin — Tue, 21 Dec 2010 19:10:28 +0000

Location options for XML elements.

Name	Description	Value
ELEMENT_START	Locates the element at the beginning of the containing object.	1482844014 = ‘Xbgn’
ELEMENT_END	Locates the element at the end of the containing object.	1483042404 = ‘Xend’

Usage:

In function:
- XMLElement XMLAttribute.convertToElement (
  [located:
  XMLElementLocation =ELEMENT_START ][, markupTag:
  XMLTag]
  )

WhenScalingOptions (Enum)

admin — Tue, 21 Dec 2010 19:10:27 +0000

Options for when scaling

Name	Description	Value
APPLY_TO_CONTENT	Apply scaling to the item’s content	1934192243 = ‘sIns’
ADJUST_SCALING_PERCENTAGE	Adjust the scaling percentage of the item’s transform	1934587252 = ‘sOut’

Usage:

As property:
- TransformPreference.whenScaling

VisibilityInPdf (Enum)

admin — Tue, 21 Dec 2010 19:10:26 +0000

The field’s visibility in the PDF document.

Name	Description	Value
VISIBLE_IN_PDF	The field is visible.	1180068211 = ‘FVis’
HIDDEN_IN_PDF	The field is not visible.	1181247844 = ‘Fhid’
VISIBLE_BUT_DOES_NOT_PRINT_IN_PDF	The field is visible when the PDF document is displayed on-screen but invisible when the document is printed.	1180061264 = ‘FVNP’
HIDDEN_BUT_PRINTABLE_IN_PDF	The field is invisible when the PDF document is displayed on-screen but visible when the document is printed.	1179140688 = ‘FHBP’

Usage:

As property:
- Button.visibilityInPdf
- FormField.visibilityInPdf

ViewZoomStyle (Enum)

admin — Tue, 21 Dec 2010 19:10:25 +0000

View zoom style options.

Name	Description	Value
FULL_SCREEN	Fills the screen with the page; hides the toolbar, command bar, menu bar, and window controls.	1987733107 = ‘vzfs’
ZOOM_IN	Magnifies the view to the next preset percentage.	2053990766 = ‘zmin’
ZOOM_OUT	Reduces the view to the previous preset percentage.	2054124916 = ‘zout’
FIT_PAGE	Fits the entire page in the window.	2053534832 = ‘zftp’
ACTUAL_SIZE	Displays the page at 100% magnification.	2053206906 = ‘zasz’
FIT_WIDTH	Fits the page to the width of the window; may obscure the lower portion of the page.	1212437335 = ‘HDSW’
FIT_VISIBLE	Fits the the text area of the page to the window width; obscures page margins and may obscure the lower portion of the page.	1212437334 = ‘HDSV’
REFLOW	Reflows the document to fit larger or smaller screens at the current magnification. Note: Reflows only readable text, including articles, paragraphs, tables, images, and formatted lists; does not include forms, comments, digital signature fields, and page artifacts such as page numbers, headers and footers.	1987736166 = ‘vzrf’
SINGLE_PAGE	Displays one page in the document pane at a time.	1987736432 = ‘vzsp’
ONE_COLUMN	Arranges the pages in a continuous vertical column that is one page wide.	1987735395 = ‘vzoc’
TWO_COLUMN	Arranges the pages side by side in a continuous vertical column that is two pages wide.	1987736675 = ‘vztc’
ROTATE_CW	Rotates the view 90 degrees clockwise.	1987736163 = ‘vzrc’
ROTATE_CCW	Rotates the view 90 degrees counterclockwise.	1987736183 = ‘vzrw’

Usage:

As property:
- ViewZoomBehavior.viewZoomStyle