CellStyle

A cell style

Go to Property Listing | Method Listing

Methods:

applycellstyle, applycellstyletocells, duplicate, extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Objects:

Boolean, FirstBaseline.html#d1e39416, NothingEnum.html#d1e43981, Object, ParagraphStyle.html#d1e185661, String, StrokeStyle.html#d1e136062, Swatch.html#d1e35844, VerticalJustification.html#d1e39500

Property Listing

Property	Type	Access	Description
bottomEdgeStrokeColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. Can return: Swatch or NothingEnum enumerator.
bottomEdgeStrokeGapColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the bottom edge border stroke. Note: Not valid when bottom edge stroke type is solid. Can return: Swatch or NothingEnum enumerator.
bottomEdgeStrokeGapOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the gap color of the bottom edge border stroke will overprint. Note: Not valid when bottom edge stroke type is solid. Can return: Boolean or NothingEnum enumerator.
bottomEdgeStrokeGapTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the bottom edge border stroke gap color. (Range: 0 to 100) Note: Not valid when bottom edge stroke type is solid. Can return: Real or NothingEnum enumerator.
bottomEdgeStrokeOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the bottom edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
bottomEdgeStrokePriority	Long NothingEnum.NOTHING	read/write	The order in which to draw the bottom edge border stroke. Note: The value must be 1, 2, 3, or 4, with 1 indicating that the stroke is the first stroke drawn, and therefore overlapped by strokes with higher priority. Can return: Long or NothingEnum enumerator.
bottomEdgeStrokeTint	Real NothingEnum.NOTHING	read/write	The tint (as a percentage) of the bottom edge border stroke. Can return: Real or NothingEnum enumerator.
bottomEdgeStrokeType	StrokeStyle.html#d1e136062 NothingEnum.NOTHING	read/write	The stroke type of the bottom edge. Can return: StrokeStyle or NothingEnum enumerator.
bottomEdgeStrokeWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the bottom edge border stroke. Can return: Unit or NothingEnum enumerator.
bottomInset	Unit NothingEnum.NOTHING	read/write	The bottom inset of the cell. Can return: Unit or NothingEnum enumerator.
clipContentToCell	Boolean NothingEnum.NOTHING	read/write	If true, clips the cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator.
diagonalLineInFront	Boolean NothingEnum.NOTHING	read/write	If true, draws the diagonal line in front of cell contents. Can return: Boolean or NothingEnum enumerator.
diagonalLineStrokeColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The diagonal line color, specified as a swatch. Can return: Swatch or NothingEnum enumerator.
diagonalLineStrokeGapColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the diagonal line stroke. Note: Not valid when diagonal line stroke type is solid. Can return: Swatch or NothingEnum enumerator.
diagonalLineStrokeGapOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid. Can return: Boolean or NothingEnum enumerator.
diagonalLineStrokeGapTint	Real NothingEnum.NOTHING	read/write	The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid. Can return: Real or NothingEnum enumerator.
diagonalLineStrokeOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the diagonal line stroke will overprint. Can return: Boolean or NothingEnum enumerator.
diagonalLineStrokeTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The diagonal line tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
diagonalLineStrokeType	StrokeStyle.html#d1e136062 NothingEnum.NOTHING	read/write	The diagonal line stroke type. Can return: StrokeStyle or NothingEnum enumerator.
diagonalLineStrokeWeight	Unit NothingEnum.NOTHING	read/write	The diagonal line stroke weight. Can return: Unit or NothingEnum enumerator.
fillColor	Swatch.html#d1e35844 NothingEnumCanalsoaccept:String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can return: Swatch or NothingEnum enumerator. Can also accept: String.
fillTint	Real NothingEnum.NOTHING	read/write	The tint (as a percentage) of the fill of the object. Can return: Real or NothingEnum enumerator.
firstBaselineOffset	FirstBaseline.html#d1e39416 FirstBaseline.ASCENT_OFFSET FirstBaseline.CAP_HEIGHT FirstBaseline.EMBOX_HEIGHT FirstBaseline.FIXED_HEIGHT FirstBaseline.LEADING_OFFSET FirstBaseline.X_HEIGHT NothingEnum.NOTHING	read/write	The distance between the baseline of the text and the top inset of the cell. Can return: FirstBaseline enumerator or NothingEnum enumerator.
gradientFillAngle	Real NothingEnum.NOTHING	read/write	The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientFillLength	Real NothingEnum.NOTHING	read/write	The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object. Can return: Real or NothingEnum enumerator.
gradientFillStart	Array of 2 Units NothingEnum.NOTHING	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the object, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator.
id	Long NothingEnum.NOTHING	readonly	The unique ID of the CellStyle. Can return: Long or NothingEnum enumerator.
index	Long NothingEnum.NOTHING	readonly	The index of the CellStyle within its containing object. Can return: Long or NothingEnum enumerator.
label	String NothingEnum.NOTHING	read/write	A property that can be set to any string. Can return: String or NothingEnum enumerator.
leftEdgeStrokeColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. Can return: Swatch or NothingEnum enumerator.
leftEdgeStrokeGapColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the left edge border stroke. Note: Not valid when left edge stroke type is solid. Can return: Swatch or NothingEnum enumerator.
leftEdgeStrokeGapOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the gap color of the left edge border stroke will overprint. Note: Not valid when left edge stroke type is solid. Can return: Boolean or NothingEnum enumerator.
leftEdgeStrokeGapTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the left edge border stroke gap color. (Range: 0 to 100) Note: Not valid when left edge stroke type is solid. Can return: Real or NothingEnum enumerator.
leftEdgeStrokeOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the left edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
leftEdgeStrokePriority	Long NothingEnum.NOTHING	read/write	The order in which to draw the left edge border stroke. Note: The value must be 1, 2, 3, or 4, with 1 indicating that the stroke is the first stroke drawn, and therefore overlapped by strokes with higher priority. Can return: Long or NothingEnum enumerator.
leftEdgeStrokeTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
leftEdgeStrokeType	StrokeStyle.html#d1e136062 NothingEnum.NOTHING	read/write	The stroke type of the left edge border stroke. Can return: StrokeStyle or NothingEnum enumerator.
leftEdgeStrokeWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the left edge border stroke. Can return: Unit or NothingEnum enumerator.
leftInset	Unit NothingEnum.NOTHING	read/write	The left inset of the cell. Can return: Unit or NothingEnum enumerator.
minimumFirstBaselineOffset	Unit(0-8640points) NothingEnum.NOTHING	read/write	The space between the baseline of the text and the top inset of the frame or cell. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.
name	String NothingEnum.NOTHING	read/write	The name of the CellStyle. Can return: String or NothingEnum enumerator.
overprintFill	Boolean NothingEnum.NOTHING	read/write	If true, the fill of the object will overprint. Can return: Boolean or NothingEnum enumerator.
paraStyle	ParagraphStyle.html#d1e185661 NothingEnumCanalsoaccept:String	read/write	The paragraph style associated with this cell style. Can return: ParagraphStyle or NothingEnum enumerator. Can also accept: String.
paragraphSpacingLimit	Unit NothingEnum.NOTHING	read/write	The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified. Can return: Unit or NothingEnum enumerator.
parent	Application.html#d1e24410 Document.html#d1e26379	readonly	The parent of the CellStyle (a Application or Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
rightEdgeStrokeColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The color, specified as a swatch, of the right edge border stroke. Can return: Swatch or NothingEnum enumerator.
rightEdgeStrokeGapColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the right edge border stroke. Note: Not valid when right edge stroke type is solid. Can return: Swatch or NothingEnum enumerator.
rightEdgeStrokeGapOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the gap color of the right edge border stroke will overprint. Note: Not valid when right edge stroke type is solid. Can return: Boolean or NothingEnum enumerator.
rightEdgeStrokeGapTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the right edge border stroke gap color. (Range: 0 to 100) Note: Not valid when right edge stroke type is solid. Can return: Real or NothingEnum enumerator.
rightEdgeStrokeOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the right edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
rightEdgeStrokePriority	Long NothingEnum.NOTHING	read/write	The order in which to draw the right edge border stroke. Note: The value must be 1, 2, 3, or 4, with 1 indicating that the stroke is the first stroke drawn, and therefore overlapped by strokes with higher priority. Can return: Long or NothingEnum enumerator.
rightEdgeStrokeTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
rightEdgeStrokeType	StrokeStyle.html#d1e136062 NothingEnum.NOTHING	read/write	The stroke type of the right edge border stroke. Can return: StrokeStyle or NothingEnum enumerator.
rightEdgeStrokeWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the right edge border stroke. Can return: Unit or NothingEnum enumerator.
rightInset	Unit NothingEnum.NOTHING	read/write	The right inset of the cell. Can return: Unit or NothingEnum enumerator.
rotationAngle	Real NothingEnum.NOTHING	read/write	The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270. Can return: Real or NothingEnum enumerator.
topEdgeStrokeColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. Can return: Swatch or NothingEnum enumerator.
topEdgeStrokeGapColor	Swatch.html#d1e35844 NothingEnum.NOTHING	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the top edge border stroke. Note: Not valid when top edge stroke type is solid. Can return: Swatch or NothingEnum enumerator.
topEdgeStrokeGapOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the gap color of the top edge border stroke will overprint. Note: Not valid when top edge stroke type is solid. . Can return: Boolean or NothingEnum enumerator.
topEdgeStrokeGapTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the top edge border stroke gap color. (Range: 0 to 100) Note: Not valid when top edge stroke type is solid. Can return: Real or NothingEnum enumerator.
topEdgeStrokeOverprint	Boolean NothingEnum.NOTHING	read/write	If true, the top edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
topEdgeStrokePriority	Long NothingEnum.NOTHING	read/write	The order in which to draw the top edge border stroke. Note: The value must be 1, 2, 3, or 4, with 1 indicating that the stroke is the first stroke drawn. Can return: Long or NothingEnum enumerator.
topEdgeStrokeTint	Real (range 0 - 100) NothingEnum.NOTHING	read/write	The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
topEdgeStrokeType	StrokeStyle.html#d1e136062 NothingEnum.NOTHING	read/write	The stroke type of the top edge border stroke. Can return: StrokeStyle or NothingEnum enumerator.
topEdgeStrokeWeight	Unit NothingEnum.NOTHING	read/write	The stroke weight of the top edge border stroke. Can return: Unit or NothingEnum enumerator.
topInset	Unit NothingEnum.NOTHING	read/write	The top inset of the cell. Can return: Unit or NothingEnum enumerator.
topLeftDiagonalLine	Boolean NothingEnum.NOTHING	read/write	If true, draws a diagonal line starting from the top left. Can return: Boolean or NothingEnum enumerator.
topRightDiagonalLine	Boolean NothingEnum.NOTHING	read/write	If true, draws a diagonal line starting from the top right. Can return: Boolean or NothingEnum enumerator.
verticalJustification	VerticalJustification.html#d1e39500 VerticalJustification.BOTTOM_ALIGN VerticalJustification.CENTER_ALIGN VerticalJustification.JUSTIFY_ALIGN VerticalJustification.TOP_ALIGN NothingEnum.NOTHING	read/write	The vertical alignment of cell. Can return: VerticalJustification enumerator or NothingEnum enumerator.

Method Listing

undefined applycellstyle ([removeOverrides:Boolean=Boolean])

Used to apply a cell style to the selected cells

Parameter	Type	Description
removeOverrides	Boolean	True to remove overrides, false to keep them (Optional) (default: false)

Parameter

Type

Description

removeOverrides

Boolean

True to remove overrides, false to keep them (Optional)

(default: false)

undefined applycellstyletocells (to:Array of Varies Cells Columns Rows Tables, [removeOverrides:Boolean=Boolean])

Used to apply a cell style to the specified cells

Parameter	Type	Description
to	Array of Cells Array of Columns.html#d1e146797 Column.html#d1e145234 Array of Rows.html#d1e148688 Row.html#d1e147125 Array of Tables.html#d1e144837 Table.html#d1e142903	The cells to apply the style to. Can accept: Array of Cells, Columns, Rows or Tables.
removeOverrides	Boolean	True to remove overrides, false to keep them (Optional) (default: false)

Parameter

Type

Description

Array of Cells

Array of Columns.html#d1e146797 Column.html#d1e145234

Array of Rows.html#d1e148688 Row.html#d1e147125

Array of Tables.html#d1e144837 Table.html#d1e142903

The cells to apply the style to. Can accept: Array of Cells, Columns, Rows or Tables.

removeOverrides

Boolean

True to remove overrides, false to keep them (Optional)

(default: false)