Indesign Scripting Reference
home | search | Links
JavaScript >> Cell

Cell

A cell in a table.

Cell Properties

Property Type Access Description
allGraphics Array of Graphics read All graphics contained by the object.
allPageItems Array of PageItems read All page items contained by the object.
associatedXMLElement XMLItem read The XML element associated with the object.
autoGrow Boolean r/w If true, rows in the object will expand vertically to fit their content.
bottomEdgeStrokeColor Swatch r/w The color of the stroke applied to the bottom edge.
bottomEdgeStrokeGapColor Swatch r/w The gap color applied to the bottom edge.
bottomEdgeStrokeGapOverprint Boolean r/w If true, the gap color applied to the bottom edge will overprint.
bottomEdgeStrokeGapTint Real r/w The tint percentage applied to the gap color of the bottom edge.
bottomEdgeStrokeOverprint Boolean r/w If true, overprint the bottom edge.
bottomEdgeStrokeTint Real r/w The tint percentage applied to the color of the bottom edge.
bottomEdgeStrokeType StrokeStyle r/w The stroke style applied to the bottom edge.
bottomEdgeStrokeWeight Unit r/w The stroke weight applied to the bottom edge.
bottomInset Unit r/w The bottom inset.
buttons Buttons read The buttons contained by the object.
cells Cells read The cells in the object.
characters Characters read The characters of the object.
clipContentToCell Boolean r/w If true, clip cell content to fit the cell.
columns Columns read All columns in the object.
columnSpan Long read The number of columns in the object.
contents String, SpecialCharacters enumeration (see table at end of chapter), Array of Strings or SpecialCharacters enumerators, NothingEnum enumeration, Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators r/w The text contents.
diagonalLineInFront Boolean r/w If true, the diagonal line(s) will appear in front of the content in the cells of the object.
diagonalLineStrokeColor Swatch r/w The color of the stroke applied to the diagonal line(s).
diagonalLineStrokeGapColor Swatch r/w The gap color of the stroke applied to the diagonal line(s).
diagonalLineStrokeGapOverprint Boolean r/w If true, overprint the gap of the diagonal line(s).
diagonalLineStrokeGapTint Real r/w The tint percentage applied to the gap color of the diagonal line(s).
diagonalLineStrokeOverprint Boolean r/w If true, overprint the diagonal line(s).
diagonalLineStrokeTint Real r/w The tint percentage applied to the diagonal line(s).
diagonalLineStrokeType StrokeStyle r/w The stroke style applied to the diagonal line(s).
diagonalLineStrokeWeight Unit r/w The stroke weight of the diagonal line(s).
fillColor Swatch, String r/w The fill of the object.
fillTint Real r/w The tint percentage applied to the fill of the object (-1 indicates 100%).
firstBaselineOffset FirstBaseline enumeration r/w The distance between the baseline of the first line of text in the object and the top inset of object.
formFields FormFields read The form fields contained by the object.
gradientFillAngle Real r/w The angle of the gradient applied to the fill of the object.
gradientFillLength Real r/w Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the fill of the object.
gradientFillStart Array of 2 Units r/w Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the fill of the object.
graphicLines GraphicLines read The graphic lines contained by the object.
groups Groups read The groups contained by the object.
height Unit r/w The height of the object.
id Long read A unique number identifying the object.
index Long read Index of the object within its parent object.
innerColumnStrokeColor Swatch r/w The color of the stroke applied to the inner column.
innerColumnStrokeGapColor Swatch r/w The gap color of the inner column.
innerColumnStrokeGapOverprint Boolean r/w If true, overprint the stroke gap of the inner column.
innerColumnStrokeGapTint Real r/w The tint percentage applied to the stroke gap color of the inner column.
innerColumnStrokeOverprint Boolean r/w If true, overprint the stroke applied to the inner column.
innerColumnStrokeTint Real r/w The tint percentage applied to the stroke of the inner column.
innerColumnStrokeType StrokeStyle r/w The stroke style applied to the inner column.
innerColumnStrokeWeight Unit r/w The stroke weight applied to the inner column.
innerRowStrokeColor Swatch r/w The color of the stroke applied to the inner row.
innerRowStrokeGapColor Swatch r/w The gap color of the stroke applied to the inner row.
innerRowStrokeGapOverprint Boolean r/w If true, overprint the gap of the stroke applied to the inner row.
innerRowStrokeGapTint Real r/w The tint percentage applied to the stroke gap color of the inner row.
innerRowStrokeOverprint Boolean r/w If true, the stroke applied to the inner row will overprint.
innerRowStrokeTint Real r/w The tint percentage applied to the stroke color of the inner row.
innerRowStrokeType StrokeStyle r/w The stroke style applied to the inner row.
innerRowStrokeWeight Unit r/w The stroke weight applied to stroke of the inner row.
insertionPoints InsertionPoints read The insertion points in the object.
keepWithNextRow Boolean r/w If true, keep this row with the next row.
label String r/w A label that can be set to any string.
leftEdgeStrokeColor Swatch r/w The color of the stroke applied to the left edge.
leftEdgeStrokeGapColor Swatch r/w The gap color of the stroke applied to the left edge.
leftEdgeStrokeGapOverprint Boolean r/w If true, overprint the gap of the stroke applied to the left edge.
leftEdgeStrokeGapTint Real r/w The tint percentage applied to the stroke gap color of the left edge.
leftEdgeStrokeOverprint Boolean r/w If true, overprint the stroke applied to the left edge.
leftEdgeStrokeTint Real r/w The tint percentage applied to the stroke color of the left edge.
leftEdgeStrokeType StrokeStyle r/w The stroke style applied to the left edge.
leftEdgeStrokeWeight Unit r/w The stroke weight applied to the left edge of the cell.
leftInset Unit r/w The left inset of the object.
lines Lines read The lines of text in the object.
maximumHeight Unit r/w The maximum height of the row.
minimumFirstBaselineOffset Unit (0 - 8640 points) r/w The minimum distance between the baseline of the first line of text in the object and the top inset object.
minimumHeight Unit r/w Constrains the row height to an amount no smaller than this value. The row may be larger than this amount, however, as the row height will continue to grow automatically as text is added.
name String read The name of the object.
ovals Ovals read All ovals contained by the object.
overflows Boolean read If true, the object contains overset text.
overprintFill Boolean r/w If true, the fill of the object will overprint.
pageItems PageItems read The page items contained by the object.
paragraphs Paragraphs read The paragraphs contained by the object.
paragraphSpacingLimit Unit r/w The maximum amount of space that will be added between paragraphs when vertical justification is set to justified.
parent Object read The parent of the object.
parentColumn Column read The parent column of the object.
parentRow Row read The parent row of the object.
polygons Polygons read The polygons contained by the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
rectangles Rectangles read The rectangles contained by the object.
rightEdgeStrokeColor Swatch r/w The color of the stroke applied to the right edge.
rightEdgeStrokeGapColor Swatch r/w The gap color of the right edge.
rightEdgeStrokeGapOverprint Boolean r/w If true, overprint the gap of the stroke applied to the right edge.
rightEdgeStrokeGapTint Real r/w The tint percentage applied to the stroke gap color of the right edge.
rightEdgeStrokeOverprint Boolean r/w If true, overprint the stroke applied to the right edge.
rightEdgeStrokeTint Real r/w The tint percentage applied to the stroke color of the right edge.
rightEdgeStrokeType StrokeStyle r/w The stroke style applied to the right edge.
rightEdgeStrokeWeight Unit r/w The stroke weight applied to the right edge of the cell.
rightInset Unit r/w The right inset of the object.
rotationAngle Real r/w The rotation angle applied to the object, including any rotation applied to its containing object.
rows Rows read The rows contained by the object.
rowSpan Long read The number of rows the object spans.
rowType RowTypes enumeration r/w The type of the row.
startRow StartParagraph enumeration r/w Where to start the row.
tables Tables read The tables contained by the object.
textColumns TextColumns read The text columns contained by the object.
textFrames TextFrames read The text frames contained by the object.
texts Texts read The texts contained by the object.
textStyleRanges TextStyleRanges read The text style ranges contained by the object.
topEdgeStrokeColor Swatch r/w The color of the stroke applied to the top edge.
topEdgeStrokeGapColor Swatch r/w The gap color of the top edge.
topEdgeStrokeGapOverprint Boolean r/w If true, overprint the gap of the stroke applied to the top edge.
topEdgeStrokeGapTint Real r/w The tint percentage applied to the stroke gap color of the top edge.
topEdgeStrokeOverprint Boolean r/w If true, overprint the stroke applied to the top edge.
topEdgeStrokeTint Real r/w The tint percentage applied to the stroke color of the top edge.
topEdgeStrokeType StrokeStyle r/w The stroke style applied to the top edge.
topEdgeStrokeWeight Unit r/w The stroke weight applied to the top edge of the cell.
topInset Unit r/w The top inset of the object.
topLeftDiagonalLine Boolean r/w If true, draw a diagonal line starting from the top left.
topRightDiagonalLine Boolean r/w If true, draw a diagonal line starting from the top right.
verticalJustification VerticalJustification enumeration r/w The vertical justification alignment.
width Unit r/w The width of the object.
words Words read The words contained by the object.

Cell Methods

Method Returns Description
convertBulletsAndNumberingToText Nothing Converts bullets and numbering to text.
createOutlines Array of PageItems Create outlines from the text.
extractLabel String Gets the content of the label associated with the specified key (name).
getElements Array of Objects Resolve the object specifier.
insertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
merge Cell Merge cells together.
recompose Nothing Recomposes the text in the object.
remove Nothing Delete the object.
search Array of Texts Searches for text and returns a list of text objects matching the search string and/or formatting specified by the find preferences. Search can also replace the text and/or formatting. This command corresponds to InDesign’s Find/Change feature.
select Nothing Selects the object.
split Nothing Split the cell either horizontally or vertically.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.
unmerge Array of Cells Unmerge the cells.