Class

TableStyle

A table style.

QuickLinks

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

Hierarchy

Application | Document | TableStyleGroup

TableStyle

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
basedOn	String TableStyle	r/w	The style that this style is based on. Can return: TableStyle or String.
bodyRegionCellStyle	CellStyle String	r/w	The cell style of the body region. Can also accept: String.
bottomBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke.
bottomBorderStrokeGapColor	Swatch	r/w	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	bool	r/w	If true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapTint	number	r/w	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	bool	r/w	If true, the bottom border stroke will overprint.
bottomBorderStrokeTint	number	r/w	The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100)
bottomBorderStrokeType	String StrokeStyle	r/w	The stroke type of the bottom border. Can also accept: String.
bottomBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the bottom border stroke.
columnFillsPriority	bool	r/w	If true, hides alternating row fills. If false, hides alternating column fills.
endColumnFillColor	Swatch	r/w	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	r/w	The number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns.
endColumnFillOverprint	bool	r/w	If true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
endColumnFillTint	number	r/w	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	String StrokeStyle	r/w	The stroke type of columns in the second alternating strokes group. Can also accept: String.
endColumnStrokeColor	Swatch	r/w	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	r/w	The number of columns in the second alternating column strokes group.
endColumnStrokeGapColor	Swatch	r/w	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	bool	r/w	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	r/w	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	bool	r/w	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	r/w	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	Measurement Unit (Number or String)	r/w	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	r/w	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	r/w	The number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillOverprint	bool	r/w	If true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
endRowFillTint	number	r/w	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	r/w	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	r/w	The number of rows in the second alternating row strokes group.
endRowStrokeGapColor	Swatch	r/w	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	bool	r/w	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	r/w	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	bool	r/w	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	r/w	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	String StrokeStyle	r/w	The stroke type of rows in the second alternating strokes group. Can also accept: String.
endRowStrokeWeight	Measurement Unit (Number or String)	r/w	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	r/w	The cell style of the footer region. Can also accept: String.
footerRegionSameAsBodyRegion	bool	r/w	If true, uses the cell style of the body region for the footer region.
headerRegionCellStyle	CellStyle String	r/w	The cell style of the header region. Can also accept: String.
headerRegionSameAsBodyRegion	bool	r/w	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	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.
leftBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke.
leftBorderStrokeGapColor	Swatch	r/w	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	bool	r/w	If true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapTint	number	r/w	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	bool	r/w	If true, the left border stroke will overprint.
leftBorderStrokeTint	number	r/w	The tint (as a percentage) of the left border stroke. (Range: 0 to 100)
leftBorderStrokeType	String StrokeStyle	r/w	The stroke type of the left border. Can also accept: String.
leftBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the left border stroke.
leftColumnRegionCellStyle	CellStyle String	r/w	The cell style of the left column region. Can also accept: String.
leftColumnRegionSameAsBodyRegion	bool	r/w	If true, uses the cell style of the body region for the left column region.
name	string	r/w	The name of the TableStyle.
parent	Application Document TableStyleGroup	readonly	The parent of the TableStyle (a Document, Application or TableStyleGroup).
properties	Object	r/w	A property that allows setting of several properties at the same time.
rightBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke.
rightBorderStrokeGapColor	Swatch	r/w	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	bool	r/w	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	r/w	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	bool	r/w	If true, the right border stroke will overprint.
rightBorderStrokeTint	number	r/w	The tint (as a percentage) of the right border stroke. (Range: 0 to 100)
rightBorderStrokeType	String StrokeStyle	r/w	The stroke type of the right border. Can also accept: String.
rightBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the right border stroke.
rightColumnRegionCellStyle	CellStyle String	r/w	The cell style of the right column region. Can also accept: String.
rightColumnRegionSameAsBodyRegion	bool	r/w	If true, uses the cell style of the body region for the right column region.
skipFirstAlternatingFillColumns	number	r/w	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	r/w	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	r/w	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	r/w	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	r/w	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	r/w	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	r/w	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	r/w	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	Measurement Unit (Number or String)	r/w	The space below the table.
spaceBefore	Measurement Unit (Number or String)	r/w	The space above the table.
startColumnFillColor	Swatch	r/w	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	r/w	The number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillOverprint	bool	r/w	If true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
startColumnFillTint	number	r/w	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	r/w	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	r/w	The number of columns in the first alternating column strokes group.
startColumnStrokeGapColor	Swatch	r/w	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	bool	r/w	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	r/w	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	bool	r/w	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	r/w	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	String StrokeStyle	r/w	The stroke type of columns in the first alternating strokes group. Can also accept: String.
startColumnStrokeWeight	Measurement Unit (Number or String)	r/w	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	r/w	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	r/w	The number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillOverprint	bool	r/w	If true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
startRowFillTint	number	r/w	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	r/w	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	r/w	The number of rows in the first alternating row strokes group.
startRowStrokeGapColor	Swatch	r/w	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	bool	r/w	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	r/w	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	bool	r/w	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	r/w	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	String StrokeStyle	r/w	The stroke type of rows in the first alternating strokes group. Can also accept: String.
startRowStrokeWeight	Measurement Unit (Number or String)	r/w	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.ROW_ON_TOP StrokeOrderTypes.COLUMN_ON_TOP StrokeOrderTypes.BEST_JOINS StrokeOrderTypes.INDESIGN_2_COMPATIBILITY	r/w	The order in which to display row and column strokes at corners.
topBorderStrokeColor	Swatch	r/w	The color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke.
topBorderStrokeGapColor	Swatch	r/w	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	bool	r/w	If true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapTint	number	r/w	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	bool	r/w	If true, the top border strokes will overprint.
topBorderStrokeTint	number	r/w	The tint (as a percentage) of the table's top border stroke. (Range: 0 to 100)
topBorderStrokeType	String StrokeStyle	r/w	The stroke type of the top border. Can also accept: String.
topBorderStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the table's top border stroke.

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)

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.

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

TableStyle 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: TableStyle])
Deletes the style.

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