Class

CellStyle

A cell style.

QuickLinks

addEventListener, duplicate, extractLabel, getElements, insertLabel, move, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | CellStyleGroup | Document

CellStyle

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
appliedParagraphStyle	NothingEnum ParagraphStyle String	r/w	The paragraph style applied to the text. Can return: ParagraphStyle or NothingEnum enumerator. Can also accept: String.
basedOn	CellStyle String	r/w	The style that this style is based on. Can return: CellStyle or String.
bottomEdgeStrokeColor	NothingEnum Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. Can return: Swatch or NothingEnum enumerator.
bottomEdgeStrokeGapColor	NothingEnum Swatch	r/w	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	r/w	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	NothingEnum Real	r/w	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	r/w	If true, the bottom edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
bottomEdgeStrokeTint	NothingEnum Real	r/w	The tint (as a percentage) of the bottom edge border stroke. Can return: Real or NothingEnum enumerator.
bottomEdgeStrokeType	NothingEnum String StrokeStyle	r/w	The stroke type of the bottom edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.
bottomEdgeStrokeWeight	NothingEnum Unit	r/w	The stroke weight of the bottom edge border stroke. Can return: Unit or NothingEnum enumerator.
bottomInset	NothingEnum Unit	r/w	The bottom inset of the cell. Can return: Unit or NothingEnum enumerator.
clipContentToCell	Boolean NothingEnum	r/w	If true, clips the cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator.
diagonalLineInFront	Boolean NothingEnum	r/w	If true, draws the diagonal line in front of cell contents. Can return: Boolean or NothingEnum enumerator.
diagonalLineStrokeColor	NothingEnum Swatch	r/w	The diagonal line color, specified as a swatch. Can return: Swatch or NothingEnum enumerator.
diagonalLineStrokeGapColor	NothingEnum Swatch	r/w	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	r/w	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	NothingEnum Real	r/w	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	r/w	If true, the diagonal line stroke will overprint. Can return: Boolean or NothingEnum enumerator.
diagonalLineStrokeTint	NothingEnum Real	r/w	The diagonal line tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
diagonalLineStrokeType	NothingEnum String StrokeStyle	r/w	The stroke type of the diagonal line(s). Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.
diagonalLineStrokeWeight	NothingEnum Unit	r/w	The diagonal line stroke weight. Can return: Unit or NothingEnum enumerator.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
fillColor	NothingEnum String Swatch	r/w	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	NothingEnum Real	r/w	The tint (as a percentage) of the fill of the object. Can return: Real or NothingEnum enumerator.
firstBaselineOffset	FirstBaseline NothingEnum	r/w	The distance between the baseline of the text and the top inset of the cell. Can return: FirstBaseline enumerator or NothingEnum enumerator.
gradientFillAngle	NothingEnum Real	r/w	The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientFillLength	NothingEnum Real	r/w	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	2 Units NothingEnum	r/w	The starting point (in page coordinates) of a gradient applied to the fill of the CellStyle, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator.
id	number	readonly	The unique ID of the CellStyle.
index	number	readonly	The index of the CellStyle within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
leftEdgeStrokeColor	NothingEnum Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. Can return: Swatch or NothingEnum enumerator.
leftEdgeStrokeGapColor	NothingEnum Swatch	r/w	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	r/w	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	NothingEnum Real	r/w	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	r/w	If true, the left edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
leftEdgeStrokeTint	NothingEnum Real	r/w	The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
leftEdgeStrokeType	NothingEnum String StrokeStyle	r/w	The stroke type of the left edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.
leftEdgeStrokeWeight	NothingEnum Unit	r/w	The stroke weight of the left edge border stroke. Can return: Unit or NothingEnum enumerator.
leftInset	NothingEnum Unit	r/w	The left inset of the cell. Can return: Unit or NothingEnum enumerator.
minimumFirstBaselineOffset	NothingEnum Unit (0 - 8640 points)	r/w	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	r/w	The name of the style.
overprintFill	Boolean NothingEnum	r/w	If true, the fill of the object will overprint. Can return: Boolean or NothingEnum enumerator.
paragraphSpacingLimit	NothingEnum Unit	r/w	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 CellStyleGroup Document	readonly	The parent of the CellStyle (a Document, Application or CellStyleGroup).
properties	Object	r/w	A property that allows setting of several properties at the same time.
rightEdgeStrokeColor	NothingEnum Swatch	r/w	The color, specified as a swatch, of the right edge border stroke. Can return: Swatch or NothingEnum enumerator.
rightEdgeStrokeGapColor	NothingEnum Swatch	r/w	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	r/w	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	NothingEnum Real	r/w	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	r/w	If true, the right edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
rightEdgeStrokeTint	NothingEnum Real	r/w	The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
rightEdgeStrokeType	NothingEnum String StrokeStyle	r/w	The stroke type of the right edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.
rightEdgeStrokeWeight	NothingEnum Unit	r/w	The stroke weight of the right edge border stroke. Can return: Unit or NothingEnum enumerator.
rightInset	NothingEnum Unit	r/w	The right inset of the cell. Can return: Unit or NothingEnum enumerator.
rotationAngle	NothingEnum Real	r/w	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.
rotationRunsAgainstStory	Boolean NothingEnum	r/w	Whether the direction of the text in a cell runs against the story direction. Can return: Boolean or NothingEnum enumerator.
topEdgeStrokeColor	NothingEnum Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. Can return: Swatch or NothingEnum enumerator.
topEdgeStrokeGapColor	NothingEnum Swatch	r/w	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	r/w	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	NothingEnum Real	r/w	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	r/w	If true, the top edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator.
topEdgeStrokeTint	NothingEnum Real	r/w	The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
topEdgeStrokeType	NothingEnum String StrokeStyle	r/w	The stroke type of the top edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.
topEdgeStrokeWeight	NothingEnum Unit	r/w	The stroke weight of the top edge border stroke. Can return: Unit or NothingEnum enumerator.
topInset	NothingEnum Unit	r/w	The top inset of the cell. Can return: Unit or NothingEnum enumerator.
topLeftDiagonalLine	Boolean NothingEnum	r/w	If true, draws a diagonal line starting from the top left. Can return: Boolean or NothingEnum enumerator.
topRightDiagonalLine	Boolean NothingEnum	r/w	If true, draws a diagonal line starting from the top right. Can return: Boolean or NothingEnum enumerator.
verticalJustification	NothingEnum VerticalJustification	r/w	The vertical alignment of cell. Can return: VerticalJustification enumerator 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)

CellStyle duplicate ()
Duplicates the CellStyle.

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

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

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

CellStyle move (to: LocationOptions[, reference: varies])
Moves the style to the specified location.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object.
reference	Application CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup	The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional)

void remove ([replacingWith: CellStyle])
Deletes the style.

Parameter	Type	Description
replacingWith	CellStyle	The style to apply in place of the deleted style. (Optional)

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)