K4 InDesign Javascript API Documentation

PreferencesWatermarkPreference

Watermark preference

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the WatermarkPreference (a Document or Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
watermarkDoPrint bool Watermark do print for a document read-write
watermarkDrawInBack bool Watermark draw in back for a document read-write
watermarkFontColor Watermark font color for a document. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. read-write
watermarkFontFamily string Watermark font family display name read-write
watermarkFontPointSize number Watermark font point size for a document read-write
watermarkFontStyle string Watermark font style name read-write
watermarkHorizontalOffset Measurement Unit (Number or String)=any Watermark horizontal offset for a document read-write
watermarkHorizontalPosition WatermarkHorizontalPositionEnum Watermark horizontal position enum for a document read-write
watermarkOpacity number Watermark opacity (as a percentage). (Range: 0 to 100) read-write
watermarkRotation number Watermark rotation for a document read-write
watermarkText string Watermark text for a document read-write
watermarkVerticalOffset Measurement Unit (Number or String)=any Watermark vertical offset for a document read-write
watermarkVerticalPosition WatermarkVerticalPositionEnum Watermark vertical position enum for a document read-write
watermarkVisibility bool Watermark visibility for a document read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → WatermarkPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → WatermarkPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the WatermarkPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.