Class

Table

 A table.

QuickLinks

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

Hierarchy

Cell | Character | InsertionPoint | Line | Paragraph | Story | Text | TextColumn | TextFrame | TextStyleRange | Word | XMLElement | XmlStory
Table
Cell | Column | Event | EventListener | MutationEvent | Row

Properties

PropertyTypeAccessDescription
allGraphicsArray of Graphic readonlyLists all graphics contained by the Table.
allPageItemsArray of PageItem readonlyLists all page items contained by the Table.
alternatingFillsAlternatingFillsTypes:
AlternatingFillsTypes.NO_ALTERNATING_PATTERN
AlternatingFillsTypes.ALTERNATING_ROWS
AlternatingFillsTypes.ALTERNATING_COLUMNS
r/wThe pattern for alternating fills.
appliedTableStyleString
TableStyle
r/wThe table style applied to the table. Can also accept: String.
associatedXMLElementXMLItem readonlyThe XML element associated with the Table.
bodyRowCountnumber (range: 1 - 10000) r/wThe number of body rows.
bottomBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke.
bottomBorderStrokeGapColorSwatch r/wThe gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapOverprintbool r/wIf true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of the bottom border stroke. (Range: 0 to 100) Note: Valid only when bottom border stroke type is not solid.
bottomBorderStrokeOverprintbool r/wIf true, the bottom border stroke will overprint.
bottomBorderStrokeTintnumber r/wThe tint (as a percentage) of the bottom border stroke. (Range: 0 to 100)
bottomBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the bottom border. Can also accept: String.
bottomBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the bottom border stroke.
breakFootersHeaderFooterBreakTypes:
HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS
HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME
HeaderFooterBreakTypes.ONCE_PER_PAGE
r/wThe footer placement.
breakHeadersHeaderFooterBreakTypes:
HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS
HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME
HeaderFooterBreakTypes.ONCE_PER_PAGE
r/wThe header placement.
buttonsButtons readonlyA collection of buttons.
cellsCells readonlyA collection of table cells.
changesChanges readonlyA collection of changes.
checkBoxesCheckBoxes readonlyA collection of checkboxes.
columnCountnumber (range: 1 - 200) r/wThe number of columns.
columnFillsPrioritybool r/wIf true, hides alternating row fills. If false, hides alternating column fills.
columnsColumns readonlyA collection of table columns.
comboBoxesComboBoxes readonlyA collection of comboboxes.
contentsArray of
SpecialCharacters
Strings
r/wThe 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.
displayCollapsedbool r/wIf true, then the table will show collapsed in story and galley views.
displayOrderDisplayOrderOptions:
DisplayOrderOptions.ORDER_BY_ROWS
DisplayOrderOptions.ORDER_BY_COLUMNS
r/wSpecifies the order the table cells will display in when viewing in story and galley views.
endColumnFillColorSwatch r/wThe fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the second alternating fill group. Note: Valid when alternating fills are defined for table columns.
endColumnFillCountnumber r/wThe number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns.
endColumnFillOverprintbool r/wIf true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
endColumnFillTintnumber r/wThe tint (as a percentage) of the columns in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns.
endColumnLineStyleString
StrokeStyle
r/wThe stroke type of columns in the second alternating strokes group. Can also accept: String.
endColumnStrokeColorSwatch r/wThe stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeCountnumber r/wThe number of columns in the second alternating column strokes group.
endColumnStrokeGapColorSwatch r/wThe stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeGapOverprintbool r/wIf true, the gap of the column border stroke in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeOverprintbool r/wIf true, the column borders in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeTintnumber r/wThe tint (as a percentage) of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater.
endColumnStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater.
endRowFillColorSwatch r/wThe fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillCountnumber r/wThe number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows.
endRowFillOverprintbool r/wIf true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
endRowFillTintnumber r/wThe tint (as a percentage) of the rows in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows.
endRowStrokeColorSwatch r/wThe stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeCountnumber r/wThe number of rows in the second alternating row strokes group.
endRowStrokeGapColorSwatch r/wThe gap color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating rows group. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeGapOverprintbool r/wIf true, the gap of the row borders in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of rows in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater and end row stroke type is not solid.
endRowStrokeOverprintbool r/wIf true, the rows in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater.
endRowStrokeTintnumber r/wThe tint (as a percentage) of the row borders in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater.
endRowStrokeTypeString
StrokeStyle
r/wThe stroke type of rows in the second alternating strokes group. Can also accept: String.
endRowStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater.
epstextsEPSTexts readonlyEPSTexts
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
footerRowCountnumber (range: 0 - 25) r/wThe number of footer rows.
formFieldsFormFields readonlyA collection of form fields.
graphicLinesGraphicLines readonlyA collection of graphic lines.
groupsGroups readonlyA collection of groups.
headerRowCountnumber (range: 0 - 25) r/wThe number of header rows.
heightMeasurement Unit (Number or String) r/wThe height of the Table. For a table or column, specifies the sum of the row heights.
hiddenTextsHiddenTexts readonlyA collection of hidden text objects.
idnumber readonlyThe unique ID of the Table.
indexnumber readonlyThe index of the Table within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
leftBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke.
leftBorderStrokeGapColorSwatch r/wThe gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapOverprintbool r/wIf true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid.
leftBorderStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of the left border stroke. (Range: 0 to 100) Note: Valid only when left border stroke type is not solid.
leftBorderStrokeOverprintbool r/wIf true, the left border stroke will overprint.
leftBorderStrokeTintnumber r/wThe tint (as a percentage) of the left border stroke. (Range: 0 to 100)
leftBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the left border. Can also accept: String.
leftBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the left border stroke.
listBoxesListBoxes readonlyA collection of listboxes.
multiStateObjectsMultiStateObjects readonlyA collection of multi-state objects.
namestring r/wThe name of the Table; this is an alias to the Table's label property.
notesNotes readonlyA collection of notes.
ovalsOvals readonlyA collection of ellipses.
pageItemsPageItems readonlyThe 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.
parentCell
Character
InsertionPoint
Line
Paragraph
Story
Text
TextColumn
TextFrame
TextStyleRange
Word
XMLElement
XmlStory
readonlyThe parent of the Table (a XMLElement, XmlStory, TextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or Cell).
polygonsPolygons readonlyA collection of polygons.
propertiesObject r/wA property that allows setting of several properties at the same time.
radioButtonsRadioButtons readonlyA collection of radio buttons.
rectanglesRectangles readonlyA collection of rectangles.
rightBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke.
rightBorderStrokeGapColorSwatch r/wThe gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. Note: Valid only when right border stroke type is not solid.
rightBorderStrokeGapOverprintbool r/wIf true, the gap color of the right border stroke will overprint. Note: Valid only when right border stroke type is not solid.
rightBorderStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of the right border stroke. (Range: 0 to 100) Note: Valid only when right border stroke type is not solid.
rightBorderStrokeOverprintbool r/wIf true, the right border stroke will overprint.
rightBorderStrokeTintnumber r/wThe tint (as a percentage) of the right border stroke. (Range: 0 to 100)
rightBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the right border. Can also accept: String.
rightBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the right border stroke.
rowsRows readonlyA collection of table rows.
signatureFieldsSignatureFields readonlyA collection of signature fields.
skipFirstAlternatingFillColumnsnumber r/wThe number of columns on the left side of the table to skip before applying the column fill color. Note: Valid when alternating fills are defined for table columns.
skipFirstAlternatingFillRowsnumber r/wThe number of body rows at the beginning of the table to skip before applying the row fill color. Note: Valid when alternating fills are defined for table rows.
skipFirstAlternatingStrokeColumnsnumber r/wThe number of columns on the left of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater.
skipFirstAlternatingStrokeRowsnumber r/wThe number of body rows at the beginning of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater.
skipFirstHeaderbool r/wIf true, skips the first occurrence of header rows.
skipLastAlternatingFillColumnsnumber r/wThe number columns on the right side of the table in which to not apply the column fill color. Note: Valid when alternating fills are defined for table columns.
skipLastAlternatingFillRowsnumber r/wThe number of body rows at the end of the table in which to not apply the row fill color. Note: Valid when alternating fills are defined for table rows.
skipLastAlternatingStrokeColumnsnumber r/wThe number of columns on the right side of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater.
skipLastAlternatingStrokeRowsnumber r/wThe number of body rows at the end of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater.
skipLastFooterbool r/wIf true, skips the last occurrence of footer rows.
spaceAfterMeasurement Unit (Number or String) r/wThe space below the table.
spaceBeforeMeasurement Unit (Number or String) r/wThe space above the table.
splineItemsSplineItems readonlyThe spline items collection.
startColumnFillColorSwatch r/wThe fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillCountnumber r/wThe number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns.
startColumnFillOverprintbool r/wIf true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns.
startColumnFillTintnumber r/wThe tint (as a percentage) of the columns in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns.
startColumnStrokeColorSwatch r/wThe stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group.
startColumnStrokeCountnumber r/wThe number of columns in the first alternating column strokes group.
startColumnStrokeGapColorSwatch r/wThe stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeGapOverprintbool r/wIf true, the gap of the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeOverprintbool r/wIf true, the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeTintnumber r/wThe tint (as a percentage) of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater.
startColumnStrokeTypeString
StrokeStyle
r/wThe stroke type of columns in the first alternating strokes group. Can also accept: String.
startColumnStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater.
startRowFillColorSwatch r/wThe fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillCountnumber r/wThe number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows.
startRowFillOverprintbool r/wIf true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows.
startRowFillTintnumber r/wThe tint (as a percentage) of the rows in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows.
startRowStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeCountnumber r/wThe number of rows in the first alternating row strokes group.
startRowStrokeGapColorSwatch r/wThe stroke gap color of row borders in the first alternating row strokes group, specified as a swatch (color, gradient, tint, or mixed ink). Note: Valid when start row stroke count is 1 or greater.
startRowStrokeGapOverprintbool r/wIf true, the gap color of the row border stroke in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of row borders in the first alternating rows group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater.
startRowStrokeOverprintbool r/wIf true, the row borders in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater.
startRowStrokeTintnumber r/wThe tint (as a percentage) of the borders in the first alternating row strokes group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater.
startRowStrokeTypeString
StrokeStyle
r/wThe stroke type of rows in the first alternating strokes group. Can also accept: String.
startRowStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater.
storyOffsetInsertionPoint readonlyThe insertion point before the table in the story containing the table.
strokeOrderStrokeOrderTypes:
StrokeOrderTypes.ROW_ON_TOP
StrokeOrderTypes.COLUMN_ON_TOP
StrokeOrderTypes.BEST_JOINS
StrokeOrderTypes.INDESIGN_2_COMPATIBILITY
r/wThe order in which to display row and column strokes at corners.
tableDirectionTableDirectionOptions:
TableDirectionOptions.LEFT_TO_RIGHT_DIRECTION
TableDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wThe direction of the the table
textBoxesTextBoxes readonlyA collection of text boxes.
textFramesTextFrames readonlyA collection of text frames.
textVariableInstancesTextVariableInstances readonlyA collection of text variable instances.
topBorderStrokeColorSwatch r/wThe color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke.
topBorderStrokeGapColorSwatch r/wThe gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapOverprintbool r/wIf true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid.
topBorderStrokeGapTintnumber r/wThe tint (as a percentage) of the gap color of the table's top border stroke. (Range: 0 to 100) Note: Valid only when top border stroke type is not solid.
topBorderStrokeOverprintbool r/wIf true, the top border strokes will overprint.
topBorderStrokeTintnumber r/wThe tint (as a percentage) of the table's top border stroke. (Range: 0 to 100)
topBorderStrokeTypeString
StrokeStyle
r/wThe stroke type of the top border. Can also accept: String.
topBorderStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the table's top border stroke.
widthMeasurement Unit (Number or String) r/wThe width of the Table. For a table or row, specifies the sum of the column widths.

Methods

Instances

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

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

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

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

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

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

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

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

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

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

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

void clearTableStyleOverrides ()
Clear Table Style Overrides

void convertBulletsAndNumberingToText ()
Convert bullets and numbering to text.

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

ParameterTypeDescription
columnSeparatorstringThe 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)
rowSeparatorstringThe 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 PageItem createOutlines ([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.

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

ParameterTypeDescription
keystringThe key.

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

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

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

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

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

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

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

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

Array of Table getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
usingXMLElementThe XML element.

void recompose ()
Recomposes the text in the Table.

void remove ()
Deletes the Table.

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

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

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

ParameterTypeDescription
existingSelectionSelectionOptions:
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.

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

Element of

Column.parent

Row.parent

XMLElement.xmlContent

Used in:

Table Tables.nextItem (obj: Table)

Table Tables.previousItem (obj: Table)

Return

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.[] (index: number)

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

Table Tables.anyItem ()

Array of Table Tables.everyItem ()

Table Tables.firstItem ()

Table Tables.item (index: varies)

Table Tables.itemByID (id: number)

Table Tables.itemByName (name: string)

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

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)

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