A collection of table cells.
Element
button
cell
character
column
form field
graphic line
group
insertion point
line
oval
page item
paragraph
polygon
rectangle
row
table
text
text column
text frame
text style range
text variable instance
word
cell Properties
| Property | Type | Access | Description |
|---|---|---|---|
| all graphics | List of graphic | read | Lists all graphics contained by the cell. |
| all page items | List of page item | read | Lists all page items contained by the cell. |
| applied cell style | cell style | r/w | The cell style applied to the cell. Can also accept: string. |
| associated XML element | XML item | read | The XML element associated with the cell. |
| auto grow | boolean | r/w | If true, the height of the cell or the cells in the cell can increase or decrease automatically to fit cell content. Note: Allows cells to grow or shrink to the maximum or minimum height, if specified. |
| bottom edge stroke color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. |
| bottom edge stroke gap color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the bottom edge border stroke. Note: Not valid when bottom edge stroke type is solid. |
| bottom edge stroke gap overprint | boolean | r/w | If true, the gap color of the bottom edge border stroke will overprint. Note: Not valid when bottom edge stroke type is solid. |
| bottom edge stroke gap tint | fixed | r/w | The tint (as a percentage) of the bottom edge border stroke gap color. (Range: 0 to 100) Note: Not valid when bottom edge stroke type is solid. |
| bottom edge stroke overprint | boolean | r/w | If true, the bottom edge border stroke will overprint. |
| bottom edge stroke tint | fixed | r/w | The tint (as a percentage) of the bottom edge border stroke. |
| bottom edge stroke type | stroke style | r/w | The stroke type of the bottom edge. Can also accept: string. |
| bottom edge stroke weight | number or string | r/w | The stroke weight of the bottom edge border stroke. |
| bottom inset | number or string | r/w | The bottom inset of the cell. |
| class | type class | read | The class descriptor type. |
| clip content to cell | boolean | r/w | If true, clips the cell’s content to width and height of the cell. |
| column span | integer | read | The number of columns that the cell spans. |
| contents | anything | r/w | The text contents. For rows or columns, when specified as a string, the sting populates each cell in the row or column; when specified as an array, the first value in the array populates the left-most cell in the row or the top-most cell in the column;… |
| diagonal line in front | boolean | r/w | If true, draws the diagonal line in front of cell contents. |
| diagonal line stroke color | swatch | r/w | The diagonal line color, specified as a swatch. |
| diagonal line stroke gap color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the diagonal line stroke. Note: Not valid when diagonal line stroke type is solid. |
| diagonal line stroke gap overprint | boolean | r/w | If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid. |
| diagonal line stroke gap tint | fixed | r/w | The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid. |
| diagonal line stroke overprint | boolean | r/w | If true, the diagonal line stroke will overprint. |
| diagonal line stroke tint | fixed | r/w | The diagonal line tint (as a percentage). (Range: 0 to 100) |
| diagonal line stroke type | stroke style | r/w | The stroke type of the diagonal line(s). Can also accept: string. |
| diagonal line stroke weight | number or string | r/w | The diagonal line stroke weight. |
| fill color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the cell. Can also accept: string. |
| fill tint | fixed | r/w | The tint (as a percentage) of the fill of the cell. |
| first baseline offset | ascent offset, cap height, leading offset, embox height, x height, fixed height, ascent offset, cap height, leading offset, embox height, x height, fixed height, |
r/w | The distance between the baseline of the text and the top inset of the cell. |
| gradient fill angle | fixed | r/w | The angle of a linear gradient applied to the cell’s fill. (Range: -180 to 180) |
| gradient fill length | fixed | r/w | The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the cell. |
| gradient fill start | List of number or string | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the cell, in the format [x, y]. |
| height | number or string | r/w | The height of the cell. For a table or column, specifies the sum of the row heights. |
| id | integer | read | The unique ID of the cell. |
| index | integer | read | The index of the cell within its containing object. |
| inner column stroke color | swatch | r/w | The color, specified as a swatch, of the inner column border stroke. |
| inner column stroke gap color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the inner column border stroke. Note: Not valid when inner column stroke type is solid. |
| inner column stroke gap overprint | boolean | r/w | If true, the gap color of the inner column border stroke will overprint. Note: Not valid when inner column stroke type is solid. |
| inner column stroke gap tint | fixed | r/w | The tint (as a percentage) of the inner column border stroke gap color. (Range: 0 to 100) Note: Not valid when inner column stroke type is solid. |
| inner column stroke overprint | boolean | r/w | If true, the inner column border stroke will overprint. |
| inner column stroke tint | fixed | r/w | The tint (as a percentage) of the inner column border stroke. (Range: 0 to 100) |
| inner column stroke type | stroke style | r/w | The stroke type of the inner column. Can also accept: string. |
| inner column stroke weight | number or string | r/w | The stroke weight of the inner column border stroke. |
| inner row stroke color | swatch | r/w | The color, specified as a swatch, of the inner row border stroke. |
| inner row stroke gap color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the inner row border stroke. Note: Not valid when inner row stroke type is solid. |
| inner row stroke gap overprint | boolean | r/w | If true, the gap color of the inner row border stroke will overprint. Note: Not valid when inner row stroke type is solid. |
| inner row stroke gap tint | fixed | r/w | The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) Note: Not valid when inner row stroke type is solid. |
| inner row stroke overprint | boolean | r/w | If true, the inner row border stroke will overprint. |
| inner row stroke tint | fixed | r/w | The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) |
| inner row stroke type | stroke style | r/w | The stroke type of the inner row. Can also accept: string. |
| inner row stroke weight | number or string | r/w | The stroke weight of the inner row border strokes. |
| keep with next row | boolean | r/w | If true, keeps the row with the next row when the table is split across text frames or pages. |
| label | string | r/w | A property that can be set to any string. |
| left edge stroke color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. |
| left edge stroke gap color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the left edge border stroke. Note: Not valid when left edge stroke type is solid. |
| left edge stroke gap overprint | boolean | r/w | If true, the gap color of the left edge border stroke will overprint. Note: Not valid when left edge stroke type is solid. |
| left edge stroke gap tint | fixed | r/w | The tint (as a percentage) of the left edge border stroke gap color. (Range: 0 to 100) Note: Not valid when left edge stroke type is solid. |
| left edge stroke overprint | boolean | r/w | If true, the left edge border stroke will overprint. |
| left edge stroke tint | fixed | r/w | The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100) |
| left edge stroke type | stroke style | r/w | The stroke type of the left edge. Can also accept: string. |
| left edge stroke weight | number or string | r/w | The stroke weight of the left edge border stroke. |
| left inset | number or string | r/w | The left inset of the cell. |
| maximum height | number or string | r/w | The maximum height to which the row or the column’s rows may grow. Note: The maximum height cannot be exceeded even when auto grow is set to true. Also, the maximum height can affect redistribution. For information, see redistribute. |
| minimum first baseline offset | number or string | r/w | The space between the baseline of the text and the top inset of the frame or cell. |
| minimum height | number or string | r/w | The minimum height that the cell or the cell’s cells are allowed to be. Note: When auto grow is true, cells can automatically grow larger than this amount when content is added. Also, the minimum height can affect redistribution. For information, see r… |
| name | string | read | The name of the cell. |
| object reference | cell | read | An object reference for the cell. |
| overflows | boolean | read | If true, the cell has overset text. |
| overprint fill | boolean | r/w | If true, the fill of the cell will overprint. |
| paragraph spacing limit | number or string | r/w | The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified. |
| parent | reference | read | The parent of the cell (a XML element, cell, table, column or row). Can return: XML element, cell, table, column or row. |
| parent column | column | read | The cell’s parent column. |
| parent row | row | read | The cell’s parent row. |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| right edge stroke color | swatch | r/w | The color, specified as a swatch, of the right edge border stroke. |
| right edge stroke gap color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the right edge border stroke. Note: Not valid when right edge stroke type is solid. |
| right edge stroke gap overprint | boolean | r/w | If true, the gap color of the right edge border stroke will overprint. Note: Not valid when right edge stroke type is solid. |
| right edge stroke gap tint | fixed | r/w | The tint (as a percentage) of the right edge border stroke gap color. (Range: 0 to 100) Note: Not valid when right edge stroke type is solid. |
| right edge stroke overprint | boolean | r/w | If true, the right edge border stroke will overprint. |
| right edge stroke tint | fixed | r/w | The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100) |
| right edge stroke type | stroke style | r/w | The stroke type of the right edge. Can also accept: string. |
| right edge stroke weight | number or string | r/w | The stroke weight of the right edge border stroke. |
| right inset | number or string | r/w | The right inset of the cell. |
| rotation angle | fixed | r/w | The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270. |
| row span | integer | read | The number of rows that the cell spans. |
| row type | body row, header row, footer row, mixed state, |
r/w | The row’s type. |
| start row | anywhere, next column, next frame, next page, next odd page, next even page, anywhere, next column, next frame, next page, next odd page, next even page, anywhere, next column, next frame, next page, next odd page, next even page, anywhere, next column, next frame, next page, next odd page, next even page, |
r/w | Indicates where to start the row. |
| top edge stroke color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. |
| top edge stroke gap color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the top edge border stroke. Note: Not valid when top edge stroke type is solid. |
| top edge stroke gap overprint | boolean | r/w | If true, the gap color of the top edge border stroke will overprint. Note: Not valid when top edge stroke type is solid. |
| top edge stroke gap tint | fixed | r/w | The tint (as a percentage) of the top edge border stroke gap color. (Range: 0 to 100) Note: Not valid when top edge stroke type is solid. |
| top edge stroke overprint | boolean | r/w | If true, the top edge border stroke will overprint. |
| top edge stroke tint | fixed | r/w | The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100) |
| top edge stroke type | stroke style | r/w | The stroke type of the top edge. Can also accept: string. |
| top edge stroke weight | number or string | r/w | The stroke weight of the top edge border stroke. |
| top inset | number or string | r/w | The top inset of the cell. |
| top left diagonal line | boolean | r/w | If true, draws a diagonal line starting from the top left. |
| top right diagonal line | boolean | r/w | If true, draws a diagonal line starting from the top right. |
| vertical justification | top align, center align, bottom align, justify align, top align, center align, bottom align, justify align, |
r/w | The vertical alignment of cell. |
| width | number or string | r/w | The width of the cell. For a table or row, specifies the sum of the column widths. |