InDesign2026
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 21.5.1.73
Object

Cell

A table cell.

Hierarchy

Cell | Column | Row | Table | XMLElement

Cell

Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | GraphicLine | HiddenText | InsertionPoint | Line | Note | Oval | PageItem | Paragraph | Polygon | Rectangle | SplineItem | Table | Text | TextColumn | TextFrame | TextStyleRange | TextVariableInstance | Word

Properties

NameType AccessDescription
Graphic[] readonly Lists all graphics contained by the Cell.
PageItem[] readonly Lists all page items contained by the Cell.
CellStyle | String read/write The cell style applied to the cell. Can also accept: String.
XMLItem readonly The XML element associated with the Cell.
Boolean read/write 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.
Swatch read/write The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke.
Swatch read/write 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.
Boolean read/write If true, the gap color of the bottom edge border stroke will overprint. Note: Not valid when bottom edge stroke type is solid.
Number 0–100 read/write 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.
Boolean read/write If true, the bottom edge border stroke will overprint.
Number read/write The tint (as a percentage) of the bottom edge border stroke.
StrokeStyle | String read/write The stroke type of the bottom edge. Can also accept: String.
Number | String unit read/write The stroke weight of the bottom edge border stroke.
Number | String unit read/write The bottom inset of the cell.The API has been deprecated. Use TextBottomInset or GraphicBottomInset
Buttons<Button> readonly A collection of buttons.
CellTypeEnum
 read/write The content type of cell.
Cells<Cell> readonly A collection of table cells.
Changes<Change> readonly A collection of changes.
Characters<Character> readonly A collection of characters.
CheckBoxes<CheckBox> readonly A collection of checkboxes.
Boolean read/write If true, clips the cell's content to width and height of the cell. The API has been deprecated. Use ClipContentsToTextCell or ClipContentsToPageItemCell
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 readonly The number of columns that the object spans.
ColumnTypes
 read/write The column type.
Columns<Column> readonly A collection of table columns.
ComboBoxes<ComboBox> readonly A collection of comboboxes.
NothingEnum[] | NothingEnums[] | PageItem[] | PageItem[] | SpecialCharacters[] | SpecialCharacters[] | SpecialCharacters[] | String[] | Strings[] | Strings[] | PageItems[]<PageItem> | PageItems[]<PageItem>
 read/write 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.
Boolean read/write If true, draws the diagonal line in front of cell contents.
Swatch read/write The diagonal line color, specified as a swatch.
Swatch read/write 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.
Boolean read/write If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid.
Number read/write The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid.
Boolean read/write If true, the diagonal line stroke will overprint.
Number 0–100 read/write The diagonal line tint (as a percentage). (Range: 0 to 100)
StrokeStyle | String read/write The stroke type of the diagonal line(s). Can also accept: String.
Number | String unit read/write The diagonal line stroke weight.
EndnoteTextFrames<EndnoteTextFrame> readonly A collection of endnote text frames.
Endnotes<Endnote> readonly A collection of endnotes.
EPSTexts<EPSText> readonly EPSTexts
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Swatch | String read/write The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can also accept: String.
Number read/write The tint (as a percentage) of the fill of the object.
FirstBaseline
 read/write The distance between the baseline of the text and the top inset of the cell.
Footnotes<Footnote> readonly A collection of footnotes.
FormFields<FormField> readonly A collection of form fields.
Number read/write The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180)
Number read/write The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object.
Number[] | String[] unit read/write The starting point (in page coordinates) of a gradient applied to the fill of the Cell, in the format [x, y].
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<GraphicLine> 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<Group> readonly A collection of groups.
Number | String unit read/write The height of the Cell. For a table or column, specifies the sum of the row heights.
HiddenTexts<HiddenText> readonly A collection of hidden text objects.
Number readonly The unique ID of the Cell.
Number readonly The index of the Cell within its containing object.
Swatch read/write The color, specified as a swatch, of the inner column border stroke.
Swatch read/write 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.
Boolean read/write If true, the gap color of the inner column border stroke will overprint. Note: Not valid when inner column stroke type is solid.
Number 0–100 read/write 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.
Boolean read/write If true, the inner column border stroke will overprint.
Number 0–100 read/write The tint (as a percentage) of the inner column border stroke. (Range: 0 to 100)
StrokeStyle | String read/write The stroke type of the inner column. Can also accept: String.
Number | String unit read/write The stroke weight of the inner column border stroke.
Swatch read/write The color, specified as a swatch, of the inner row border stroke.
Swatch read/write 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.
Boolean read/write If true, the gap color of the inner row border stroke will overprint. Note: Not valid when inner row stroke type is solid.
Number 0–100 read/write 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.
Boolean read/write If true, the inner row border stroke will overprint.
Number 0–100 read/write The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100)
StrokeStyle | String read/write The stroke type of the inner row. Can also accept: String.
Number | String unit read/write The stroke weight of the inner row border strokes.
InsertionPoints<InsertionPoint> readonly A collection of insertion points.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Boolean read/write If true, keeps the row with the next row when the table is split across text frames or pages.
String read/write A property that can be set to any string.
Swatch read/write The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke.
Swatch read/write 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.
Boolean read/write If true, the gap color of the left edge border stroke will overprint. Note: Not valid when left edge stroke type is solid.
Number 0–100 read/write 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.
Boolean read/write If true, the left edge border stroke will overprint.
Number 0–100 read/write The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100)
StrokeStyle | String read/write The stroke type of the left edge. Can also accept: String.
Number | String unit read/write The stroke weight of the left edge border stroke.
Number | String unit read/write The left inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicLeftInset
Lines<Line> readonly A collection of lines.
ListBoxes<ListBox> readonly A collection of listboxes.
Number | String unit read/write 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.
Number | String unit read/write The space between the baseline of the text and the top inset of the frame or cell.
Number | String unit read/write 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.
MultiStateObjects<MultiStateObject> readonly A collection of multi-state objects.
String readonly The name of the Cell.
Notes<Note> readonly A collection of notes.
Ovals<Oval> readonly A collection of ellipses.
Boolean readonly If true, the story has overset text.
Boolean read/write If true, the fill of the object will overprint.
PageItems<PageItem> 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.
Number | String unit read/write The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified.
Paragraphs<Paragraph> readonly A collection of paragraphs.
Cell | Column | Table | Row | XMLElement readonly The parent of the Cell (a XMLElement, Cell, Table, Column or Row).
Column readonly The parent column of the cell.
Row readonly The parent row of the cell.
Polygons<Polygon> readonly A collection of polygons.
Object read/write A property that allows setting of several properties at the same time.
RadioButtons<RadioButton> readonly A collection of radio buttons.
Rectangles<Rectangle> readonly A collection of rectangles.
Swatch read/write The color, specified as a swatch, of the right edge border stroke.
Swatch read/write 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.
Boolean read/write If true, the gap color of the right edge border stroke will overprint. Note: Not valid when right edge stroke type is solid.
Number 0–100 read/write 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.
Boolean read/write If true, the right edge border stroke will overprint.
Number 0–100 read/write The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100)
StrokeStyle | String read/write The stroke type of the right edge. Can also accept: String.
Number | String unit read/write The stroke weight of the right edge border stroke.
Number | String unit read/write The right inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicRightInset
Number read/write The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270.
Number readonly The number of rows that the object spans.
RowTypes
 read/write The row type.
Rows<Row> readonly A collection of table rows.
SignatureFields<SignatureField> readonly A collection of signature fields.
SplineItems<SplineItem> readonly The spline items collection.
StartParagraph
 read/write Indicates where to start the row.
Tables<Table> readonly A collection of tables.
Number | String unit read/write The bottom inset of the text cell.
TextBoxes<TextBox> readonly A collection of text boxes.
TextColumns<TextColumn> readonly A collection of text columns.
TextFrames<TextFrame> 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.
TextStyleRanges<TextStyleRange> readonly A collection of text style ranges.
Number | String unit read/write The top inset of the text cell.
TextVariableInstances<TextVariableInstance> readonly A collection of text variable instances.
Texts<Text> readonly A collection of text objects.
Swatch read/write The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke.
Swatch read/write 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.
Boolean read/write If true, the gap color of the top edge border stroke will overprint. Note: Not valid when top edge stroke type is solid.
Number 0–100 read/write 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.
Boolean read/write If true, the top edge border stroke will overprint.
Number 0–100 read/write The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100)
StrokeStyle | String read/write The stroke type of the top edge. Can also accept: String.
Number | String unit read/write The stroke weight of the top edge border stroke.
Number | String unit read/write The top inset of the cell. The API has been deprecated. Use TextTopInset or GraphicTopInset
Boolean read/write If true, draws a diagonal line starting from the top left.
Boolean read/write If true, draws a diagonal line starting from the top right.
VerticalJustification
 read/write The vertical alignment of cell.
Number | String unit read/write The width of the Cell. For a table or row, specifies the sum of the column widths.
Words<Word> readonly A collection of words.
HorizontalOrVertical
 read/write The direction of the text in the cell.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ 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.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find what value and replaces the text with the change to value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find what value and replaces the text with the change to value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find character type value and replaces the text with the change character type value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ void

Clear Cell Style Overrides

clearingOverridesThroughRootCellStyle? Boolean If true, clears all overrides, whether or not they are defined in the underlying cell style
→ void

Convert bullets and numbering to text.

→ void

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? Boolean If true then the data inside the cell is preserved. While converting graphic cell to text cell, page item becomes inline.
→ 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.

key String The key.
→ Text[]

Finds glyphs that match the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find character type value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Cell[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ Cell

Merges the cells.

with? Cell | Row | Column The cell(s) to merge with. Can accept: Cell, Row or Column.
→ void

Recomposes the text in the Cell.

→ void

Deletes the Cell.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Selects the object.

existingSelection? SelectionOptions The selection status of the Cell in relation to previously selected objects.
→ void

Splits the cell along the specified axis.

using HorizontalOrVertical The direction in which to split the cell.
→ String

Generates a string which, if executed, will return the Cell.

→ String

Retrieves the object specifier.

→ Cell[]

Unmerges all merged cells in the Cell.

Object of 28

Properties elsewhere that hold a Cell.

Cell.parentChange.parentCharacter.parentEndnote.parentEndnoteTextFrame.parentEvent.parentEventListener.parentFootnote.parentGraphicLine.parentHiddenText.parentInsertionPoint.parentLine.parentMutationEvent.parentNote.parentOval.parentPageItem.parentParagraph.parentPolygon.parentRectangle.parentSplineItem.parentTable.parentText.parentTextColumn.parentTextFrame.parentTextStyleRange.parentTextVariableInstance.parentWord.parentXMLElement.xmlContent

Parameter of 32

Method parameters that accept a Cell.

Cell.merge(with)Cells.itemByRange(from)Cells.nextItem(obj)Cells.previousItem(obj)Character.duplicate(reference)Character.move(reference)Column.merge(with)Column.redistribute(thru)Columns.add(reference)InsertionPoint.duplicate(reference)InsertionPoint.move(reference)Line.duplicate(reference)Line.move(reference)Paragraph.duplicate(reference)Paragraph.move(reference)Row.merge(with)Row.redistribute(thru)Rows.add(reference)Story.duplicate(reference)Story.move(reference)Tables.add(reference)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)XMLElements.add(xmlContent)XmlStory.duplicate(reference)

Return 20

Methods that return a Cell.

Cell.getElements()Cell.merge()Cell.unmerge()Cells.[]()Cells.anyItem()Cells.everyItem()Cells.firstItem()Cells.item()Cells.itemByID()Cells.itemByName()Cells.itemByRange()Cells.lastItem()Cells.middleItem()Cells.nextItem()Cells.previousItem()Column.merge()Column.unmerge()Row.merge()Row.unmerge()Table.unmerge()