Adobe InDesign CS3 (5.0) Object Model JS: SatinSetting

InDesign CS3

Class

SatinSetting

 Satin effect settings.

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

ContentTransparencySetting | FillTransparencySetting | StrokeTransparencySetting | TransparencySetting
SatinSetting

Properties

PropertyTypeAccessDescription
angleNothingEnumReal (-180 - 180) r/wThe light angle of the satin effect. (Range: -360 to 360). Can return: Real (-180 - 180) or NothingEnum enumerator.
appliedBoolean
NothingEnum
r/wIf true, applies the satin effect. Can return: Boolean or NothingEnum enumerator.
blendModeBlendMode
NothingEnum
r/wThe blending mode for the satin effect. Can return: BlendMode enumerator or NothingEnum enumerator.
distanceNothingEnum
Unit (0 - 1000 points)
r/wThe distance (in pixels) from the SatinSetting to the satin effect. Can return: Unit (0 - 1000 points) or NothingEnum enumerator.
effectColorNothingEnum
Swatch
r/wThe 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.
invertEffectBoolean
NothingEnum
r/wIf true, inverts the satin effect. Can return: Boolean or NothingEnum enumerator.
opacityNothingEnum
Real (0 - 100)
r/wThe opacity of the satin effect (as a percentage). (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator.
parentContentTransparencySetting
FillTransparencySetting
StrokeTransparencySetting
TransparencySetting
readonlyThe parent of the SatinSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).
propertiesObject r/wA property that allows setting of several properties at the same time.
sizeNothingEnum
Unit (0 - 144 points)
r/wThe width (in pixels) of the satin effect. Can return: Unit (0 - 144 points) or NothingEnum enumerator.

Methods

Instances

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

ContentTransparencySetting.satinSettings

FillTransparencySetting.satinSettings

StrokeTransparencySetting.satinSettings

TransparencySetting.satinSettings

Return

Array of SatinSetting SatinSetting.getElements ()

Jongware, 27-Jun-2010 v3.0.3dContents :: Index