Table

A table.

Methods:

addEventListener, autoTag, changeGlyph, changeGrep, changeText, changeTransliterate, clearTableStyleOverrides, convertBulletsAndNumberingToText, convertToText, createOutlines, extractLabel, findGlyph, findGrep, findText, findTransliterate, getElements, insertLabel, markup, recompose, remove, removeEventListener, select, toSource, toSpecifier, unmerge

Objects:

AlternatingFillsTypes, Boolean, Buttons, Cells, Changes, CheckBoxes, Columns, ComboBoxes, DisplayOrderOptions, EPSTexts, EndnoteTextFrames, Endnotes, EventListeners, Events, Footnotes, FormFields, Graphic, GraphicLines, Groups, HeaderFooterBreakTypes, HiddenTexts, ListBoxes, MultiStateObjects, Notes, Number, Object, Ovals, PageItem, PageItems, Polygons, RadioButtons, Rectangles, Rows, SignatureFields, SpecialCharacters, SplineItems, String, StrokeOrderTypes, StrokeStyle, Swatch, TableDirectionOptions, TableStyle, TextBoxes, TextFrames, TextVariableInstances, XMLItem,

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.

appliedTableStyle

TableStyle

String

read/write

The table style applied to the table. Can also accept: String.

associatedXMLElement

XMLItem

readonly

The XML element associated with the Table.

bodyRowCount

Number (range 1 - 10000)

read/write

The number of 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

String

read/write

The stroke type of the bottom border. Can also accept: String.

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.

changes

Changes Change

readonly

A collection of changes.

checkBoxes

CheckBoxes

readonly

A collection of checkboxes.

clipContentToGraphicCell

Boolean

read/write

If true, clips the graphic cell's content to width and height of the cell.

clipContentToTextCell

Boolean

read/write

If true, clips the text cell's content to width and height of the cell.

columnCount

Number (range 1 - 200)

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.

comboBoxes

ComboBoxes

readonly

A collection of comboboxes.

contents

Array of Strings

Array of SpecialCharacters

SpecialCharacters.ARABIC_COMMA

SpecialCharacters.ARABIC_KASHIDA

SpecialCharacters.ARABIC_QUESTION_MARK

SpecialCharacters.ARABIC_SEMICOLON

SpecialCharacters.AUTO_PAGE_NUMBER

SpecialCharacters.BULLET_CHARACTER

SpecialCharacters.COLUMN_BREAK

SpecialCharacters.COPYRIGHT_SYMBOL

SpecialCharacters.DEGREE_SYMBOL

SpecialCharacters.DISCRETIONARY_HYPHEN

SpecialCharacters.DISCRETIONARY_LINE_BREAK

SpecialCharacters.DOTTED_CIRCLE

SpecialCharacters.DOUBLE_LEFT_QUOTE

SpecialCharacters.DOUBLE_RIGHT_QUOTE

SpecialCharacters.DOUBLE_STRAIGHT_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.FIXED_WIDTH_NONBREAKING_SPACE

SpecialCharacters.FLUSH_SPACE

SpecialCharacters.FOOTNOTE_SYMBOL

SpecialCharacters.FORCED_LINE_BREAK

SpecialCharacters.FRAME_BREAK

SpecialCharacters.HAIR_SPACE

SpecialCharacters.HEBREW_GERESH

SpecialCharacters.HEBREW_GERSHAYIM

SpecialCharacters.HEBREW_MAQAF

SpecialCharacters.HEBREW_SOF_PASUK

SpecialCharacters.INDENT_HERE_TAB

SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING

SpecialCharacters.LEFT_TO_RIGHT_MARK

SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE

SpecialCharacters.NEXT_PAGE_NUMBER

SpecialCharacters.NONBREAKING_HYPHEN

SpecialCharacters.NONBREAKING_SPACE

SpecialCharacters.ODD_PAGE_BREAK

SpecialCharacters.PAGE_BREAK

SpecialCharacters.PARAGRAPH_SYMBOL

SpecialCharacters.POP_DIRECTIONAL_FORMATTING

SpecialCharacters.PREVIOUS_PAGE_NUMBER

SpecialCharacters.PUNCTUATION_SPACE

SpecialCharacters.QUARTER_SPACE

SpecialCharacters.REGISTERED_TRADEMARK

SpecialCharacters.RIGHT_INDENT_TAB

SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING

SpecialCharacters.RIGHT_TO_LEFT_MARK

SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE

SpecialCharacters.SECTION_MARKER

SpecialCharacters.SECTION_SYMBOL

SpecialCharacters.SINGLE_LEFT_QUOTE

SpecialCharacters.SINGLE_RIGHT_QUOTE

SpecialCharacters.SINGLE_STRAIGHT_QUOTE

SpecialCharacters.SIXTH_SPACE

SpecialCharacters.TEXT_VARIABLE

SpecialCharacters.THIN_SPACE

SpecialCharacters.THIRD_SPACE

SpecialCharacters.TRADEMARK_SYMBOL

SpecialCharacters.ZERO_WIDTH_JOINER

SpecialCharacters.ZERO_WIDTH_NONJOINER

NothingEnums NothingEnum

Array of SpecialCharacters enumerators. Can also accept: Strings

read/write

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.

displayCollapsed

Boolean

read/write

If true, then the table will show collapsed in story and galley views.

displayOrder

DisplayOrderOptions

DisplayOrderOptions.ORDER_BY_COLUMNS

DisplayOrderOptions.ORDER_BY_ROWS

read/write

Specifies the order the table cells will display in when viewing in story and galley views.

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

String

read/write

The stroke type of columns in the second alternating strokes group. Can also accept: String.

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 (range 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.

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 (range 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.

endRowStrokeType

StrokeStyle

String

read/write

The stroke type of rows in the second alternating strokes group. Can also accept: String.

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.

endnoteTextFrames

EndnoteTextFrames EndnoteTextFrame

readonly

A collection of endnote text frames.

endnotes

Endnotes Endnote

readonly

A collection of endnotes.

epstexts

EPSTexts EPSText

readonly

EPSTexts

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

footerRowCount

Number (range 0 - 25)

read/write

The number of footer rows.

footnotes

Footnotes Footnote

readonly

A collection of footnotes.

formFields

FormFields FormField

readonly

A collection of form fields.

graphicBottomInset

Number

String

read/write

The bottom inset of the graphic cell.

graphicLeftInset

Number

String

read/write

The left inset of the graphic cell.

graphicLines

GraphicLines GraphicLine

readonly

A collection of graphic lines.

graphicRightInset

Number

String

read/write

The right inset of the graphic cell.

graphicTopInset

Number

String

read/write

The top inset of the graphic cell.

groups

Groups Group

readonly

A collection of groups.

headerRowCount

Number (range 0 - 25)

read/write

The number of header rows.

height

Number

String

read/write

The height of the Table. For a table or column, specifies the sum of the row heights.

hiddenTexts

HiddenTexts HiddenText

readonly

A collection of hidden text objects.

id

Number

readonly

The unique ID of the Table.

index

Number

readonly

The index of the Table within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

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

String

read/write

The stroke type of the left border. Can also accept: String.

leftBorderStrokeWeight

Number

String

read/write

The stroke weight of the left border stroke.

listBoxes

ListBoxes

readonly

A collection of listboxes.

multiStateObjects

MultiStateObjects MultiStateObject

readonly

A collection of multi-state objects.

name

String

read/write

The name of the Table; this is an alias to the Table's label property.

notes

Notes Note

readonly

A collection of notes.

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

Character

EndnoteTextFrame

InsertionPoint

Line

Paragraph

Story

Text

TextColumn

TextFrame

TextStyleRange

Word

XmlStory

Cell

XMLElement

readonly

The parent of the Table (a XMLElement, XmlStory, TextFrame, EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or Cell).

polygons

Polygons Polygon

readonly

A collection of polygons.

properties

Object

read/write

A property that allows setting of several properties at the same time.

radioButtons

RadioButtons RadioButton

readonly

A collection of radio buttons.

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

String

read/write

The stroke type of the right border. Can also accept: String.

rightBorderStrokeWeight

Number

String

read/write

The stroke weight of the right border stroke.

rows

Rows Row

readonly

A collection of table rows.

signatureFields

SignatureFields SignatureField

readonly

A collection of signature fields.

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.

splineItems

SplineItems SplineItem

readonly

The spline items collection.

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

String

read/write

The stroke type of columns in the first alternating strokes group. Can also accept: String.

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

String

read/write

The stroke type of rows in the first alternating strokes group. Can also accept: String.

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

InsertionPoint

readonly

The insertion point before the table in the story containing the table.

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.

tableDirection

TableDirectionOptions

TableDirectionOptions.LEFT_TO_RIGHT_DIRECTION

TableDirectionOptions.RIGHT_TO_LEFT_DIRECTION

read/write

The direction of the the table

textBottomInset

Number

String

read/write

The bottom inset of the text cell.

textBoxes

TextBoxes

readonly

A collection of text boxes.

textFrames

TextFrames TextFrame

readonly

A collection of text frames.

textLeftInset

Number

String

read/write

The left inset of the text cell.

textRightInset

Number

String

read/write

The right inset of the text cell.

textTopInset

Number

String

read/write

The top inset of the text cell.

textVariableInstances

TextVariableInstances TextVariableInstance

readonly

A collection of text variable instances.

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

String

read/write

The stroke type of the top border. Can also accept: String.

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

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined autoTag ()

Tag the object or the parent story using default tags defined in XML preference.

Text changeGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeGrep (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeText (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value and replaces the text with the change character type value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

undefined clearTableStyleOverrides ()

Clear Table Style Overrides

undefined convertBulletsAndNumberingToText ()

Convert bullets and numbering to text.

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)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Text findGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findGrep (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findText (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Table getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined markup (using:XMLElement)

Associates the page item with the specified XML element while preserving existing content.

Parameter

Type

Description

using

XMLElement

The XML element.

undefined recompose ()

Recomposes the text in the Table.

undefined remove ()

Deletes the Table.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

SelectionOptions.SET_KEY

The selection status of the Table in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Cell unmerge ()

Unmerges all merged cells in the Table.

Object of

Cell.parent

Column.parent

Endnote.parent

Event.parent

EventListener.parent

MutationEvent.parent

Row.parent

XMLElement.xmlContent

Return

XMLElement.convertElementToTable()

Text.convertToTable()

Character.convertToTable()

Word.convertToTable()

Line.convertToTable()

TextColumn.convertToTable()

Paragraph.convertToTable()

TextStyleRange.convertToTable()

InsertionPoint.convertToTable()

Tables.add()

Table.getElements()

Tables.anyItem()

Tables.everyItem()

Tables.nextItem()

Tables.previousItem()

Tables.itemByID()

Tables.item()

Tables.[]()

Tables.itemByName()

Tables.itemByRange()

Tables.firstItem()

Tables.lastItem()

Tables.middleItem()