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

PropertyTypeAccessDescription
basedOnString
TableStyle
r/wThe style that this style is based on. Can return: TableStyle or String.
bodyRegionCellStyleCellStyle
String
r/wThe cell style of the body region. Can also accept: String.
bottomBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke.
bottomBorderStrokeGapColorSwatch r/wThe 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.
bottomBorderStrokeGapOverprintbool r/wIf true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapTintnumber r/wThe 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.
bottomBorderStrokeOverprintbool r/wIf true, the bottom border stroke will overprint.
bottomBorderStrokeTintnumber r/wThe tint (as a percentage) of the bottom border stroke. (Range: 0 to 100)
bottomBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the bottom border. Can also accept: String.
bottomBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the bottom border stroke.
columnFillsPrioritybool r/wIf true, hides alternating row fills. If false, hides alternating column fills.
endColumnFillColorSwatch r/wThe 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.
endColumnFillCountnumber r/wThe number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns.
endColumnFillOverprintbool r/wIf true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
endColumnFillTintnumber r/wThe 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.
endColumnLineStyleString
StrokeStyle
r/wThe stroke type of columns in the second alternating strokes group. Can also accept: String.
endColumnStrokeColorSwatch r/wThe 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.
endColumnStrokeCountnumber r/wThe number of columns in the second alternating column strokes group.
endColumnStrokeGapColorSwatch r/wThe 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.
endColumnStrokeGapOverprintbool r/wIf 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.
endColumnStrokeGapTintnumber r/wThe 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.
endColumnStrokeOverprintbool r/wIf true, the column borders in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeTintnumber r/wThe 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.
endColumnStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endRowFillColorSwatch r/wThe 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.
endRowFillCountnumber r/wThe number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillOverprintbool r/wIf true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
endRowFillTintnumber r/wThe 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.
endRowStrokeColorSwatch r/wThe 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.
endRowStrokeCountnumber r/wThe number of rows in the second alternating row strokes group.
endRowStrokeGapColorSwatch r/wThe 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.
endRowStrokeGapOverprintbool r/wIf 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.
endRowStrokeGapTintnumber r/wThe 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.
endRowStrokeOverprintbool r/wIf true, the rows in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeTintnumber r/wThe 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.
endRowStrokeTypeString
StrokeStyle
r/wThe stroke type of rows in the second alternating strokes group. Can also accept: String.
endRowStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
footerRegionCellStyleCellStyle
String
r/wThe cell style of the footer region. Can also accept: String.
footerRegionSameAsBodyRegionbool r/wIf true, uses the cell style of the body region for the footer region.
headerRegionCellStyleCellStyle
String
r/wThe cell style of the header region. Can also accept: String.
headerRegionSameAsBodyRegionbool r/wIf true, use the cell style of the body region for the header region.
idnumber readonlyThe unique ID of the TableStyle.
indexnumber readonlyThe index of the TableStyle within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
leftBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke.
leftBorderStrokeGapColorSwatch r/wThe 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.
leftBorderStrokeGapOverprintbool r/wIf true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapTintnumber r/wThe 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.
leftBorderStrokeOverprintbool r/wIf true, the left border stroke will overprint.
leftBorderStrokeTintnumber r/wThe tint (as a percentage) of the left border stroke. (Range: 0 to 100)
leftBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the left border. Can also accept: String.
leftBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the left border stroke.
leftColumnRegionCellStyleCellStyle
String
r/wThe cell style of the left column region. Can also accept: String.
leftColumnRegionSameAsBodyRegionbool r/wIf true, uses the cell style of the body region for the left column region.
namestring r/wThe name of the TableStyle.
parentApplication
Document
TableStyleGroup
readonlyThe parent of the TableStyle (a Document, Application or TableStyleGroup).
propertiesObject r/wA property that allows setting of several properties at the same time.
rightBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke.
rightBorderStrokeGapColorSwatch r/wThe 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.
rightBorderStrokeGapOverprintbool r/wIf true, the gap color of the right border stroke will overprint. Note: Valid only when right border stroke type is not solid.
rightBorderStrokeGapTintnumber r/wThe 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.
rightBorderStrokeOverprintbool r/wIf true, the right border stroke will overprint.
rightBorderStrokeTintnumber r/wThe tint (as a percentage) of the right border stroke. (Range: 0 to 100)
rightBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the right border. Can also accept: String.
rightBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the right border stroke.
rightColumnRegionCellStyleCellStyle
String
r/wThe cell style of the right column region. Can also accept: String.
rightColumnRegionSameAsBodyRegionbool r/wIf true, uses the cell style of the body region for the right column region.
skipFirstAlternatingFillColumnsnumber r/wThe 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.
skipFirstAlternatingFillRowsnumber r/wThe 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.
skipFirstAlternatingStrokeColumnsnumber r/wThe 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.
skipFirstAlternatingStrokeRowsnumber r/wThe 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.
skipLastAlternatingFillColumnsnumber r/wThe 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.
skipLastAlternatingFillRowsnumber r/wThe 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.
skipLastAlternatingStrokeColumnsnumber r/wThe 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.
skipLastAlternatingStrokeRowsnumber r/wThe 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.
spaceAfterMeasurement Unit (Number or String) r/wThe space below the table.
spaceBeforeMeasurement Unit (Number or String) r/wThe space above the table.
startColumnFillColorSwatch r/wThe 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.
startColumnFillCountnumber r/wThe number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillOverprintbool r/wIf true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
startColumnFillTintnumber r/wThe 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.
startColumnStrokeColorSwatch r/wThe stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group.
startColumnStrokeCountnumber r/wThe number of columns in the first alternating column strokes group.
startColumnStrokeGapColorSwatch r/wThe 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.
startColumnStrokeGapOverprintbool r/wIf 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.
startColumnStrokeGapTintnumber r/wThe 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.
startColumnStrokeOverprintbool r/wIf true, the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeTintnumber r/wThe 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.
startColumnStrokeTypeString
StrokeStyle
r/wThe stroke type of columns in the first alternating strokes group. Can also accept: String.
startColumnStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater.
startRowFillColorSwatch r/wThe 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.
startRowFillCountnumber r/wThe number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillOverprintbool r/wIf true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
startRowFillTintnumber r/wThe 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.
startRowStrokeColorSwatch r/wThe 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.
startRowStrokeCountnumber r/wThe number of rows in the first alternating row strokes group.
startRowStrokeGapColorSwatch r/wThe 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.
startRowStrokeGapOverprintbool r/wIf 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.
startRowStrokeGapTintnumber r/wThe 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.
startRowStrokeOverprintbool r/wIf true, the row borders in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeTintnumber r/wThe 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.
startRowStrokeTypeString
StrokeStyle
r/wThe stroke type of rows in the first alternating strokes group. Can also accept: String.
startRowStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
strokeOrderStrokeOrderTypes:
StrokeOrderTypes.ROW_ON_TOP
StrokeOrderTypes.COLUMN_ON_TOP
StrokeOrderTypes.BEST_JOINS
StrokeOrderTypes.INDESIGN_2_COMPATIBILITY
r/wThe order in which to display row and column strokes at corners.
topBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke.
topBorderStrokeGapColorSwatch r/wThe 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.
topBorderStrokeGapOverprintbool r/wIf true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapTintnumber r/wThe 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.
topBorderStrokeOverprintbool r/wIf true, the top border strokes will overprint.
topBorderStrokeTintnumber r/wThe tint (as a percentage) of the table's top border stroke. (Range: 0 to 100)
topBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the top border. Can also accept: String.
topBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the table's top border stroke.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

TableStyle duplicate ()
Duplicates the TableStyle.

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

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceApplication
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.

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the TableStyle.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.allTableStyles

Document.allTableStyles

Table.appliedTableStyle

TableStyle.basedOn

TableStyleGroup.allTableStyles

XMLExportMap.mappedStyle

XMLImportMap.mappedStyle

Used in:

void TableStyle.remove ([replacingWith: TableStyle])

TableStyle TableStyles.nextItem (obj: TableStyle)

TableStyle TableStyles.previousItem (obj: TableStyle)

Return

TableStyle TableStyle.duplicate ()

Array of TableStyle TableStyle.getElements ()

TableStyle TableStyle.move (to: LocationOptions[, reference: varies])

TableStyle TableStyles.[] (index: number)

TableStyle TableStyles.add ([withProperties: Object])

TableStyle TableStyles.anyItem ()

Array of TableStyle TableStyles.everyItem ()

TableStyle TableStyles.firstItem ()

TableStyle TableStyles.item (index: varies)

TableStyle TableStyles.itemByID (id: number)

TableStyle TableStyles.itemByName (name: string)

Array of TableStyle TableStyles.itemByRange (from: varies, to: varies)

TableStyle TableStyles.lastItem ()

TableStyle TableStyles.middleItem ()

TableStyle TableStyles.nextItem (obj: TableStyle)

TableStyle TableStyles.previousItem (obj: TableStyle)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index