Adds an event listener.
Object
TableStyle
A table style.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| TableStyle | String | read/write | The style that this style is based on. Can return: TableStyle or String. | |
| CellStyle | String | read/write | The cell style of the body region. Can also accept: String. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. | |
| 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. | |
| 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. | |
| Number 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. | |
| Boolean | read/write | If true, the bottom border stroke will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the bottom border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the bottom border stroke. | |
| Boolean | read/write | If true, clips the graphic cell's content to width and height of the cell. | |
| Boolean | read/write | If true, clips the text cell's content to width and height of the cell. | |
| Boolean | read/write | If true, hides alternating row fills. If false, hides alternating column fills. | |
| 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. | |
| Number | read/write | The number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns. | |
| 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. | |
| Number 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. | |
| StrokeStyle | String | read/write | The stroke type of columns in the second alternating strokes group. Can also accept: String. | |
| 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. | |
| Number | read/write | The number of columns in the second alternating column strokes group. | |
| 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. | |
| 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. | |
| Number 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. | |
| 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. | |
| Number 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. | |
| Number | String unit | 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. | |
| 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. | |
| Number | read/write | The number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows. | |
| 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. | |
| Number 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. | |
| 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. | |
| Number | read/write | The number of rows in the second alternating row strokes group. | |
| 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. | |
| 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. | |
| Number 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. | |
| 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. | |
| Number 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. | |
| StrokeStyle | String | read/write | The stroke type of rows in the second alternating strokes group. Can also accept: String. | |
| Number | String unit | 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 |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| CellStyle | String | read/write | The cell style of the footer region. Can also accept: String. | |
| Boolean | read/write | If true, uses the cell style of the body region for the footer region. | |
| Number | String unit | read/write | The bottom inset of the graphic cell. | |
| Number | String unit | read/write | The left inset of the graphic cell. | |
| Number | String unit | read/write | The right inset of the graphic cell. | |
| Number | String unit | read/write | The top inset of the graphic cell. | |
| CellStyle | String | read/write | The cell style of the header region. Can also accept: String. | |
| Boolean | read/write | If true, use the cell style of the body region for the header region. | |
| Number | readonly | The unique ID of the TableStyle. | |
| Number | readonly | The index of the TableStyle within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| String | read/write | A property that can be set to any string. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. | |
| 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. | |
| 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. | |
| Number 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. | |
| Boolean | read/write | If true, the left border stroke will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the left border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the left border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the left border stroke. | |
| CellStyle | String | read/write | The cell style of the left column region. Can also accept: String. | |
| Boolean | read/write | If true, uses the cell style of the body region for the left column region. | |
| String | read/write | The name of the TableStyle. | |
| Application | Document | TableStyleGroup | readonly | The parent of the TableStyle (a Document, Application or TableStyleGroup). | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. | |
| 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. | |
| 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. | |
| Number 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. | |
| Boolean | read/write | If true, the right border stroke will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the right border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the right border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the right border stroke. | |
| CellStyle | String | read/write | The cell style of the right column region. Can also accept: String. | |
| Boolean | read/write | If true, uses the cell style of the body region for the right column region. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| Number | String unit | read/write | The space below the table. | |
| Number | String unit | read/write | The space above the table. | |
| 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. | |
| Number | read/write | The number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns. | |
| 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. | |
| Number 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. | |
| 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. | |
| Number | read/write | The number of columns in the first alternating column strokes group. | |
| 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. | |
| 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. | |
| Number 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. | |
| 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. | |
| Number 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. | |
| StrokeStyle | String | read/write | The stroke type of columns in the first alternating strokes group. Can also accept: String. | |
| Number | String unit | 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. | |
| 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. | |
| Number | read/write | The number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows. | |
| 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. | |
| Number 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. | |
| 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. | |
| Number | read/write | The number of rows in the first alternating row strokes group. | |
| 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. | |
| 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. | |
| Number 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. | |
| 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. | |
| Number 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. | |
| StrokeStyle | String | read/write | The stroke type of rows in the first alternating strokes group. Can also accept: String. | |
| Number | String unit | 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. | |
| StrokeOrderTypes | read/write | The order in which to display row and column strokes at corners. | |
| Number | String unit | read/write | The bottom inset of the text cell. | |
| Number | String unit | read/write | The left inset of the text cell. | |
| Number | String unit | read/write | The right inset of the text cell. | |
| Number | String unit | read/write | The top inset of the text cell. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. | |
| 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. | |
| 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. | |
| Number 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. | |
| Boolean | read/write | If true, the top border strokes will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the table's top border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the top border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the table's top border stroke. |
Methods
Duplicates the TableStyle.
→ String
Gets the label value associated with the specified key.
→ TableStyle[]
Resolves the object specifier, creating an array of object references.
→ void
Sets the label to the value associated with the specified key.
Moves the style to the specified location.
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.
→ void
Deletes the style.
→ Boolean
Removes the event listener.
→ String
Generates a string which, if executed, will return the TableStyle.
→ String
Retrieves the object specifier.
Object of 10
Properties elsewhere that hold a TableStyle.
Parameter of 15
Method parameters that accept a TableStyle.
CellStyle.move(reference)CellStyleGroup.move(reference)CharacterStyle.move(reference)CharacterStyleGroup.move(reference)ParagraphStyle.move(reference)ParagraphStyleGroup.move(reference)TableStyle.move(reference)TableStyle.remove(replacingWith)TableStyleGroup.move(reference)TableStyles.itemByRange(from)TableStyles.nextItem(obj)TableStyles.previousItem(obj)XMLElement.applyTableStyle(using)XMLExportMaps.add(mappedStyle)XMLImportMaps.add(mappedStyle)
Return 16
Methods that return a TableStyle.
TableStyle.duplicate()TableStyle.getElements()TableStyle.move()TableStyles.[]()TableStyles.add()TableStyles.anyItem()TableStyles.everyItem()TableStyles.firstItem()TableStyles.item()TableStyles.itemByID()TableStyles.itemByName()TableStyles.itemByRange()TableStyles.lastItem()TableStyles.middleItem()TableStyles.nextItem()TableStyles.previousItem()