TableStyle

A table style.

Go to Property Listing | Method Listing

Methods:

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

Objects:

Boolean, CellStyle, EventListeners, Events, Number, Object, String, StrokeOrderTypes, StrokeStyle, Swatch, TableStyle,

Property Listing

Property	Type	Access	Description
basedOn	TableStyle String	read/write	The style that this style is based on. Can return: TableStyle or String.
bodyRegionCellStyle	CellStyle String	read/write	The cell style of the body region. Can also accept: String.
bottomBorderStrokeColor	Swatch	read/write	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke.
bottomBorderStrokeGapColor	Swatch	read/write	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapOverprint	Boolean	read/write	If true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of the bottom border stroke. (Range: 0 to 100) Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeOverprint	Boolean	read/write	If true, the bottom border stroke will overprint.
bottomBorderStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100)
bottomBorderStrokeType	StrokeStyle String	read/write	The stroke type of the bottom border. Can also accept: String.
bottomBorderStrokeWeight	Number String	read/write	The stroke weight of the bottom border stroke.
clipContentToGraphicCell	Boolean	read/write	If true, clips the graphic cell's content to width and height of the cell.
clipContentToTextCell	Boolean	read/write	If true, clips the text cell's content to width and height of the cell.
columnFillsPriority	Boolean	read/write	If true, hides alternating row fills. If false, hides alternating column fills.
endColumnFillColor	Swatch	read/write	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the second alternating fill group. Note: Valid when alternating fills are defined for table columns.
endColumnFillCount	Number	read/write	The number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns.
endColumnFillOverprint	Boolean	read/write	If true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
endColumnFillTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the columns in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns.
endColumnLineStyle	StrokeStyle String	read/write	The stroke type of columns in the second alternating strokes group. Can also accept: String.
endColumnStrokeColor	Swatch	read/write	The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeCount	Number	read/write	The number of columns in the second alternating column strokes group.
endColumnStrokeGapColor	Swatch	read/write	The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeGapOverprint	Boolean	read/write	If true, the gap of the column border stroke in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeOverprint	Boolean	read/write	If true, the column borders in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeWeight	Number String	read/write	The stroke weight of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endRowFillColor	Swatch	read/write	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillCount	Number	read/write	The number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillOverprint	Boolean	read/write	If true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
endRowFillTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the rows in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows.
endRowStrokeColor	Swatch	read/write	The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeCount	Number	read/write	The number of rows in the second alternating row strokes group.
endRowStrokeGapColor	Swatch	read/write	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating rows group. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeGapOverprint	Boolean	read/write	If true, the gap of the row borders in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of rows in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater and end row stroke type is not solid.
endRowStrokeOverprint	Boolean	read/write	If true, the rows in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the row borders in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater.
endRowStrokeType	StrokeStyle String	read/write	The stroke type of rows in the second alternating strokes group. Can also accept: String.
endRowStrokeWeight	Number String	read/write	The stroke weight of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
footerRegionCellStyle	CellStyle String	read/write	The cell style of the footer region. Can also accept: String.
footerRegionSameAsBodyRegion	Boolean	read/write	If true, uses the cell style of the body region for the footer region.
graphicBottomInset	Number String	read/write	The bottom inset of the graphic cell.
graphicLeftInset	Number String	read/write	The left inset of the graphic cell.
graphicRightInset	Number String	read/write	The right inset of the graphic cell.
graphicTopInset	Number String	read/write	The top inset of the graphic cell.
headerRegionCellStyle	CellStyle String	read/write	The cell style of the header region. Can also accept: String.
headerRegionSameAsBodyRegion	Boolean	read/write	If true, use the cell style of the body region for the header region.
id	Number	readonly	The unique ID of the TableStyle.
index	Number	readonly	The index of the TableStyle 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.
leftBorderStrokeColor	Swatch	read/write	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke.
leftBorderStrokeGapColor	Swatch	read/write	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapOverprint	Boolean	read/write	If true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of the left border stroke. (Range: 0 to 100) Note: Valid only when left border stroke type is not solid.
leftBorderStrokeOverprint	Boolean	read/write	If true, the left border stroke will overprint.
leftBorderStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the left border stroke. (Range: 0 to 100)
leftBorderStrokeType	StrokeStyle String	read/write	The stroke type of the left border. Can also accept: String.
leftBorderStrokeWeight	Number String	read/write	The stroke weight of the left border stroke.
leftColumnRegionCellStyle	CellStyle String	read/write	The cell style of the left column region. Can also accept: String.
leftColumnRegionSameAsBodyRegion	Boolean	read/write	If true, uses the cell style of the body region for the left column region.
name	String	read/write	The name of the TableStyle.
parent	Application Document TableStyleGroup	readonly	The parent of the TableStyle (a Document, Application or TableStyleGroup).
properties	Object	read/write	A property that allows setting of several properties at the same time.
rightBorderStrokeColor	Swatch	read/write	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke.
rightBorderStrokeGapColor	Swatch	read/write	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. Note: Valid only when right border stroke type is not solid.
rightBorderStrokeGapOverprint	Boolean	read/write	If true, the gap color of the right border stroke will overprint. Note: Valid only when right border stroke type is not solid.
rightBorderStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of the right border stroke. (Range: 0 to 100) Note: Valid only when right border stroke type is not solid.
rightBorderStrokeOverprint	Boolean	read/write	If true, the right border stroke will overprint.
rightBorderStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the right border stroke. (Range: 0 to 100)
rightBorderStrokeType	StrokeStyle String	read/write	The stroke type of the right border. Can also accept: String.
rightBorderStrokeWeight	Number String	read/write	The stroke weight of the right border stroke.
rightColumnRegionCellStyle	CellStyle String	read/write	The cell style of the right column region. Can also accept: String.
rightColumnRegionSameAsBodyRegion	Boolean	read/write	If true, uses the cell style of the body region for the right column region.
skipFirstAlternatingFillColumns	Number	read/write	The number of columns on the left side of the table to skip before applying the column fill color. Note: Valid when alternating fills are defined for table columns.
skipFirstAlternatingFillRows	Number	read/write	The number of body rows at the beginning of the table to skip before applying the row fill color. Note: Valid when alternating fills are defined for table rows.
skipFirstAlternatingStrokeColumns	Number	read/write	The number of columns on the left of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater.
skipFirstAlternatingStrokeRows	Number	read/write	The number of body rows at the beginning of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater.
skipLastAlternatingFillColumns	Number	read/write	The number columns on the right side of the table in which to not apply the column fill color. Note: Valid when alternating fills are defined for table columns.
skipLastAlternatingFillRows	Number	read/write	The number of body rows at the end of the table in which to not apply the row fill color. Note: Valid when alternating fills are defined for table rows.
skipLastAlternatingStrokeColumns	Number	read/write	The number of columns on the right side of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater.
skipLastAlternatingStrokeRows	Number	read/write	The number of body rows at the end of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater.
spaceAfter	Number String	read/write	The space below the table.
spaceBefore	Number String	read/write	The space above the table.
startColumnFillColor	Swatch	read/write	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillCount	Number	read/write	The number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillOverprint	Boolean	read/write	If true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
startColumnFillTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the columns in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns.
startColumnStrokeColor	Swatch	read/write	The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group.
startColumnStrokeCount	Number	read/write	The number of columns in the first alternating column strokes group.
startColumnStrokeGapColor	Swatch	read/write	The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeGapOverprint	Boolean	read/write	If true, the gap of the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeOverprint	Boolean	read/write	If true, the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeType	StrokeStyle String	read/write	The stroke type of columns in the first alternating strokes group. Can also accept: String.
startColumnStrokeWeight	Number String	read/write	The stroke weight of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater.
startRowFillColor	Swatch	read/write	The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillCount	Number	read/write	The number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillOverprint	Boolean	read/write	If true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
startRowFillTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the rows in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows.
startRowStrokeColor	Swatch	read/write	The color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeCount	Number	read/write	The number of rows in the first alternating row strokes group.
startRowStrokeGapColor	Swatch	read/write	The stroke gap color of row borders in the first alternating row strokes group, specified as a swatch (color, gradient, tint, or mixed ink). Note: Valid when start row stroke count is 1 or greater.
startRowStrokeGapOverprint	Boolean	read/write	If true, the gap color of the row border stroke in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of row borders in the first alternating rows group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater.
startRowStrokeOverprint	Boolean	read/write	If true, the row borders in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the borders in the first alternating row strokes group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater.
startRowStrokeType	StrokeStyle String	read/write	The stroke type of rows in the first alternating strokes group. Can also accept: String.
startRowStrokeWeight	Number String	read/write	The stroke weight of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
strokeOrder	StrokeOrderTypes StrokeOrderTypes.BEST_JOINS StrokeOrderTypes.COLUMN_ON_TOP StrokeOrderTypes.INDESIGN_2_COMPATIBILITY StrokeOrderTypes.ROW_ON_TOP	read/write	The order in which to display row and column strokes at corners.
textBottomInset	Number String	read/write	The bottom inset of the text cell.
textLeftInset	Number String	read/write	The left inset of the text cell.
textRightInset	Number String	read/write	The right inset of the text cell.
textTopInset	Number String	read/write	The top inset of the text cell.
topBorderStrokeColor	Swatch	read/write	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke.
topBorderStrokeGapColor	Swatch	read/write	The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapOverprint	Boolean	read/write	If true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of the table's top border stroke. (Range: 0 to 100) Note: Valid only when top border stroke type is not solid.
topBorderStrokeOverprint	Boolean	read/write	If true, the top border strokes will overprint.
topBorderStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the table's top border stroke. (Range: 0 to 100)
topBorderStrokeType	StrokeStyle String	read/write	The stroke type of the top border. Can also accept: String.
topBorderStrokeWeight	Number String	read/write	The stroke weight of the table's top border stroke.

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)

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)

TableStyle duplicate ()

Duplicates the TableStyle.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

TableStyle 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.

TableStyle 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)

Parameter

Type

Description

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

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:TableStyle)

Deletes the style.

Parameter	Type	Description
replacingWith	TableStyle	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)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

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

captures

Boolean