Cell

A table cell.

Go to Property Listing | Method Listing

Methods:

convertBulletsAndNumberingToText, createOutlines, extractLabel, getElements, insertLabel, merge, recompose, remove, search, select, split, toSource, toSpecifier, unmerge

Property Listing

Property	Type	Access	Description
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Cell.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Cell.
appliedCellStyle	CellStyle String	read/write	The cell style applied to the cell. Can also accept: String.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Cell.
autoGrow	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.
bottomEdgeStrokeColor	Swatch	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke.
bottomEdgeStrokeGapColor	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.
bottomEdgeStrokeGapOverprint	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.
bottomEdgeStrokeGapTint	Number (range 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.
bottomEdgeStrokeOverprint	Boolean	read/write	If true, the bottom edge border stroke will overprint.
bottomEdgeStrokeTint	Number	read/write	The tint (as a percentage) of the bottom edge border stroke.
bottomEdgeStrokeType	StrokeStyle	read/write	The stroke type of the bottom edge
bottomEdgeStrokeWeight	Number String	read/write	The stroke weight of the bottom edge border stroke.
bottomInset	Number String	read/write	The bottom inset of the cell.
buttons	Buttons Button	readonly	A collection of buttons.
cells	Cells Cell	readonly	A collection of table cells.
characters	Characters Character	readonly	A collection of characters.
clipContentToCell	Boolean	read/write	If true, clips the cell's content to width and height of the cell.
columnSpan	Number	readonly	The number of columns that the object spans.
columns	Columns Column	readonly	A collection of table columns.
contents	SpecialCharacters SpecialCharacters.AUTO_PAGE_NUMBER SpecialCharacters.BULLET_CHARACTER SpecialCharacters.COLUMN_BREAK SpecialCharacters.COPYRIGHT_SYMBOL SpecialCharacters.DEGREE_SYMBOL SpecialCharacters.DISCRETIONARY_HYPHEN SpecialCharacters.DOUBLE_LEFT_QUOTE SpecialCharacters.DOUBLE_RIGHT_QUOTE SpecialCharacters.ELLIPSIS_CHARACTER SpecialCharacters.EM_DASH SpecialCharacters.EM_SPACE SpecialCharacters.END_NESTED_STYLE SpecialCharacters.EN_DASH SpecialCharacters.EN_SPACE SpecialCharacters.EVEN_PAGE_BREAK SpecialCharacters.FIGURE_SPACE SpecialCharacters.FLUSH_SPACE SpecialCharacters.FOOTNOTE_SYMBOL SpecialCharacters.FORCED_LINE_BREAK SpecialCharacters.FRAME_BREAK SpecialCharacters.HAIR_SPACE SpecialCharacters.INDENT_HERE_TAB SpecialCharacters.NEXT_PAGE_NUMBER SpecialCharacters.NONBREAKING_HYPHEN SpecialCharacters.NONBREAKING_SPACE SpecialCharacters.ODD_PAGE_BREAK SpecialCharacters.PAGE_BREAK SpecialCharacters.PARAGRAPH_SYMBOL SpecialCharacters.PREVIOUS_PAGE_NUMBER SpecialCharacters.PUNCTUATION_SPACE SpecialCharacters.REGISTERED_TRADEMARK SpecialCharacters.RIGHT_INDENT_TAB SpecialCharacters.SECTION_MARKER SpecialCharacters.SECTION_SYMBOL SpecialCharacters.SINGLE_LEFT_QUOTE SpecialCharacters.SINGLE_RIGHT_QUOTE SpecialCharacters.THIN_SPACE SpecialCharacters.TRADEMARK_SYMBOL String Array of Strings String NothingEnums NothingEnum SpecialCharactersCanalsoaccept:NothingEnum	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: String, SpecialCharacters enumerator or Array of Strings or SpecialCharacters enumerators. Can also accept: NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators.
diagonalLineInFront	Boolean	read/write	If true, draws the diagonal line in front of cell contents.
diagonalLineStrokeColor	Swatch	read/write	The diagonal line color, specified as a swatch.
diagonalLineStrokeGapColor	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.
diagonalLineStrokeGapOverprint	Boolean	read/write	If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid.
diagonalLineStrokeGapTint	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.
diagonalLineStrokeOverprint	Boolean	read/write	If true, the diagonal line stroke will overprint.
diagonalLineStrokeTint	Number (range 0 - 100)	read/write	The diagonal line tint (as a percentage). (Range: 0 to 100)
diagonalLineStrokeType	StrokeStyle	read/write	The diagonal line stroke type.
diagonalLineStrokeWeight	Number String	read/write	The diagonal line stroke weight.
fillColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can also accept: String.
fillTint	Number	read/write	The tint (as a percentage) of the fill of the object.
firstBaselineOffset	FirstBaseline FirstBaseline.ASCENT_OFFSET FirstBaseline.CAP_HEIGHT FirstBaseline.EMBOX_HEIGHT FirstBaseline.FIXED_HEIGHT FirstBaseline.LEADING_OFFSET FirstBaseline.X_HEIGHT	read/write	The distance between the baseline of the text and the top inset of the cell.
formFields	FormFields FormField	readonly	A collection of form fields.
gradientFillAngle	Number	read/write	The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180)
gradientFillLength	Number	read/write	The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object.
gradientFillStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the object, in the format [x, y].
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
groups	Groups Group	readonly	A collection of groups.
height	Number String	read/write	The height of the Cell. For a table or column, specifies the sum of the row heights.
id	Number	readonly	The unique ID of the Cell.
index	Number	readonly	The index of the Cell within its containing object.
innerColumnStrokeColor	Swatch	read/write	The color, specified as a swatch, of the inner column border stroke.
innerColumnStrokeGapColor	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.
innerColumnStrokeGapOverprint	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.
innerColumnStrokeGapTint	Number (range 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.
innerColumnStrokeOverprint	Boolean	read/write	If true, the inner column border stroke will overprint.
innerColumnStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the inner column border stroke. (Range: 0 to 100)
innerColumnStrokeType	StrokeStyle	read/write	The stroke type of the inner column border stroke.
innerColumnStrokeWeight	Number String	read/write	The stroke weight of the inner column border stroke.
innerRowStrokeColor	Swatch	read/write	The color, specified as a swatch, of the inner row border stroke.
innerRowStrokeGapColor	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.
innerRowStrokeGapOverprint	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.
innerRowStrokeGapTint	Number (range 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.
innerRowStrokeOverprint	Boolean	read/write	If true, the inner row border stroke will overprint.
innerRowStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100)
innerRowStrokeType	StrokeStyle	read/write	The stroke type of the inner row
innerRowStrokeWeight	Number String	read/write	The stroke weight of the inner row border strokes.
insertionPoints	InsertionPoints InsertionPoint	readonly	A collection of insertion points.
keepWithNextRow	Boolean	read/write	If true, keeps the row with the next row when the table is split across text frames or pages.
label	String	read/write	A property that can be set to any string.
leftEdgeStrokeColor	Swatch	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke.
leftEdgeStrokeGapColor	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.
leftEdgeStrokeGapOverprint	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.
leftEdgeStrokeGapTint	Number (range 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.
leftEdgeStrokeOverprint	Boolean	read/write	If true, the left edge border stroke will overprint.
leftEdgeStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100)
leftEdgeStrokeType	StrokeStyle	read/write	The stroke type of the left edge border stroke.
leftEdgeStrokeWeight	Number String	read/write	The stroke weight of the left edge border stroke.
leftInset	Number String	read/write	The left inset of the cell.
lines	Lines Line	readonly	A collection of lines.
maximumHeight	Number String	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.
minimumFirstBaselineOffset	Number String	read/write	The space between the baseline of the text and the top inset of the frame or cell.
minimumHeight	Number String	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.
name	String	readonly	The name of the Cell.
ovals	Ovals Oval	readonly	A collection of ellipses.
overflows	Boolean	readonly	If true, the story has overset text.
overprintFill	Boolean	read/write	If true, the fill of the object will overprint.
pageItems	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.
paragraphSpacingLimit	Number String	read/write	The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified.
paragraphs	Paragraphs Paragraph	readonly	A collection of paragraphs.
parent	Column Row Table Cell XMLElement	readonly	The parent of the Cell (a Cell, Table, Column, Row or XMLElement).
parentColumn	Column	readonly	The parent column of the cell.
parentRow	Row	readonly	The parent row of the cell.
polygons	Polygons Polygon	readonly	A collection of polygons.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
rightEdgeStrokeColor	Swatch	read/write	The color, specified as a swatch, of the right edge border stroke.
rightEdgeStrokeGapColor	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.
rightEdgeStrokeGapOverprint	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.
rightEdgeStrokeGapTint	Number (range 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.
rightEdgeStrokeOverprint	Boolean	read/write	If true, the right edge border stroke will overprint.
rightEdgeStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100)
rightEdgeStrokeType	StrokeStyle	read/write	The stroke type of the right edge border stroke.
rightEdgeStrokeWeight	Number String	read/write	The stroke weight of the right edge border stroke.
rightInset	Number String	read/write	The right inset of the cell.
rotationAngle	Number	read/write	The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270.
rowSpan	Number	readonly	The number of rows that the object spans.
rowType	RowTypes RowTypes.BODY_ROW RowTypes.FOOTER_ROW RowTypes.HEADER_ROW RowTypes.MIXED_STATE	read/write	The row type.
rows	Rows Row	readonly	A collection of table rows.
startRow	StartParagraph StartParagraph.ANYWHERE StartParagraph.NEXT_COLUMN StartParagraph.NEXT_EVEN_PAGE StartParagraph.NEXT_FRAME StartParagraph.NEXT_ODD_PAGE StartParagraph.NEXT_PAGE	read/write	Indicates where to start the row.
tables	Tables Table	readonly	A collection of tables.
textColumns	TextColumns TextColumn	readonly	A collection of text columns.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textStyleRanges	TextStyleRanges TextStyleRange	readonly	A collection of text style ranges.
texts	Texts Text	readonly	A collection of text objects.
topEdgeStrokeColor	Swatch	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke.
topEdgeStrokeGapColor	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.
topEdgeStrokeGapOverprint	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.
topEdgeStrokeGapTint	Number (range 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.
topEdgeStrokeOverprint	Boolean	read/write	If true, the top edge border stroke will overprint.
topEdgeStrokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100)
topEdgeStrokeType	StrokeStyle	read/write	The stroke type of the top edge border stroke.
topEdgeStrokeWeight	Number String	read/write	The stroke weight of the top edge border stroke.
topInset	Number String	read/write	The top inset of the cell.
topLeftDiagonalLine	Boolean	read/write	If true, draws a diagonal line starting from the top left.
topRightDiagonalLine	Boolean	read/write	If true, draws a diagonal line starting from the top right.
verticalJustification	VerticalJustification VerticalJustification.BOTTOM_ALIGN VerticalJustification.CENTER_ALIGN VerticalJustification.JUSTIFY_ALIGN VerticalJustification.TOP_ALIGN	read/write	The vertical alignment of cell.
width	Number String	read/write	The width of the Cell. For a table or row, specifies the sum of the column widths.
words	Words Word	readonly	A collection of words.

Method Listing

undefined convertBulletsAndNumberingToText ()

Convert bullets and numbering to text.

PageItem createOutlines ([deleteOriginal:Boolean=Boolean])

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	Boolean	If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true)

Parameter

Type

Description

deleteOriginal

Boolean

If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)

(default: true)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Object getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter	Type	Description
key	String	The key.
value	String	The value.

Cell merge (with:Varies Cell Row Column)

Merges the cells.

Parameter	Type	Description
with	Cell Row Column	The cell(s) to merge with. Can accept: Cell, Row or Column. (Optional)

Parameter

Type

Description

with

Cell

Row

Column

The cell(s) to merge with. Can accept: Cell, Row or Column. (Optional)

undefined recompose ()

Recomposes the text in the Cell.

undefined remove ()

Deletes the Cell.

Text search (for:String, wholeWord:Boolean, caseSensitive:Boolean, 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	Boolean	If true, then disregard text embedded within a larger word (Optional)
caseSensitive	Boolean	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)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the Cell in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

The selection status of the Cell in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

undefined split (using:HorizontalOrVertical)

Splits the cell along the specified axis.