InDesign Server2025
API 20.5.0.49
Collection of RuleDataObject

RuleDataObjects

A collection of prefight rule data objects.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

RuleDataObject

Returns the RuleDataObject with the specified index.

index Number The index.
RuleDataObject

Add a new preflight rule data to a preflight profile rule.

name String The name of the rule data to add
dataType RuleDataType The type of data
dataValue Boolean[] | Booleans[] | Booleans[] | LongInteger[] | LongIntegers[] | LongIntegers[] | Object[] | Objects[] | Real[] | Reals[] | Reals[] | ShortInteger[] | ShortIntegers[] | ShortIntegers[] | String[] | Strings[] | Arrays of Arrays of Strings[] | Objects[] The value of data. Can accept: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects.
withProperties? Object Initial values for properties of the new RuleDataObject
RuleDataObject

Returns any RuleDataObject in the collection.

Number

Displays the number of elements in the RuleDataObject.

RuleDataObject[]

Returns every RuleDataObject in the collection.

RuleDataObject

Returns the first RuleDataObject in the collection.

RuleDataObject

Returns the RuleDataObject with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
RuleDataObject

Returns the RuleDataObject with the specified ID.

id Number The ID.
RuleDataObject

Returns the RuleDataObject with the specified name.

name String The name.
RuleDataObject[]

Returns the RuleDataObjects within the specified range.

from LongInteger | RuleDataObject | String The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String.
to LongInteger | RuleDataObject | String The RuleDataObject, index, or name at the end of the range. Can accept: RuleDataObject, Long Integer or String.
RuleDataObject

Returns the last RuleDataObject in the collection.

RuleDataObject

Returns the middle RuleDataObject in the collection.

RuleDataObject

Returns the RuleDataObject whose index follows the specified RuleDataObject in the collection.

obj RuleDataObject The RuleDataObject whose index comes before the desired RuleDataObject.
RuleDataObject

Returns the RuleDataObject with the index previous to the specified index.

obj RuleDataObject The index of the RuleDataObject that follows the desired RuleDataObject.
String

Generates a string which, if executed, will return the RuleDataObject.

Object of 2

Properties elsewhere that hold a RuleDataObjects.