Class

FindChangeSatinSetting

 Satin effect settings. Base Class: SatinSetting

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

FindChangeContentTransparencySetting | FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeTransparencySetting

SatinSetting

FindChangeSatinSetting

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
angle	NothingEnumReal (-180 - 180)	r/w	The light angle of the satin effect. (Range: -360 to 360). Can return: Real (-180 - 180) or NothingEnum enumerator.
applied	Boolean NothingEnum	r/w	If true, applies the satin effect. Can return: Boolean or NothingEnum enumerator.
blendMode	BlendMode NothingEnum	r/w	The blending mode for the satin effect. Can return: BlendMode enumerator or NothingEnum enumerator.
distance	NothingEnum Unit (0 - 1000 points)	r/w	The distance (in pixels) from the FindChangeSatinSetting to the satin effect. Can return: Unit (0 - 1000 points) or NothingEnum enumerator.
effectColor	NothingEnum Swatch	r/w	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. Can return: Swatch or NothingEnum enumerator.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
invertEffect	Boolean NothingEnum	r/w	If true, inverts the satin effect. Can return: Boolean or NothingEnum enumerator.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
opacity	NothingEnum Real (0 - 100)	r/w	The opacity of the satin effect (as a percentage). (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator.
parent	FindChangeContentTransparencySetting FindChangeFillTransparencySetting FindChangeStrokeTransparencySetting FindChangeTransparencySetting	readonly	The parent of the FindChangeSatinSetting (a FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, FindChangeFillTransparencySetting or FindChangeContentTransparencySetting).
properties	Object	r/w	A property that allows setting of several properties at the same time.
size	NothingEnum Unit (0 - 144 points)	r/w	The width (in pixels) of the satin effect. Can return: Unit (0 - 144 points) or NothingEnum enumerator.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of FindChangeSatinSetting getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the FindChangeSatinSetting.

string toSpecifier ()
Retrieves the object specifier.

Element of

FindChangeContentTransparencySetting.satinSettings

FindChangeFillTransparencySetting.satinSettings

FindChangeStrokeTransparencySetting.satinSettings

FindChangeTransparencySetting.satinSettings

Return

Array of FindChangeSatinSetting FindChangeSatinSetting.getElements ()

Jongware, 28-Apr-2012 v3.0.3h

Contents :: Index