Document Object Model - ViewPreferences

The document's ViewPreferences, which determine the way the user interacts with the editing portion of the document

Fields

Name	Type	Triggers	Description

Name	Type	Triggers	Description
measurementUnit	Units	MeasurementUnitsChanged	Measurement unit (mm, in, pt, ...) for the Editor interface
displayQuality	ImageDisplayQuality	DisplayQualityChanged	Image Display Quality
viewMode	ViewMode	ViewModeChanged	Document view mode
pageMode	PageFlowMode	PageModeChanged	Page flow mode
pageFlowColumns	string	PageModeChanged	Amount of columns for page flow
marginBetweenSpreads	bool	PageModeChanged	Show margin between spreads
showPageRulers	bool	PageRulerVisibilityChanged	Show the ruler bar around the document
showHelpLayers	bool	HelpLayerVisibilityChanged	Visibility for help layers
bgColor	uint	PageBackgroundColorChanged	Background color for pages
pageVisibilityMode	PageVisibility	PageVisibilityModeChanged	Page Visibility Mode
initialZoom	InitialZoom	ZoomSettingsChanged	Initial zoom when opening the document
minZoom	number	ZoomSettingsChanged	Minimum zoom level
maxZoom	number	ZoomSettingsChanged	Maximum zoom level
pageMarginsX	number	PageModeChanged	Horizontal margin between spreads
pageMarginsY	number	PageModeChanged	Vertical margin between spreads
bookViewShowTypeOverlays	bool	AdTypeOverlayViewerVisibilityChanged	Show ad information on top of ads in the Viewer
bookViewNavigation	BookNavigationMode	BookViewNavigationChanged	Navigation mode for the Viewer
bookViewCornerTease	bool	BookViewPreferencesChanged	Enable the corner tease (bottom left/right) when the user hovers over it with the mouse
bookViewHardCovers	bool	BookViewPreferencesChanged	Use hard covers in the Viewer
bookViewPageSlope	bool	BookViewPreferencesChanged	Page slope size for the Viewer
bookViewIncludeAnnotations	bool	BookViewPreferencesChanged	Show annotations in the Viewer
bookViewAllowEditAnnotations	bool	BookViewPreferencesChanged	Allow editing of annotations in the Viewer
bookViewTransitionActive	bool	BookViewPreferencesChanged	Enable transitions in the Viewer
bookViewTransitionInterval	number	BookViewPreferencesChanged	Interval in seconds between transitions
bookViewTransitionLoop	bool	BookViewPreferencesChanged	Loop slideshows in the Viewer
bookViewTransitionFinalURL	string	BookViewPreferencesChanged	Navigate to this URL when a slideshow ends in the Viewer
bookViewPortraitLayout	AlternateLayout	BookViewPreferencesChanged	Alternate Layout to use in the Viewer for portrait orientation
bookViewLandScapeLayout	AlternateLayout	BookViewPreferencesChanged	Alternate Layout to use in the Viewer for landscape orientation
showBookPageLabels	bool	BookViewPreferencesChanged	Show page labels in the Viewer
bookViewShowSpreads	bool	BookViewPreferencesChanged	Show pages in the Viewer as spreads
bookViewSpreadColFlow	string	BookViewPreferencesChanged	Column flow type for spreads in the Viewer
bookViewColumnWidth	int	BookViewPreferencesChanged	Width of columns in the Viewer
bookMarginsX	int	BookViewPreferencesChanged	Horizontal margin between pages in the Viewer
zoomShortCutIncrement	int		Zoom shortcut increment
bookMarginsY	int	BookViewPreferencesChanged	Vertical margin between pages in the viewer
showHelp	bool	WorkSpaceChanged	Show help buttons
showHiddenCharacters	bool	HiddenCharacterVisibilityChanged	Show hidden characters (space, return, tab, ...)
sourceView	bool	SourceViewChanged	Toggle viewing of variable data
mouseWheelZooms	bool		Enable zooming using the mouse wheel
replaceContentOnDrag	bool		Replace existing content when dragging from a Resource panel
rotateView	number	RotateViewChanged	Rotation for pages
wrapMargins	bool	WrapMarginVisibilityChanged	Show wrap margin guides
showTextColumns	bool	TextColumnGuideVisibilityChanged	Show text column guides
showMargins	bool	MarginVisibilityChanged	Show page margins
showBorders	bool	BorderVisibilityChanged	Show frame borders
bordersOnMouseOver	bool	BorderVisibilityChanged	Show frame borders when hovering over a frame
showInset	bool	BorderVisibilityChanged	Show frame inset guides
showSections	bool	SectionBreakVisibilityChanged	Show section markers
showBleed	bool	BleedVisibilityChanged	Include bleed in the document view
showSlug	bool	SlugVisibilityChanged	Show document slug guides
showGrid	bool	GridSettingsChanged	Show the grid
gridX	unit	GridSettingsChanged	Starting point for the grid
gridY	unit	GridSettingsChanged	Starting point for the grid
gridSize	unit	GridSettingsChanged	Dimensions of the grid
snapToGrid	bool	SnapSettingsChanged	Snap objects to grid
snapToObjects	bool	SnapSettingsChanged	Snap objects to the dimensions of other objects
snapSize	int	SnapSettingsChanged	Span size, in pixels
showMoveRegions	bool	MoveRegionVisibilityChanged	Highlight the allowed move region of the selected frame
showWarnings	bool	WarningVisibilityChanged	Show inline warnings
showChain	bool	ChainVisibilityChanged	Show text chain guides (linked stories)
showTabRuler	bool	TabRulerVisibilityChanged	Enable the tab ruler during text editing
useDefaultPlaceHolderText	bool		Use the standard 'lorem ipsum' placeholder text
customPlaceHolderText	string		Custom text for 'Fill with placeholder text' function
repeatCustomPlaceHolderText	bool		Repeat custom text when executing the 'Fill with placeholder text' function
fillNewTextFrames	bool