Table

A table.

Properties

Property	Type	Access	Description
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Table.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Table.
alternatingFills	AlternatingFillsTypes : NO_ALTERNATING_PATTERN ALTERNATING_ROWS ALTERNATING_COLUMNS	r/w	The pattern for alternating fills.
appliedTableStyle	TableStyle	r/w	The table style applied to the table. Can also accept: String.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Table.
bodyRowCount	number	r/w	The number of body rows.
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	StrokeStyle	r/w	The stroke type of the bottom border. Can also accept: String.
bottomBorderStrokeWeight	number	r/w	The stroke weight of the bottom border stroke.
breakFooters	HeaderFooterBreakTypes : IN_ALL_TEXT_COLUMNS ONCE_PER_TEXT_FRAME ONCE_PER_PAGE	r/w	The footer placement.
breakHeaders	HeaderFooterBreakTypes : IN_ALL_TEXT_COLUMNS ONCE_PER_TEXT_FRAME ONCE_PER_PAGE	r/w	The header placement.
buttons	Buttons	readonly	A collection of buttons.
cells	Cells	readonly	A collection of table cells.
columnCount	number	r/w	The number of columns.
columnFillsPriority	bool	r/w	If true, hides alternating row fills. If false, hides alternating column fills.
columns	Columns	readonly	A collection of table columns.
contents	Array of any	r/w	The contents to place in cells, specified as an array whose first item populates the top left cell and whose second item populates the next cell to the right, and so on until each cell in the top row is populated, at which point the next item populates the left-most cell in the second row, and so on. Note: If the array contains fewer strings than the table contains cells, the remaining cells are left blank. Can return: Array of Strings or SpecialCharacters enumerators. Can also accept: Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators.
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	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	number	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	StrokeStyle	r/w	The stroke type of rows in the second alternating strokes group. Can also accept: String.
endRowStrokeWeight	number	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.
footerRowCount	number	r/w	The number of footer rows.
formFields	FormFields	readonly	A collection of form fields.
graphicLines	GraphicLines	readonly	A collection of graphic lines.
groups	Groups	readonly	A collection of groups.
headerRowCount	number	r/w	The number of header rows.
height	number	r/w	The height of the Table. For a table or column, specifies the sum of the row heights.
id	number	readonly	The unique ID of the Table.
index	number	readonly	The index of the Table within its containing object.
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	StrokeStyle	r/w	The stroke type of the left border. Can also accept: String.
leftBorderStrokeWeight	number	r/w	The stroke weight of the left border stroke.
ovals	Ovals	readonly	A collection of ellipses.
pageItems	PageItems	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
parent	any	readonly	The parent of the Table (a XmlStory, XMLElement, TextFrame, Text, Character, Word, Line, Paragraph, TextColumn, InsertionPoint, Story, Cell or TextStyleRange).
polygons	Polygons	readonly	A collection of polygons.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rectangles	Rectangles	readonly	A collection of rectangles.
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	StrokeStyle	r/w	The stroke type of the right border. Can also accept: String.
rightBorderStrokeWeight	number	r/w	The stroke weight of the right border stroke.
rows	Rows	readonly	A collection of table rows.
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. For information on body rows, see body row count.
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. For information on body rows, see body row count.
skipFirstHeader	bool	r/w	If true, skips the first occurrence of header rows.
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. For information on body rows, see body row count.
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. For information on body rows, see body row count.
skipLastFooter	bool	r/w	If true, skips the last occurrence of footer rows.
spaceAfter	number	r/w	The space below the table.
spaceBefore	number	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	StrokeStyle	r/w	The stroke type of columns in the first alternating strokes group. Can also accept: String.
startColumnStrokeWeight	number	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	StrokeStyle	r/w	The stroke type of rows in the first alternating strokes group. Can also accept: String.
startRowStrokeWeight	number	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.
storyOffset	InsertionPoint	readonly	The location of the Table in the parent story.
strokeOrder	StrokeOrderTypes : ROW_ON_TOP COLUMN_ON_TOP BEST_JOINS INDESIGN_2_COMPATIBILITY	r/w	The order in which to display row and column strokes at corners.
textFrames	TextFrames	readonly	A collection of text frames.
textVariableInstances	TextVariableInstances	readonly	A collection of text variable instances.
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	StrokeStyle	r/w	The stroke type of the top border. Can also accept: String.
topBorderStrokeWeight	number	r/w	The stroke weight of the table’s top border stroke.
width	number	r/w	The width of the Table. For a table or row, specifies the sum of the column widths.

Methods

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

Array of TextchangeGlyph ([reverseOrder:
bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextchangeGrep ([reverseOrder:
bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextchangeText ([reverseOrder:
bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void clearTableStyleOverrides ()
Clear Table Style Overrides

void convertBulletsAndNumberingToText ()
Convert bullets and numbering to text.

TextconvertToText ([columnSeparator:
string][, rowSeparator:
string])
Converts the table to text.

Parameter	Type	Description
columnSeparator	string	The character to insert between the each column’s content in the converted text. Note: Can be defined as any single character, such as a letter, number, or punctuation mark, or by typing a space or tab. Use the actual character rather than its name, such as ‘,’ rather than ‘Comma’. Precede double or single quotes or a backslash with an extra backslash as an escape character. For paragraphs, use ^p. (Optional)
rowSeparator	string	The character to use to separate each row’s content in the converted text. Note: Can be defined as any single character, such as a letter, number, or punctuation mark, or by typing a space or tab. Use the actual character rather than its name, such as , rather than Comma. Precede double or single quotes or a backslash with an extra backslash as an escape character. For paragraphs, use ^p. (Optional)

Array of PageItemcreateOutlines ([deleteOriginal:
bool=true ])
Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.

Parameter	Type	Description
deleteOriginal	bool	If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true )

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

Parameter	Type	Description
key	string	The key.

Array of TextfindGlyph ([reverseOrder:
bool])
Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextfindGrep ([reverseOrder:
bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TextfindText ([reverseOrder:
bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of TablegetElements ()
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.

void markup (using:
XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

void recompose ()
Recomposes the text in the Table.

void remove ()
Deletes the Table.

void select ([existingSelection:
SelectionOptions=REPLACE_WITH ])
Selects the Table.

Parameter	Type	Description
existingSelection	SelectionOptions : ADD_TO REMOVE_FROM REPLACE_WITH	The selection status of the Table in relation to previously selected objects. (Optional) (default: REPLACE_WITH )

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

string toSpecifier ()
Retrieves the object specifier.

Array of Cellunmerge ()
Unmerges all merged cells in the Table.

Used in:

Tables.previousItem (

obj:
Table )

Tables.nextItem (

obj:
Table )

Returned by:

Table Character.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Table InsertionPoint.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Table Line.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Table Paragraph.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Array of Table Table .getElements (

)

Table Tables.add (
[to:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object]
)

Table Tables.anyItem (

)

Array of Table Tables.everyItem (

)

Table Tables.firstItem (

)

Table Tables.item (
index:
any
)

Table Tables.itemByID (
id:
number
)

Table Tables.itemByName (
name:
string
)

Array of Table Tables.itemByRange (
from:
any, to:
any
)

Table Tables.lastItem (

)

Table Tables.middleItem (

)

Table Tables.nextItem (
obj:
Table
)

Table Tables.previousItem (
obj:
Table
)

Table Text.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Table TextColumn.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Table TextStyleRange.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Table Word.convertToTable (
[columnSeparator:
string][, rowSeparator:
string][, numberOfColumns:
number=1 ]
)

Table XMLElement.convertElementToTable (
rowTag:
XMLTag, cellTag:
XMLTag
)