Table

A table.

Go to Property Listing | Method Listing

Methods:

convertToText, createOutlines, remove, search, select, unmerge

Objects:

AlternatingFillsTypes, Boolean, Buttons, Cells, Columns, FormFields, Graphic, GraphicLines, Groups, HeaderFooterBreakTypes, Number, Object, Ovals, PageItem, PageItems, Polygons, Rectangles, Rows, SpecialCharacters, String, StrokeOrderTypes, StrokeStyle, Swatch, TextFrames,

Property Listing

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 AlternatingFillsTypes.ALTERNATING_COLUMNS AlternatingFillsTypes.ALTERNATING_ROWS AlternatingFillsTypes.NO_ALTERNATING_PATTERN	read/write	The pattern for alternating fills.
bodyRowCount	Number	read/write	Number of table body rows
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	read/write	The stroke type of the bottom border
bottomBorderStrokeWeight	Number String	read/write	The stroke weight of the bottom border stroke.
breakFooters	HeaderFooterBreakTypes HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS HeaderFooterBreakTypes.ONCE_PER_PAGE HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME	read/write	The footer placement.
breakHeaders	HeaderFooterBreakTypes HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS HeaderFooterBreakTypes.ONCE_PER_PAGE HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME	read/write	The header placement.
buttons	Buttons Button	readonly	A collection of buttons.
cells	Cells Cell	readonly	A collection of table cells.
columnCount	Number	read/write	The number of columns
columnFillsPriority	Boolean	read/write	If true, hides alternating row fills. If false, hides alternating column fills.
columns	Columns Column	readonly	A collection of table columns.
contents	String SpecialCharacters SpecialCharacters.AUTO_PAGE_NUMBER SpecialCharacters.BULLET_CHARACTER SpecialCharacters.COLUMN_BREAK SpecialCharacters.COPYRIGHT_SYMBOL SpecialCharacters.DEGREE_SYMBOL SpecialCharacters.DISCRETIONARY_HYPHEN SpecialCharacters.DOUBLE_LEFT_QUOTE SpecialCharacters.DOUBLE_RIGHT_QUOTE SpecialCharacters.ELLIPSIS_CHARACTER SpecialCharacters.EM_DASH SpecialCharacters.EM_SPACE SpecialCharacters.END_NESTED_STYLE SpecialCharacters.EN_DASH SpecialCharacters.EN_SPACE SpecialCharacters.EVEN_PAGE_BREAK SpecialCharacters.FIGURE_SPACE SpecialCharacters.FLUSH_SPACE SpecialCharacters.FORCED_LINE_BREAK SpecialCharacters.FRAME_BREAK SpecialCharacters.HAIR_SPACE SpecialCharacters.INDENT_HERE_TAB SpecialCharacters.NEXT_PAGE_NUMBER SpecialCharacters.NONBREAKING_HYPHEN SpecialCharacters.NONBREAKING_SPACE SpecialCharacters.ODD_PAGE_BREAK SpecialCharacters.PAGE_BREAK SpecialCharacters.PARAGRAPH_SYMBOL SpecialCharacters.PREVIOUS_PAGE_NUMBER SpecialCharacters.PUNCTUATION_SPACE SpecialCharacters.REGISTERED_TRADEMARK SpecialCharacters.RIGHT_INDENT_TAB SpecialCharacters.SECTION_MARKER SpecialCharacters.SECTION_SYMBOL SpecialCharacters.SINGLE_LEFT_QUOTE SpecialCharacters.SINGLE_RIGHT_QUOTE SpecialCharacters.THIN_SPACE SpecialCharacters.TRADEMARK_SYMBOL	read/write	The text contents. Can return: String or SpecialCharacters enumerator.
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	read/write	The stroke type of columns in the second alternating columns group
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 String	read/write	The gap tint (as a percentage) of the gap color of rows in the second alternating rows group
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 String	read/write	The tint of the color of rows in the second alternating row strokes group
endRowStrokeType	StrokeStyle	read/write	The stroke type of rows in the second alternating row strokes group
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.
footerRowCount	Number	read/write	Number of table footer rows
formFields	FormFields FormField	readonly	A collection of form fields.
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
groups	Groups Group	readonly	A collection of groups.
headerRowCount	Number	read/write	Number of table header rows
height	Number String	read/write	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	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	read/write	The stroke type of the left border.
leftBorderStrokeWeight	Number String	read/write	The stroke weight of the left border stroke.
ovals	Ovals Oval	readonly	A collection of ellipses.
pageItems	PageItems PageItem	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	Cell Character InsertionPoint Line Paragraph Story Text TextColumn Word TextFrame TextStyleRange	readonly	The parent of the Table (a TextFrame, Text, Character, Word, Line, Paragraph, TextColumn, InsertionPoint, Story, Cell or TextStyleRange).
polygons	Polygons Polygon	readonly	A collection of polygons.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
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	read/write	The stroke type of the table's right border.
rightBorderStrokeWeight	Number String	read/write	The stroke weight of the right border stroke.
rows	Rows Row	readonly	A collection of table rows.
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.
skipFirstHeader	Boolean	read/write	If true, skips the first occurrence of header rows.
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.
skipLastFooter	Boolean	read/write	If true, skips the last occurrence of footer rows.
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	read/write	The stroke type of columns in the first alternating columns group
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	read/write	The stroke type of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
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.
storyOffset	Number	readonly	The index of the character containing the table (from the beginning of the story).
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.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
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	read/write	The stroke type of the table's top border.
topBorderStrokeWeight	Number String	read/write	The stroke weight of the table's top border stroke.
width	Number String	read/write	The width of the Table. For a table or row, specifies the sum of the column widths.

Method Listing

Text convertToText (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)

PageItem createOutlines ([deleteOriginal:Boolean=Boolean])

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	Boolean	If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true)

Parameter

Type

Description

deleteOriginal

Boolean

If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)

(default: true)

undefined remove ()

Deletes the Table.

Text search (for:String, wholeWord:Boolean, caseSensitive:Boolean, replacingWith:String, withFindAttributes:Object, withChangeAttributes:Object)

Look for occurrences of text that matches specific criteria

Parameter	Type	Description
for	String	What to look for (Optional)
wholeWord	Boolean	If true, then disregard text embedded within a larger word (Optional)
caseSensitive	Boolean	If true, then search only for text that matches case (Optional)
replacingWith	String	What to replace the found text with, either a string or a special character (Optional)
withFindAttributes	Object	A record of find preference settings to use (Optional)
withChangeAttributes	Object	A record of change preference settings to use (Optional)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Select this object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE	How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE

How to handle the existing selection (Optional)

(default: SelectionOptions.REPLACE)

Cell unmerge ()

Unmerges all merged cells in the Table.