K4 InDesign Javascript API Documentation

PreflightPreflightProfile

A preflight profile.

Instance Properties

Name Description Access
description string The description of the PreflightProfile. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the PreflightProfile. read-only
index number The index of the PreflightProfile within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the PreflightProfile. read-write
parent The parent of the PreflightProfile (a Application or Document). read-only
preflightProfileRules PreflightProfileRules A collection of preflight profile rules. read-only
preflightRuleInstances PreflightRuleInstances A collection of preflight rule instances. read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → PreflightProfile
extractLabel(
key)
  → string
getElements(
)
  → PreflightProfile
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
save(
to)
toSource(
)
  → string
toSpecifier(
)
  → string
unembed(
)
update(
using)
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)
duplicate(
)
  → PreflightProfile
Duplicates the PreflightProfile.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → PreflightProfile
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the PreflightProfile.
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)
save(
to)
Saves this preflight profile to a InDesign preflight profile file.
to File The preflight profile file to save to.
toSource(
)
  → string
Generates a string which, if executed, will return the PreflightProfile.
toSpecifier(
)
  → string
Retrieves the object specifier.
unembed(
)
Unembed this profile.
update(
using)
Update the preflight profile by copying from another profile.
using The preflight profile to copy. Can accept: String or PreflightProfile. (Optional)