InDesign2026
API 21.5.1.73
Object

SatinSetting

Satin effect settings.

Preference SatinSetting

Properties

NameType AccessDescription
Number -180–180 read/write The light angle of the satin effect. (Range: -360 to 360)
Boolean read/write If true, applies the satin effect.
BlendMode
+4 more
read/write The blending mode for the satin effect.
Number | String unit read/write The distance (in pixels) from the SatinSetting to the satin effect.
Swatch read/write The color applied to the satin effect, specified as a swatch (color, gradient, tint, or mixed ink), a color library color, a hex value, or as an array of color values. The color mode dictates the array values: for RGB, specify three values, each in the range 0 to 255, in the format [R,G,B]; for CMYK, specify four values, each as a percentage and each in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify three values in the format [L,A,B], with L in the range 0 to 100 and A and B in the range -128 to 127; for HSB, specify three colors in the format [H,S,B], with H in the range 0 to 360 and S and B as percentages in the range 0 to 100.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, inverts the satin effect.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Number 0–100 read/write The opacity of the satin effect (as a percentage). (Range: 0 to 100)
FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting readonly The parent of the SatinSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).
Object read/write A property that allows setting of several properties at the same time.
Number | String unit read/write The width (in pixels) of the satin effect.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
SatinSetting[]

Resolves the object specifier, creating an array of object references.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

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

String

Retrieves the object specifier.

Object of 7

Properties elsewhere that hold a SatinSetting.

Return 1

Methods that return a SatinSetting.