Adds an event listener.
Object
Table
A table.
Hierarchy
Cell | Character | EndnoteTextFrame | InsertionPoint | Line | Paragraph | Story | Text | TextColumn | TextFrame | TextStyleRange | Word | XMLElement | XmlStory
Table
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Graphic[] | readonly | Lists all graphics contained by the Table. | |
| PageItem[] | readonly | Lists all page items contained by the Table. | |
| AlternatingFillsTypes | read/write | The pattern for alternating fills. | |
| TableStyle | String | read/write | The table style applied to the table. Can also accept: String. | |
| XMLItem | readonly | The XML element associated with the Table. | |
| Number 1–10000 | read/write | The number of body rows. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. | |
| Swatch | read/write | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. Note: Valid only when bottom border stroke type is not solid. | |
| Boolean | read/write | If true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of the bottom border stroke. (Range: 0 to 100) Note: Valid only when bottom border stroke type is not solid. | |
| Boolean | read/write | If true, the bottom border stroke will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the bottom border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the bottom border stroke. | |
| HeaderFooterBreakTypes | read/write | The footer placement. | |
| HeaderFooterBreakTypes | read/write | The header placement. | |
| Buttons |
readonly | A collection of buttons. | |
| Cells |
readonly | A collection of table cells. | |
| Changes |
readonly | A collection of changes. | |
| CheckBoxes |
readonly | A collection of checkboxes. | |
| Boolean | read/write | If true, clips the graphic cell's content to width and height of the cell. | |
| Boolean | read/write | If true, clips the text cell's content to width and height of the cell. | |
| Number 1–200 | read/write | The number of columns. | |
| Boolean | read/write | If true, hides alternating row fills. If false, hides alternating column fills. | |
| Columns |
readonly | A collection of table columns. | |
| ComboBoxes |
readonly | A collection of comboboxes. | |
| Strings[] | Strings[] | SpecialCharacters[] | NothingEnums[] | SpecialCharacters[] | 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. | |
| Boolean | read/write | If true, then the table will show collapsed in story and galley views. | |
| DisplayOrderOptions | read/write | Specifies the order the table cells will display in when viewing in story and galley views. | |
| Swatch | read/write | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the second alternating fill group. Note: Valid when alternating fills are defined for table columns. | |
| Number | read/write | The number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns. | |
| Boolean | read/write | If true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns. | |
| Number 0–100 | read/write | The tint (as a percentage) of the columns in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns. | |
| StrokeStyle | String | read/write | The stroke type of columns in the second alternating strokes group. Can also accept: String. | |
| Swatch | read/write | The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater. | |
| Number | read/write | The number of columns in the second alternating column strokes group. | |
| Swatch | read/write | The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater. | |
| Boolean | read/write | If true, the gap of the column border stroke in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater. | |
| Boolean | read/write | If true, the column borders in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater. | |
| Number | String unit | read/write | The stroke weight of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater. | |
| Swatch | read/write | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows. | |
| Number | read/write | The number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows. | |
| Boolean | read/write | If true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows. | |
| Number 0–100 | read/write | The tint (as a percentage) of the rows in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows. | |
| Swatch | read/write | The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater. | |
| Number | read/write | The number of rows in the second alternating row strokes group. | |
| Swatch | read/write | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating rows group. Note: Valid when end row stroke count is 1 or greater. | |
| Boolean | read/write | If true, the gap of the row borders in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of rows in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater and end row stroke type is not solid. | |
| Boolean | read/write | If true, the rows in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of the row borders in the second alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 or greater. | |
| StrokeStyle | String | read/write | The stroke type of rows in the second alternating strokes group. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater. | |
| EndnoteTextFrames |
readonly | A collection of endnote text frames. | |
| Endnotes |
readonly | A collection of endnotes. | |
| EPSTexts |
readonly | EPSTexts | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| Number 0–25 | read/write | The number of footer rows. | |
| Footnotes |
readonly | A collection of footnotes. | |
| FormFields |
readonly | A collection of form fields. | |
| Number | String unit | read/write | The bottom inset of the graphic cell. | |
| Number | String unit | read/write | The left inset of the graphic cell. | |
| GraphicLines |
readonly | A collection of graphic lines. | |
| Number | String unit | read/write | The right inset of the graphic cell. | |
| Number | String unit | read/write | The top inset of the graphic cell. | |
| Groups |
readonly | A collection of groups. | |
| Number 0–25 | read/write | The number of header rows. | |
| Number | String unit | read/write | The height of the Table. For a table or column, specifies the sum of the row heights. | |
| Number | readonly | The unique ID of the Table. | |
| Number | readonly | The index of the Table within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| String | read/write | A property that can be set to any string. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. | |
| Swatch | read/write | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. Note: Valid only when left border stroke type is not solid. | |
| Boolean | read/write | If true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of the left border stroke. (Range: 0 to 100) Note: Valid only when left border stroke type is not solid. | |
| Boolean | read/write | If true, the left border stroke will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the left border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the left border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the left border stroke. | |
| ListBoxes |
readonly | A collection of listboxes. | |
| Text[] | readonly | All MathZones in range; returns vector of Text objects for each MathZone | |
| MultiStateObjects |
readonly | A collection of multi-state objects. | |
| String | read/write | The name of the Table; this is an alias to the Table's label property. | |
| Notes |
readonly | A collection of notes. | |
| Ovals |
readonly | A collection of ellipses. | |
| 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. | |
| 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 |
readonly | A collection of polygons. | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| RadioButtons |
readonly | A collection of radio buttons. | |
| Rectangles |
readonly | A collection of rectangles. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. | |
| Swatch | read/write | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. Note: Valid only when right border stroke type is not solid. | |
| Boolean | read/write | If true, the gap color of the right border stroke will overprint. Note: Valid only when right border stroke type is not solid. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of the right border stroke. (Range: 0 to 100) Note: Valid only when right border stroke type is not solid. | |
| Boolean | read/write | If true, the right border stroke will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the right border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the right border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the right border stroke. | |
| Rows |
readonly | A collection of table rows. | |
| SignatureFields |
readonly | A collection of signature fields. | |
| Number | read/write | The number of columns on the left side of the table to skip before applying the column fill color. Note: Valid when alternating fills are defined for table columns. | |
| Number | read/write | The number of body rows at the beginning of the table to skip before applying the row fill color. Note: Valid when alternating fills are defined for table rows. | |
| Number | read/write | The number of columns on the left of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater. | |
| Number | read/write | The number of body rows at the beginning of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater. | |
| Boolean | read/write | If true, skips the first occurrence of header rows. | |
| Number | read/write | The number columns on the right side of the table in which to not apply the column fill color. Note: Valid when alternating fills are defined for table columns. | |
| Number | read/write | The number of body rows at the end of the table in which to not apply the row fill color. Note: Valid when alternating fills are defined for table rows. | |
| Number | read/write | The number of columns on the right side of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater. | |
| Number | read/write | The number of body rows at the end of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater. | |
| Boolean | read/write | If true, skips the last occurrence of footer rows. | |
| Number | String unit | read/write | The space below the table. | |
| Number | String unit | read/write | The space above the table. | |
| SplineItems |
readonly | The spline items collection. | |
| Swatch | read/write | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns. | |
| Number | read/write | The number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns. | |
| Boolean | read/write | If true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns. | |
| Number 0–100 | read/write | The tint (as a percentage) of the columns in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns. | |
| Swatch | read/write | The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. | |
| Number | read/write | The number of columns in the first alternating column strokes group. | |
| Swatch | read/write | The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater. | |
| Boolean | read/write | If true, the gap of the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater. | |
| Boolean | read/write | If true, the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater. | |
| StrokeStyle | String | read/write | The stroke type of columns in the first alternating strokes group. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater. | |
| Swatch | read/write | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows. | |
| Number | read/write | The number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows. | |
| Boolean | read/write | If true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows. | |
| Number 0–100 | read/write | The tint (as a percentage) of the rows in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater. | |
| Number | read/write | The number of rows in the first alternating row strokes group. | |
| Swatch | read/write | The stroke gap color of row borders in the first alternating row strokes group, specified as a swatch (color, gradient, tint, or mixed ink). Note: Valid when start row stroke count is 1 or greater. | |
| Boolean | read/write | If true, the gap color of the row border stroke in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of row borders in the first alternating rows group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater. | |
| Boolean | read/write | If true, the row borders in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater. | |
| Number 0–100 | read/write | The tint (as a percentage) of the borders in the first alternating row strokes group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater. | |
| StrokeStyle | String | read/write | The stroke type of rows in the first alternating strokes group. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater. | |
| InsertionPoint | readonly | The insertion point before the table in the story containing the table. | |
| StrokeOrderTypes | read/write | The order in which to display row and column strokes at corners. | |
| TableDirectionOptions | read/write | The direction of the the table | |
| Number | String unit | read/write | The bottom inset of the text cell. | |
| TextBoxes |
readonly | A collection of text boxes. | |
| TextFrames |
readonly | A collection of text frames. | |
| Number | String unit | read/write | The left inset of the text cell. | |
| Number | String unit | read/write | The right inset of the text cell. | |
| Number | String unit | read/write | The top inset of the text cell. | |
| TextVariableInstances |
readonly | A collection of text variable instances. | |
| Swatch | read/write | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. | |
| Swatch | read/write | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. Note: Valid only when top border stroke type is not solid. | |
| Boolean | read/write | If true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of the table's top border stroke. (Range: 0 to 100) Note: Valid only when top border stroke type is not solid. | |
| Boolean | read/write | If true, the top border strokes will overprint. | |
| Number 0–100 | read/write | The tint (as a percentage) of the table's top border stroke. (Range: 0 to 100) | |
| StrokeStyle | String | read/write | The stroke type of the top border. Can also accept: String. | |
| Number | String unit | read/write | The stroke weight of the table's top border stroke. | |
| Number | String unit | read/write | The width of the Table. For a table or row, specifies the sum of the column widths. |
Methods
→ void
Tag the object or the parent story using default tags defined in XML preference.
→ Text[]
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
→ Text[]
Finds text that matches the find what value and replaces the text with the change to value.
→ Text[]
Finds text that matches the find what value and replaces the text with the change to value.
→ Text[]
Finds text that matches the find character type value and replaces the text with the change character type value.
→ void
Clear Table Style Overrides
→ void
Convert bullets and numbering to text.
→ Text
Converts the table to text.
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.
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.
→ PageItem[]
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.
deleteOriginal?
Boolean
If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text.
→ String
Gets the label value associated with the specified key.
→ Text[]
Finds glyphs that match the find what value.
→ Text[]
Finds text that matches the find what value.
→ Text[]
Finds text that matches the find what value.
→ Text[]
Finds text that matches the find character type value.
→ Table[]
Resolves the object specifier, creating an array of object references.
→ void
Sets the label to the value associated with the specified key.
→ void
Associates the page item with the specified XML element while preserving existing content.
→ void
adjust the leading for text lines with MathZones to avoid expression text crashing into preceding or following text lines
→ Varies
convert MTEF encoded image(s) into MathZone(s) on the given object (Story, Paragraph, Word, Character, Text, InsertionPoint) and return the resulting Text,Table,Cell object.
→ void
convert MathZone related leading for text lines in the range into InDesign text leading
→ void
Fix spacing around MathZone according to settings arg
→ Text
Get first MathZone in range; returns Text object for MathZone
→ Text
Get last MathZone in range; returns Text object for MathZone
→ Text
Get next MathZone in range relative to reference object; returns Text object for MathZone
→ Text
Get previous MathZone in range relative to reference object; returns Text object for MathZone
→ Number
refresh MathZone(s) in text range or Story; returns offset of first text index following the refreshed equation
→ void
remove MathZone related leading for text lines in the range
→ void
eliminate MathZone inline frames and place MathZone into story at the text index of the inline frame(s)
→ TextFrame[]
wrap MathZones in range into inline frames
→ void
Recomposes the text in the Table.
→ void
Deletes the Table.
→ Boolean
Removes the event listener.
→ String
Generates a string which, if executed, will return the Table.
→ String
Retrieves the object specifier.
→ Cell[]
Unmerges all merged cells in the Table.
Object of 8
Properties elsewhere that hold a Table.
Parameter of 28
Method parameters that accept a Table.
Character.duplicate(reference)Character.move(reference)Columns.add(reference)InsertionPoint.duplicate(reference)InsertionPoint.move(reference)Line.duplicate(reference)Line.move(reference)Paragraph.duplicate(reference)Paragraph.move(reference)Rows.add(reference)Story.duplicate(reference)Story.move(reference)Tables.add(reference)Tables.itemByRange(from)Tables.nextItem(obj)Tables.previousItem(obj)Text.duplicate(reference)Text.move(reference)TextColumn.duplicate(reference)TextColumn.move(reference)TextStyleRange.duplicate(reference)TextStyleRange.move(reference)TextVariableInstances.add(reference)Word.duplicate(reference)Word.move(reference)XMLElement.markup(using)XMLElements.add(xmlContent)XmlStory.duplicate(reference)
Return 23
Methods that return a Table.
Character.convertToTable()InsertionPoint.convertToTable()Line.convertToTable()Paragraph.convertToTable()Table.getElements()Tables.[]()Tables.add()Tables.anyItem()Tables.everyItem()Tables.firstItem()Tables.item()Tables.itemByID()Tables.itemByName()Tables.itemByRange()Tables.lastItem()Tables.middleItem()Tables.nextItem()Tables.previousItem()Text.convertToTable()TextColumn.convertToTable()TextStyleRange.convertToTable()Word.convertToTable()XMLElement.convertElementToTable()