TablesCell

A table cell.

Instance Properties

Name Description Access
allGraphics Graphic Lists all graphics contained by the Cell. read-only
allPageItems PageItem Lists all page items contained by the Cell. read-only
appliedCellStyle CellStyle The cell style applied to the cell. Can also accept: String. read-write
associatedXMLElement XMLItem The XML element associated with the Cell. read-only
autoGrow bool 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. read-write
bottomEdgeStrokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. read-write
bottomEdgeStrokeGapColor Swatch 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. read-write
bottomEdgeStrokeGapOverprint bool If true, the gap color of the bottom edge border stroke will overprint. Note: Not valid when bottom edge stroke type is solid. read-write
bottomEdgeStrokeGapTint number 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. read-write
bottomEdgeStrokeOverprint bool If true, the bottom edge border stroke will overprint. read-write
bottomEdgeStrokeTint number The tint (as a percentage) of the bottom edge border stroke. read-write
bottomEdgeStrokeType StrokeStyle The stroke type of the bottom edge. Can also accept: String. read-write
bottomEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the bottom edge border stroke. read-write
bottomInset Measurement Unit (Number or String)=any The bottom inset of the cell.The API has been deprecated. Use TextBottomInset or GraphicBottomInset read-write
buttons Buttons A collection of buttons. read-only
cellType CellTypeEnum The content type of cell. read-write
cells Cells A collection of table cells. read-only
changes Changes A collection of changes. read-only
characters Characters A collection of characters. read-only
checkBoxes CheckBoxes A collection of checkboxes. read-only
clipContentToCell bool If true, clips the cell's content to width and height of the cell. The API has been deprecated. Use ClipContentsToTextCell or ClipContentsToPageItemCell read-write
clipContentToGraphicCell bool If true, clips the graphic cell's content to width and height of the cell. read-write
clipContentToTextCell bool If true, clips the text cell's content to width and height of the cell. read-write
columnSpan number The number of columns that the object spans. read-only
columns Columns A collection of table columns. read-only
comboBoxes ComboBoxes A collection of comboboxes. read-only
contents 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; the next value populates the next cell to the right (for rows) or the next lowest cell (for columns), and so on. Can return: PageItem, String, SpecialCharacters enumerator or Array of Strings, SpecialCharacters enumerators or PageItems. Can also accept: PageItem, NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators, NothingEnum enumerators or PageItems. read-write
diagonalLineInFront bool If true, draws the diagonal line in front of cell contents. read-write
diagonalLineStrokeColor Swatch The diagonal line color, specified as a swatch. read-write
diagonalLineStrokeGapColor Swatch 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. read-write
diagonalLineStrokeGapOverprint bool If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid. read-write
diagonalLineStrokeGapTint number The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid. read-write
diagonalLineStrokeOverprint bool If true, the diagonal line stroke will overprint. read-write
diagonalLineStrokeTint number The diagonal line tint (as a percentage). (Range: 0 to 100) read-write
diagonalLineStrokeType StrokeStyle The stroke type of the diagonal line(s). Can also accept: String. read-write
diagonalLineStrokeWeight Measurement Unit (Number or String)=any The diagonal line stroke weight. read-write
endnoteTextFrames EndnoteTextFrames A collection of endnote text frames. read-only
epstexts EPSTexts EPSTexts read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fillColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can also accept: String. read-write
fillTint number The tint (as a percentage) of the fill of the object. read-write
firstBaselineOffset FirstBaseline The distance between the baseline of the text and the top inset of the cell. read-write
formFields FormFields A collection of form fields. read-only
gradientFillAngle number The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180) read-write
gradientFillLength number The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object. read-write
gradientFillStart Measurement Unit (Number or String)=any The starting point (in page coordinates) of a gradient applied to the fill of the Cell, in the format [x, y]. read-write
graphicBottomInset Measurement Unit (Number or String)=any The bottom inset of the graphic cell. read-write
graphicLeftInset Measurement Unit (Number or String)=any The left inset of the graphic cell. read-write
graphicLines GraphicLines A collection of graphic lines. read-only
graphicRightInset Measurement Unit (Number or String)=any The right inset of the graphic cell. read-write
graphicTopInset Measurement Unit (Number or String)=any The top inset of the graphic cell. read-write
groups Groups A collection of groups. read-only
height Measurement Unit (Number or String)=any The height of the Cell. For a table or column, specifies the sum of the row heights. read-write
hiddenTexts HiddenTexts A collection of hidden text objects. read-only
id number The unique ID of the Cell. read-only
index number The index of the Cell within its containing object. read-only
innerColumnStrokeColor Swatch The color, specified as a swatch, of the inner column border stroke. read-write
innerColumnStrokeGapColor Swatch 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. read-write
innerColumnStrokeGapOverprint bool If true, the gap color of the inner column border stroke will overprint. Note: Not valid when inner column stroke type is solid. read-write
innerColumnStrokeGapTint number 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. read-write
innerColumnStrokeOverprint bool If true, the inner column border stroke will overprint. read-write
innerColumnStrokeTint number The tint (as a percentage) of the inner column border stroke. (Range: 0 to 100) read-write
innerColumnStrokeType StrokeStyle The stroke type of the inner column. Can also accept: String. read-write
innerColumnStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the inner column border stroke. read-write
innerRowStrokeColor Swatch The color, specified as a swatch, of the inner row border stroke. read-write
innerRowStrokeGapColor Swatch 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. read-write
innerRowStrokeGapOverprint bool If true, the gap color of the inner row border stroke will overprint. Note: Not valid when inner row stroke type is solid. read-write
innerRowStrokeGapTint number 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. read-write
innerRowStrokeOverprint bool If true, the inner row border stroke will overprint. read-write
innerRowStrokeTint number The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) read-write
innerRowStrokeType StrokeStyle The stroke type of the inner row. Can also accept: String. read-write
innerRowStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the inner row border strokes. read-write
insertionPoints InsertionPoints A collection of insertion points. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
keepWithNextRow bool If true, keeps the row with the next row when the table is split across text frames or pages. read-write
label string A property that can be set to any string. read-write
leftEdgeStrokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. read-write
leftEdgeStrokeGapColor Swatch 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. read-write
leftEdgeStrokeGapOverprint bool If true, the gap color of the left edge border stroke will overprint. Note: Not valid when left edge stroke type is solid. read-write
leftEdgeStrokeGapTint number 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. read-write
leftEdgeStrokeOverprint bool If true, the left edge border stroke will overprint. read-write
leftEdgeStrokeTint number The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100) read-write
leftEdgeStrokeType StrokeStyle The stroke type of the left edge. Can also accept: String. read-write
leftEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the left edge border stroke. read-write
leftInset Measurement Unit (Number or String)=any The left inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicLeftInset read-write
lines Lines A collection of lines. read-only
listBoxes ListBoxes A collection of listboxes. read-only
maximumHeight Measurement Unit (Number or String)=any The maximum height to which cells in the Cell may grow. Note: The maximum height cannot be exceeded even when auto grow is set to true. Also, the maximum height can affect redistribution. read-write
minimumFirstBaselineOffset Measurement Unit (Number or String)=any The space between the baseline of the text and the top inset of the frame or cell. read-write
minimumHeight Measurement Unit (Number or String)=any The minimum height of the cells in the Cell. 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. read-write
multiStateObjects MultiStateObjects A collection of multi-state objects. read-only
name string The name of the Cell. read-only
notes Notes A collection of notes. read-only
ovals Ovals A collection of ellipses. read-only
overflows bool If true, the story has overset text. read-only
overprintFill bool If true, the fill of the object will overprint. read-write
pageItems PageItems 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. read-only
paragraphSpacingLimit Measurement Unit (Number or String)=any The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified. read-write
paragraphs Paragraphs A collection of paragraphs. read-only
parent The parent of the Cell (a XMLElement, Cell, Table, Column or Row). read-only
parentColumn Column The parent column of the cell. read-only
parentRow Row The parent row of the cell. read-only
polygons Polygons A collection of polygons. read-only
properties Object A property that allows setting of several properties at the same time. read-write
radioButtons RadioButtons A collection of radio buttons. read-only
rectangles Rectangles A collection of rectangles. read-only
rightEdgeStrokeColor Swatch The color, specified as a swatch, of the right edge border stroke. read-write
rightEdgeStrokeGapColor Swatch 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. read-write
rightEdgeStrokeGapOverprint bool If true, the gap color of the right edge border stroke will overprint. Note: Not valid when right edge stroke type is solid. read-write
rightEdgeStrokeGapTint number 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. read-write
rightEdgeStrokeOverprint bool If true, the right edge border stroke will overprint. read-write
rightEdgeStrokeTint number The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100) read-write
rightEdgeStrokeType StrokeStyle The stroke type of the right edge. Can also accept: String. read-write
rightEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the right edge border stroke. read-write
rightInset Measurement Unit (Number or String)=any The right inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicRightInset read-write
rotationAngle number The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270. read-write
rowSpan number The number of rows that the object spans. read-only
rowType RowTypes The row type. read-write
rows Rows A collection of table rows. read-only
signatureFields SignatureFields A collection of signature fields. read-only
splineItems SplineItems The spline items collection. read-only
startRow StartParagraph Indicates where to start the row. read-write
tables Tables A collection of tables. read-only
textBottomInset Measurement Unit (Number or String)=any The bottom inset of the text cell. read-write
textBoxes TextBoxes A collection of text boxes. read-only
textColumns TextColumns A collection of text columns. read-only
textFrames TextFrames A collection of text frames. read-only
textLeftInset Measurement Unit (Number or String)=any The left inset of the text cell. read-write
textRightInset Measurement Unit (Number or String)=any The right inset of the text cell. read-write
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
textTopInset Measurement Unit (Number or String)=any The top inset of the text cell. read-write
textVariableInstances TextVariableInstances A collection of text variable instances. read-only
texts Texts A collection of text objects. read-only
topEdgeStrokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. read-write
topEdgeStrokeGapColor Swatch 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. read-write
topEdgeStrokeGapOverprint bool If true, the gap color of the top edge border stroke will overprint. Note: Not valid when top edge stroke type is solid. read-write
topEdgeStrokeGapTint number 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. read-write
topEdgeStrokeOverprint bool If true, the top edge border stroke will overprint. read-write
topEdgeStrokeTint number The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100) read-write
topEdgeStrokeType StrokeStyle The stroke type of the top edge. Can also accept: String. read-write
topEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the top edge border stroke. read-write
topInset Measurement Unit (Number or String)=any The top inset of the cell. The API has been deprecated. Use TextTopInset or GraphicTopInset read-write
topLeftDiagonalLine bool If true, draws a diagonal line starting from the top left. read-write
topRightDiagonalLine bool If true, draws a diagonal line starting from the top right. read-write
verticalJustification VerticalJustification The vertical alignment of cell. read-write
width Measurement Unit (Number or String)=any The width of the Cell. For a table or row, specifies the sum of the column widths. read-write
words Words A collection of words. read-only
writingDirection HorizontalOrVertical The direction of the text in the cell. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
 → EventListener
autoTag(
)
changeGlyph(
[reverseOrder])
 → Text
changeGrep(
[reverseOrder])
 → Text
changeText(
[reverseOrder])
 → Text
changeTransliterate(
[reverseOrder])
 → Text
clearCellStyleOverrides(
[clearingOverridesThroughRootCellStyle])
convertCellType(
finalCellType ​[, flagToPreserveData])
createOutlines(
[deleteOriginal])
 → PageItem
extractLabel(
key)
 → string
findGlyph(
[reverseOrder])
 → Text
findGrep(
[reverseOrder])
 → Text
findText(
[reverseOrder])
 → Text
findTransliterate(
[reverseOrder])
 → Text
getElements(
)
 → Cell
insertLabel(
key, value)
merge(
with)
 → Cell
remove(
)
removeEventListener(
eventType, handler ​[, captures])
 → bool
select(
[existingSelection])
split(
using)
toSource(
)
 → string
toSpecifier(
)
 → string
unmerge(
)
 → Cell
addEventListener(
eventType, handler ​[, captures=false])
 → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
autoTag(
)
Tag the object or the parent story using default tags defined in XML preference.
changeGlyph(
[reverseOrder])
 → Text
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeGrep(
[reverseOrder])
 → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeText(
[reverseOrder])
 → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeTransliterate(
[reverseOrder])
 → Text
Finds text that matches the find character type value and replaces the text with the change character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
clearCellStyleOverrides(
[clearingOverridesThroughRootCellStyle=false])
Clear Cell Style Overrides
clearingOverridesThroughRootCellStyle bool If true, clears all overrides, whether or not they are defined in the underlying cell style (Optional)
convertBulletsAndNumberingToText(
)
Convert bullets and numbering to text.
convertCellType(
finalCellType ​[, flagToPreserveData=false])
Convert cell type. The new cell type parameter is required. Preserve data is optional
finalCellType CellTypeEnum Cell Type to which the cell is to be converted
flagToPreserveData bool If true then the data inside the cell is preserved. While converting graphic cell to text cell, page item becomes inline. (Optional)
createOutlines(
[deleteOriginal=true])
 → 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 bool If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)
extractLabel(
key)
 → string
Gets the label value associated with the specified key.
key string The key.
findGlyph(
[reverseOrder])
 → Text
Finds glyphs that match the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findGrep(
[reverseOrder])
 → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findText(
[reverseOrder])
 → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findTransliterate(
[reverseOrder])
 → Text
Finds text that matches the find character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
getElements(
)
 → Cell
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
merge(
with)
 → Cell
Merges the cells.
with The cell(s) to merge with. Can accept: Cell, Row or Column. (Optional)
recompose(
)
Recomposes the text in the Cell.
remove(
)
Deletes the Cell.
removeEventListener(
eventType, handler ​[, captures=false])
 → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
select(
[existingSelection=SelectionOptions.REPLACE_WITH])
Selects the object.
existingSelection SelectionOptions The selection status of the Cell in relation to previously selected objects. (Optional)
split(
using)
Splits the cell along the specified axis.
using HorizontalOrVertical The direction in which to split the cell.
toSource(
)
 → string
Generates a string which, if executed, will return the Cell.
toSpecifier(
)
 → string
Retrieves the object specifier.
unmerge(
)
 → Cell
Unmerges all merged cells in the Cell.