CellStyle

A cell style.

Methods:

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

Objects:

Boolean, CellStyle, EventListeners, Events, FirstBaseline, NothingEnum, Number, Object, ParagraphStyle, String, StrokeStyle, Swatch, VerticalJustification

Property Listing

Property

Type

Access

Description

appliedParagraphStyle

ParagraphStyle

NothingEnumCanalsoaccept:String

read/write

The paragraph style applied to the text. Can return: ParagraphStyle or NothingEnum enumerator. Can also accept: String.

basedOn

CellStyle

String

read/write

The style that this style is based on. Can return: CellStyle or String.

bottomEdgeStrokeColor

Swatch

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

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.

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

NothingEnumCanalsoaccept:String

read/write

The stroke type of the bottom edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.

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.The API has been deprecated. Use TextBottomInset or GraphicBottomInset. 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. The API has been deprecated. Use ClipContentsToTextCell or ClipContentsToPageItemCell. Can return: Boolean or NothingEnum enumerator.

clipContentToGraphicCell

Boolean

NothingEnum.NOTHING

read/write

If true, clips the graphic cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator.

clipContentToTextCell

Boolean

NothingEnum.NOTHING

read/write

If true, clips the text 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

NothingEnum.NOTHING

read/write

The diagonal line color, specified as a swatch. Can return: Swatch or NothingEnum enumerator.

diagonalLineStrokeGapColor

Swatch

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

NothingEnumCanalsoaccept:String

read/write

The stroke type of the diagonal line(s). Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.

diagonalLineStrokeWeight

Unit

NothingEnum.NOTHING

read/write

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

Swatch

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

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 CellStyle, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator.

graphicBottomInset

Unit

NothingEnum.NOTHING

read/write

The bottom inset of the graphic cell. Can return: Unit or NothingEnum enumerator.

graphicLeftInset

Unit

NothingEnum.NOTHING

read/write

The left inset of the graphic cell. Can return: Unit or NothingEnum enumerator.

graphicRightInset

Unit

NothingEnum.NOTHING

read/write

The right inset of the graphic cell. Can return: Unit or NothingEnum enumerator.

graphicTopInset

Unit

NothingEnum.NOTHING

read/write

The top inset of the graphic cell. Can return: Unit 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

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

leftEdgeStrokeColor

Swatch

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

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.

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

NothingEnumCanalsoaccept:String

read/write

The stroke type of the left edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.

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.The API has been deprecated. Use TextLeftInset or GraphicLeftInset. 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

read/write

The name of the style.

overprintFill

Boolean

NothingEnum.NOTHING

read/write

If true, the fill of the object will overprint. Can return: Boolean or NothingEnum enumerator.

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

CellStyleGroup

Document

readonly

The parent of the CellStyle (a Document, Application or CellStyleGroup).

properties

Object

read/write

A property that allows setting of several properties at the same time.

rightEdgeStrokeColor

Swatch

NothingEnum.NOTHING

read/write

The color, specified as a swatch, of the right edge border stroke. Can return: Swatch or NothingEnum enumerator.

rightEdgeStrokeGapColor

Swatch

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.

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

NothingEnumCanalsoaccept:String

read/write

The stroke type of the right edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.

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.The API has been deprecated. Use TextLeftInset or GraphicRightInset. 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.

textBottomInset

Unit

NothingEnum.NOTHING

read/write

The bottom inset of the text cell. Can return: Unit or NothingEnum enumerator.

textLeftInset

Unit

NothingEnum.NOTHING

read/write

The left inset of the text cell. Can return: Unit or NothingEnum enumerator.

textRightInset

Unit

NothingEnum.NOTHING

read/write

The right inset of the text cell. Can return: Unit or NothingEnum enumerator.

textTopInset

Unit

NothingEnum.NOTHING

read/write

The top inset of the text cell. Can return: Unit or NothingEnum enumerator.

topEdgeStrokeColor

Swatch

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

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.

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

NothingEnumCanalsoaccept:String

read/write

The stroke type of the top edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.

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. The API has been deprecated. Use TextTopInset or GraphicTopInset. 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

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

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

CellStyle getElements ()

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

undefined 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 CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application)

Moves the style to the specified location.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

CellStyle

CellStyleGroup

CharacterStyle

CharacterStyleGroup

Document

ParagraphStyle

ParagraphStyleGroup

TableStyle

TableStyleGroup

Application

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)

undefined remove (replacingWith:CellStyle)

Deletes the style.

Parameter

Type

Description

replacingWith

CellStyle

The style to apply in place of the deleted style. (Optional)

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.allCellStyles

Document.allCellStyles

CellStyleGroup.allCellStyles

TypefiPaginationPreferences.cellStyle

Cell.appliedCellStyle

TableStyle.bodyRegionCellStyle

TableStyle.footerRegionCellStyle

TableStyle.headerRegionCellStyle

TableStyle.leftColumnRegionCellStyle

TableStyle.rightColumnRegionCellStyle

Event.parent

EventListener.parent

MutationEvent.parent

CellStyle.basedOn

Return

CellStyles.add()

CellStyle.duplicate()

CellStyle.move()

CellStyle.getElements()

CellStyles.anyItem()

CellStyles.everyItem()

CellStyles.nextItem()

CellStyles.previousItem()

CellStyles.itemByID()

CellStyles.item()

CellStyles.[]()

CellStyles.itemByName()

CellStyles.itemByRange()

CellStyles.firstItem()

CellStyles.lastItem()

CellStyles.middleItem()