Class
A table. convertToText, createOutlines, remove, search, select, unmerge
Table
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allGraphics | Array of Graphic | readonly | Lists all graphics contained by the Table. |
| allPageItems | Array of PageItem | readonly | Lists all page items contained by the Table. |
| alternatingFills | AlternatingFillsTypes: AlternatingFillsTypes.NO_ALTERNATING_PATTERN AlternatingFillsTypes.ALTERNATING_ROWS AlternatingFillsTypes.ALTERNATING_COLUMNS |
r/w | The pattern for alternating fills. |
| bodyRowCount | number | r/w | Number of table body rows |
| bottomBorderStrokeColor | Swatch | r/w | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. |
| bottomBorderStrokeGapColor | Swatch | r/w | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. Note: Valid only when bottom border stroke type is not solid. |
| bottomBorderStrokeGapOverprint | bool | r/w | If true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid. |
| bottomBorderStrokeGapTint | number | r/w | The tint (as a percentage) of the gap color of the bottom border stroke. (Range: 0 to 100) Note: Valid only when bottom border stroke type is not solid. |
| bottomBorderStrokeOverprint | bool | r/w | If true, the bottom border stroke will overprint. |
| bottomBorderStrokeTint | number | r/w | The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100) |
| bottomBorderStrokeType | StrokeStyle | r/w | The stroke type of the bottom border |
| bottomBorderStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the bottom border stroke. |
| breakFooters | HeaderFooterBreakTypes: HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME HeaderFooterBreakTypes.ONCE_PER_PAGE |
r/w | The footer placement. |
| breakHeaders | HeaderFooterBreakTypes: HeaderFooterBreakTypes.IN_ALL_TEXT_COLUMNS HeaderFooterBreakTypes.ONCE_PER_TEXT_FRAME HeaderFooterBreakTypes.ONCE_PER_PAGE |
r/w | The header placement. |
| buttons | Buttons | readonly | A collection of buttons. |
| cells | Cells | readonly | A collection of table cells. |
| columnCount | number | r/w | The number of columns |
| columnFillsPriority | bool | r/w | If true, hides alternating row fills. If false, hides alternating column fills. |
| columns | Columns | readonly | A collection of table columns. |
| contents | SpecialCharacters String |
r/w | The text contents. Can return: String or SpecialCharacters enumerator. |
| endColumnFillColor | Swatch | r/w | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the second alternating fill group. Note: Valid when alternating fills are defined for table columns. |
| endColumnFillCount | number | r/w | The number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns. |
| endColumnFillOverprint | bool | r/w | If true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns. |
| endColumnFillTint | number | r/w | The tint (as a percentage) of the columns in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns. |
| endColumnLineStyle | StrokeStyle | r/w | The stroke type of columns in the second alternating columns group |
| endColumnStrokeColor | Swatch | r/w | The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater. |
| endColumnStrokeCount | number | r/w | The number of columns in the second alternating column strokes group. |
| endColumnStrokeGapColor | Swatch | r/w | The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater. |
| endColumnStrokeGapOverprint | bool | r/w | If true, the gap of the column border stroke in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater. |
| endColumnStrokeGapTint | number | r/w | The tint (as a percentage) of the gap color of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater. |
| endColumnStrokeOverprint | bool | r/w | If true, the column borders in the second alternating column strokes group will overprint. Note: Valid when end column stroke count is 1 or greater. |
| endColumnStrokeTint | number | r/w | The tint (as a percentage) of column borders in the second alternating column strokes group. (Range: 0 to 100) Note: Valid when end column stroke count is 1 or greater. |
| endColumnStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater. |
| endRowFillColor | Swatch | r/w | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows. |
| endRowFillCount | number | r/w | The number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows. |
| endRowFillOverprint | bool | r/w | If true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows. |
| endRowFillTint | number | r/w | The tint (as a percentage) of the rows in the second alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows. |
| endRowStrokeColor | Swatch | r/w | The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater. |
| endRowStrokeCount | number | r/w | The number of rows in the second alternating row strokes group. |
| endRowStrokeGapColor | Swatch | r/w | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the second alternating rows group. Note: Valid when end row stroke count is 1 or greater. |
| endRowStrokeGapOverprint | bool | r/w | If true, the gap of the row borders in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater. |
| endRowStrokeGapTint | Measurement Unit (Number or String) | r/w | The gap tint (as a percentage) of the gap color of rows in the second alternating rows group |
| endRowStrokeOverprint | bool | r/w | If true, the rows in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater. |
| endRowStrokeTint | Measurement Unit (Number or String) | r/w | The tint of the color of rows in the second alternating row strokes group |
| endRowStrokeType | StrokeStyle | r/w | The stroke type of rows in the second alternating row strokes group |
| endRowStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater. |
| footerRowCount | number | r/w | Number of table footer rows |
| formFields | FormFields | readonly | A collection of form fields. |
| graphicLines | GraphicLines | readonly | A collection of graphic lines. |
| groups | Groups | readonly | A collection of groups. |
| headerRowCount | number | r/w | Number of table header rows |
| height | Measurement Unit (Number or String) | r/w | The height of the Table. For a table or column, specifies the sum of the row heights. |
| id | number | readonly | The unique ID of the Table. |
| index | number | readonly | The index of the Table within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| leftBorderStrokeColor | Swatch | r/w | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. |
| leftBorderStrokeGapColor | Swatch | r/w | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. Note: Valid only when left border stroke type is not solid. |
| leftBorderStrokeGapOverprint | bool | r/w | If true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid. |
| leftBorderStrokeGapTint | number | r/w | The tint (as a percentage) of the gap color of the left border stroke. (Range: 0 to 100) Note: Valid only when left border stroke type is not solid. |
| leftBorderStrokeOverprint | bool | r/w | If true, the left border stroke will overprint. |
| leftBorderStrokeTint | number | r/w | The tint (as a percentage) of the left border stroke. (Range: 0 to 100) |
| leftBorderStrokeType | StrokeStyle | r/w | The stroke type of the left border. |
| leftBorderStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the left border stroke. |
| ovals | Ovals | readonly | A collection of ellipses. |
| pageItems | PageItems | readonly | The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
| parent | Cell Character InsertionPoint Line Paragraph Story Text TextColumn TextFrame TextStyleRange Word |
readonly | The parent of the Table (a TextFrame, Text, Character, Word, Line, Paragraph, TextColumn, InsertionPoint, Story, Cell or TextStyleRange). |
| polygons | Polygons | readonly | A collection of polygons. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rectangles | Rectangles | readonly | A collection of rectangles. |
| rightBorderStrokeColor | Swatch | r/w | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. |
| rightBorderStrokeGapColor | Swatch | r/w | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. Note: Valid only when right border stroke type is not solid. |
| rightBorderStrokeGapOverprint | bool | r/w | If true, the gap color of the right border stroke will overprint. Note: Valid only when right border stroke type is not solid. |
| rightBorderStrokeGapTint | number | r/w | The tint (as a percentage) of the gap color of the right border stroke. (Range: 0 to 100) Note: Valid only when right border stroke type is not solid. |
| rightBorderStrokeOverprint | bool | r/w | If true, the right border stroke will overprint. |
| rightBorderStrokeTint | number | r/w | The tint (as a percentage) of the right border stroke. (Range: 0 to 100) |
| rightBorderStrokeType | StrokeStyle | r/w | The stroke type of the table's right border. |
| rightBorderStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the right border stroke. |
| rows | Rows | readonly | A collection of table rows. |
| skipFirstAlternatingFillColumns | number | r/w | The number of columns on the left side of the table to skip before applying the column fill color. Note: Valid when alternating fills are defined for table columns. |
| skipFirstAlternatingFillRows | number | r/w | The number of body rows at the beginning of the table to skip before applying the row fill color. Note: Valid when alternating fills are defined for table rows. |
| skipFirstAlternatingStrokeColumns | number | r/w | The number of columns on the left of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater. |
| skipFirstAlternatingStrokeRows | number | r/w | The number of body rows at the beginning of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater. |
| skipFirstHeader | bool | r/w | If true, skips the first occurrence of header rows. |
| skipLastAlternatingFillColumns | number | r/w | The number columns on the right side of the table in which to not apply the column fill color. Note: Valid when alternating fills are defined for table columns. |
| skipLastAlternatingFillRows | number | r/w | The number of body rows at the end of the table in which to not apply the row fill color. Note: Valid when alternating fills are defined for table rows. |
| skipLastAlternatingStrokeColumns | number | r/w | The number of columns on the right side of the table in which to skip border stroke formatting. Note: Valid when start column stroke count is 1 or greater and/or end column stroke count is 1 or greater. |
| skipLastAlternatingStrokeRows | number | r/w | The number of body rows at the end of the table in which to skip border stroke formatting. Note: Valid when start row stroke count is 1 or greater and/or end row stroke count is 1 or greater. |
| skipLastFooter | bool | r/w | If true, skips the last occurrence of footer rows. |
| spaceAfter | Measurement Unit (Number or String) | r/w | The space below the table. |
| spaceBefore | Measurement Unit (Number or String) | r/w | The space above the table. |
| startColumnFillColor | Swatch | r/w | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns. |
| startColumnFillCount | number | r/w | The number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns. |
| startColumnFillOverprint | bool | r/w | If true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns. |
| startColumnFillTint | number | r/w | The tint (as a percentage) of the columns in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table columns. |
| startColumnStrokeColor | Swatch | r/w | The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. |
| startColumnStrokeCount | number | r/w | The number of columns in the first alternating column strokes group. |
| startColumnStrokeGapColor | Swatch | r/w | The stroke gap color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater. |
| startColumnStrokeGapOverprint | bool | r/w | If true, the gap of the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater. |
| startColumnStrokeGapTint | number | r/w | The tint (as a percentage) of the gap color of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater. |
| startColumnStrokeOverprint | bool | r/w | If true, the column borders in the first alternating column strokes group will overprint. Note: Valid when start column stroke count is 1 or greater. |
| startColumnStrokeTint | number | r/w | The tint (as a percentage) of column borders in the first alternating column strokes group. (Range: 0 to 100) Note: Valid when start column stroke count is 1 or greater. |
| startColumnStrokeType | StrokeStyle | r/w | The stroke type of columns in the first alternating columns group |
| startColumnStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater. |
| startRowFillColor | Swatch | r/w | The fill color, specified as a swatch (color, gradient, tint, or mixed ink), of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows. |
| startRowFillCount | number | r/w | The number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows. |
| startRowFillOverprint | bool | r/w | If true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows. |
| startRowFillTint | number | r/w | The tint (as a percentage) of the rows in the first alternating fills group. (Range: 0 to 100) Note: Valid when alternating fills are defined for table rows. |
| startRowStrokeColor | Swatch | r/w | The color, specified as a swatch (color, gradient, tint, or mixed ink), of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater. |
| startRowStrokeCount | number | r/w | The number of rows in the first alternating row strokes group. |
| startRowStrokeGapColor | Swatch | r/w | The stroke gap color of row borders in the first alternating row strokes group, specified as a swatch (color, gradient, tint, or mixed ink). Note: Valid when start row stroke count is 1 or greater. |
| startRowStrokeGapOverprint | bool | r/w | If true, the gap color of the row border stroke in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater. |
| startRowStrokeGapTint | number | r/w | The tint (as a percentage) of the gap color of row borders in the first alternating rows group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater. |
| startRowStrokeOverprint | bool | r/w | If true, the row borders in the first alternating row strokes group will overprint. Note: Valid when start row stroke count is 1 or greater. |
| startRowStrokeTint | number | r/w | The tint (as a percentage) of the borders in the first alternating row strokes group. (Range: 0 to 100) Note: Valid when start row stroke count is 1 or greater. |
| startRowStrokeType | StrokeStyle | r/w | The stroke type of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater. |
| startRowStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater. |
| storyOffset | number | readonly | The index of the character containing the table (from the beginning of the story). |
| strokeOrder | StrokeOrderTypes: StrokeOrderTypes.ROW_ON_TOP StrokeOrderTypes.COLUMN_ON_TOP StrokeOrderTypes.BEST_JOINS StrokeOrderTypes.INDESIGN_2_COMPATIBILITY |
r/w | The order in which to display row and column strokes at corners. |
| tableDirection | TableDirectionOptions: TableDirectionOptions.LEFT_TO_RIGHT_DIRECTION TableDirectionOptions.RIGHT_TO_LEFT_DIRECTION |
r/w | The direction of the the table |
| textFrames | TextFrames | readonly | A collection of text frames. |
| topBorderStrokeColor | Swatch | r/w | The color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. |
| topBorderStrokeGapColor | Swatch | r/w | The gap color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. Note: Valid only when top border stroke type is not solid. |
| topBorderStrokeGapOverprint | bool | r/w | If true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid. |
| topBorderStrokeGapTint | number | r/w | The tint (as a percentage) of the gap color of the table's top border stroke. (Range: 0 to 100) Note: Valid only when top border stroke type is not solid. |
| topBorderStrokeOverprint | bool | r/w | If true, the top border strokes will overprint. |
| topBorderStrokeTint | number | r/w | The tint (as a percentage) of the table's top border stroke. (Range: 0 to 100) |
| topBorderStrokeType | StrokeStyle | r/w | The stroke type of the table's top border. |
| topBorderStrokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the table's top border stroke. |
| width | Measurement Unit (Number or String) | r/w | The width of the Table. For a table or row, specifies the sum of the column widths. |
Methods
Instances
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) |
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.
| Parameter | Type | Description |
|---|---|---|
| deleteOriginal | bool | If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true) |
void remove ()
Deletes the Table.
Array
of Text search ([for:
string][, wholeWord:
bool][, caseSensitive:
bool][, 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 | bool | If true, then disregard text embedded within a larger word (Optional) |
| caseSensitive | bool | 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) |
void select ([existingSelection:
SelectionOptions=SelectionOptions.REPLACE])
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) |
Array
of Cell unmerge ()
Unmerges all merged cells in the Table.
Used in:
Column Columns.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Row Rows.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Table Tables.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
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])
Table Tables.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
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])
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |