Adobe InDesign CS2 (4.0) Object Model JS: Cell

InDesign CS2

previous page next page

Class

Cell

A table cell.

QuickLinks

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

Hierarchy

Cell | Column | Row | Table | XMLElement

Cell

Properties

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	CellStyleString	r/w	The cell style applied to the cell. Can also accept: String.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Cell.
autoGrow	bool	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.
bottomEdgeStrokeColor	Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke.
bottomEdgeStrokeGapColor	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.
bottomEdgeStrokeGapOverprint	bool	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.
bottomEdgeStrokeGapTint	number	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.
bottomEdgeStrokeOverprint	bool	r/w	If true, the bottom edge border stroke will overprint.
bottomEdgeStrokeTint	number	r/w	The tint (as a percentage) of the bottom edge border stroke.
bottomEdgeStrokeType	StrokeStyle	r/w	The stroke type of the bottom edge
bottomEdgeStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the bottom edge border stroke.
bottomInset	Measurement Unit (Number or String)	r/w	The bottom inset of the cell.
buttons	Buttons	readonly	A collection of buttons.
cells	Cells	readonly	A collection of table cells.
characters	Characters	readonly	A collection of characters.
clipContentToCell	bool	r/w	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	readonly	A collection of table columns.
contents	Array of Strings Array of Strings NothingEnum NothingEnum SpecialCharacters SpecialCharacters SpecialCharacters String	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; 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	bool	r/w	If true, draws the diagonal line in front of cell contents.
diagonalLineStrokeColor	Swatch	r/w	The diagonal line color, specified as a swatch.
diagonalLineStrokeGapColor	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.
diagonalLineStrokeGapOverprint	bool	r/w	If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid.
diagonalLineStrokeGapTint	number	r/w	The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid.
diagonalLineStrokeOverprint	bool	r/w	If true, the diagonal line stroke will overprint.
diagonalLineStrokeTint	number	r/w	The diagonal line tint (as a percentage). (Range: 0 to 100)
diagonalLineStrokeType	StrokeStyle	r/w	The diagonal line stroke type.
diagonalLineStrokeWeight	Measurement Unit (Number or String)	r/w	The diagonal line stroke weight.
fillColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can also accept: String.
fillTint	number	r/w	The tint (as a percentage) of the fill of the object.
firstBaselineOffset	FirstBaseline: FirstBaseline.ASCENT_OFFSET FirstBaseline.CAP_HEIGHT FirstBaseline.LEADING_OFFSET FirstBaseline.EMBOX_HEIGHT FirstBaseline.X_HEIGHT FirstBaseline.FIXED_HEIGHT	r/w	The distance between the baseline of the text and the top inset of the cell.
formFields	FormFields	readonly	A collection of form fields.
gradientFillAngle	number	r/w	The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180)
gradientFillLength	number	r/w	The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object.
gradientFillStart	Array of Measurement Unit (Number or String)	r/w	The starting point (in page coordinates) of a gradient applied to the fill of the object, in the format [x, y].
graphicLines	GraphicLines	readonly	A collection of graphic lines.
groups	Groups	readonly	A collection of groups.
height	Measurement Unit (Number or String)	r/w	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	r/w	The color, specified as a swatch, of the inner column border stroke.
innerColumnStrokeGapColor	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.
innerColumnStrokeGapOverprint	bool	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.
innerColumnStrokeGapTint	number	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.
innerColumnStrokeOverprint	bool	r/w	If true, the inner column border stroke will overprint.
innerColumnStrokeTint	number	r/w	The tint (as a percentage) of the inner column border stroke. (Range: 0 to 100)
innerColumnStrokeType	StrokeStyle	r/w	The stroke type of the inner column border stroke.
innerColumnStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the inner column border stroke.
innerRowStrokeColor	Swatch	r/w	The color, specified as a swatch, of the inner row border stroke.
innerRowStrokeGapColor	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.
innerRowStrokeGapOverprint	bool	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.
innerRowStrokeGapTint	number	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.
innerRowStrokeOverprint	bool	r/w	If true, the inner row border stroke will overprint.
innerRowStrokeTint	number	r/w	The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100)
innerRowStrokeType	StrokeStyle	r/w	The stroke type of the inner row
innerRowStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the inner row border strokes.
insertionPoints	InsertionPoints	readonly	A collection of insertion points.
keepWithNextRow	bool	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.
leftEdgeStrokeColor	Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke.
leftEdgeStrokeGapColor	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.
leftEdgeStrokeGapOverprint	bool	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.
leftEdgeStrokeGapTint	number	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.
leftEdgeStrokeOverprint	bool	r/w	If true, the left edge border stroke will overprint.
leftEdgeStrokeTint	number	r/w	The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100)
leftEdgeStrokeType	StrokeStyle	r/w	The stroke type of the left edge border stroke.
leftEdgeStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the left edge border stroke.
leftInset	Measurement Unit (Number or String)	r/w	The left inset of the cell.
lines	Lines	readonly	A collection of lines.
maximumHeight	Measurement Unit (Number or String)	r/w	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	Measurement Unit (Number or String) (range: 0 - 8640)	r/w	The space between the baseline of the text and the top inset of the frame or cell.
minimumHeight	Measurement Unit (Number or String)	r/w	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	readonly	A collection of ellipses.
overflows	bool	readonly	If true, the story has overset text.
overprintFill	bool	r/w	If true, the fill of the object will overprint.
pageItems	PageItems	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	Measurement Unit (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.
paragraphs	Paragraphs	readonly	A collection of paragraphs.
parent	Cell Column Row Table XMLElement	readonly	The parent of the Cell (a XMLElement, Cell, Table, Column or Row).
parentColumn	Column	readonly	The parent column of the cell.
parentRow	Row	readonly	The parent row of the cell.
polygons	Polygons	readonly	A collection of polygons.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rectangles	Rectangles	readonly	A collection of rectangles.
rightEdgeStrokeColor	Swatch	r/w	The color, specified as a swatch, of the right edge border stroke.
rightEdgeStrokeGapColor	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.
rightEdgeStrokeGapOverprint	bool	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.
rightEdgeStrokeGapTint	number	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.
rightEdgeStrokeOverprint	bool	r/w	If true, the right edge border stroke will overprint.
rightEdgeStrokeTint	number	r/w	The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100)
rightEdgeStrokeType	StrokeStyle	r/w	The stroke type of the right edge border stroke.
rightEdgeStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the right edge border stroke.
rightInset	Measurement Unit (Number or String)	r/w	The right inset of the cell.
rotationAngle	number	r/w	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.HEADER_ROW RowTypes.FOOTER_ROW RowTypes.MIXED_STATE	r/w	The row type.
rows	Rows	readonly	A collection of table rows.
startRow	StartParagraph: StartParagraph.ANYWHERE StartParagraph.NEXT_COLUMN StartParagraph.NEXT_FRAME StartParagraph.NEXT_PAGE StartParagraph.NEXT_ODD_PAGE StartParagraph.NEXT_EVEN_PAGE	r/w	Indicates where to start the row.
tables	Tables	readonly	A collection of tables.
textColumns	TextColumns	readonly	A collection of text columns.
textFrames	TextFrames	readonly	A collection of text frames.
textStyleRanges	TextStyleRanges	readonly	A collection of text style ranges.
texts	Texts	readonly	A collection of text objects.
topEdgeStrokeColor	Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke.
topEdgeStrokeGapColor	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.
topEdgeStrokeGapOverprint	bool	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.
topEdgeStrokeGapTint	number	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.
topEdgeStrokeOverprint	bool	r/w	If true, the top edge border stroke will overprint.
topEdgeStrokeTint	number	r/w	The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100)
topEdgeStrokeType	StrokeStyle	r/w	The stroke type of the top edge border stroke.
topEdgeStrokeWeight	Measurement Unit (Number or String)	r/w	The stroke weight of the top edge border stroke.
topInset	Measurement Unit (Number or String)	r/w	The top inset of the cell.
topLeftDiagonalLine	bool	r/w	If true, draws a diagonal line starting from the top left.
topRightDiagonalLine	bool	r/w	If true, draws a diagonal line starting from the top right.
verticalJustification	VerticalJustification: VerticalJustification.TOP_ALIGN VerticalJustification.CENTER_ALIGN VerticalJustification.BOTTOM_ALIGN VerticalJustification.JUSTIFY_ALIGN	r/w	The vertical alignment of cell.
width	Measurement Unit (Number or String)	r/w	The width of the Cell. For a table or row, specifies the sum of the column widths.
words	Words	readonly	A collection of words.

Methods

Instances

void convertBulletsAndNumberingToText ()
Convert bullets and numbering to text.

Array of PageItem createOutlines ([deleteOriginal: bool=true])
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	bool	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.

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

void 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: any])
Merges the cells.

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

void recompose ()
Recomposes the text in the Cell.

void remove ()
Deletes the Cell.

Array of Text search ([for: string][, wholeWord: bool][, caseSensitive: bool][, 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	bool	If true, then disregard text embedded within a larger word (Optional)
caseSensitive	bool	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)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
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)

void split (using: HorizontalOrVertical)
Splits the cell along the specified axis.