Row

A table row.

Go to Property Listing | Method Listing

Objects:

Boolean, Cells, Column, Columns, EventListeners, Events, FirstBaseline, HorizontalOrVertical, NothingEnum, Number, Object, PageItem, PageItems, Row, RowTypes, Rows, SpecialCharacters, StartParagraph, String, StrokeStyle, Swatch, VerticalJustification

Property Listing

Property	Type	Access	Description
autoGrow	Boolean	read/write	If true, the height of the cell or the cells in the Row 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 String	read/write	The stroke type of the bottom edge. Can also accept: String.
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.The API has been deprecated. Use TextBottomInset or GraphicBottomInset
cells	Cells Cell	readonly	A collection of table cells.
clipContentToCell	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
clipContentToGraphicCell	Boolean	read/write	If true, clips the graphic cell's content to width and height of the cell.
clipContentToTextCell	Boolean	read/write	If true, clips the text 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	NothingEnum.NOTHING NothingEnums NothingEnum PageItem SpecialCharacters SpecialCharacters.ARABIC_COMMA SpecialCharacters.ARABIC_KASHIDA SpecialCharacters.ARABIC_QUESTION_MARK SpecialCharacters.ARABIC_SEMICOLON SpecialCharacters.AUTO_PAGE_NUMBER SpecialCharacters.BULLET_CHARACTER SpecialCharacters.COLUMN_BREAK SpecialCharacters.COPYRIGHT_SYMBOL SpecialCharacters.DEGREE_SYMBOL SpecialCharacters.DISCRETIONARY_HYPHEN SpecialCharacters.DISCRETIONARY_LINE_BREAK SpecialCharacters.DOTTED_CIRCLE SpecialCharacters.DOUBLE_LEFT_QUOTE SpecialCharacters.DOUBLE_RIGHT_QUOTE SpecialCharacters.DOUBLE_STRAIGHT_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.FIXED_WIDTH_NONBREAKING_SPACE SpecialCharacters.FLUSH_SPACE SpecialCharacters.FOOTNOTE_SYMBOL SpecialCharacters.FORCED_LINE_BREAK SpecialCharacters.FRAME_BREAK SpecialCharacters.HAIR_SPACE SpecialCharacters.HEBREW_GERESH SpecialCharacters.HEBREW_GERSHAYIM SpecialCharacters.HEBREW_MAQAF SpecialCharacters.HEBREW_SOF_PASUK SpecialCharacters.INDENT_HERE_TAB SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING SpecialCharacters.LEFT_TO_RIGHT_MARK SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE SpecialCharacters.NEXT_PAGE_NUMBER SpecialCharacters.NONBREAKING_HYPHEN SpecialCharacters.NONBREAKING_SPACE SpecialCharacters.ODD_PAGE_BREAK SpecialCharacters.PAGE_BREAK SpecialCharacters.PARAGRAPH_SYMBOL SpecialCharacters.POP_DIRECTIONAL_FORMATTING SpecialCharacters.PREVIOUS_PAGE_NUMBER SpecialCharacters.PUNCTUATION_SPACE SpecialCharacters.QUARTER_SPACE SpecialCharacters.REGISTERED_TRADEMARK SpecialCharacters.RIGHT_INDENT_TAB SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING SpecialCharacters.RIGHT_TO_LEFT_MARK SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE SpecialCharacters.SECTION_MARKER SpecialCharacters.SECTION_SYMBOL SpecialCharacters.SINGLE_LEFT_QUOTE SpecialCharacters.SINGLE_RIGHT_QUOTE SpecialCharacters.SINGLE_STRAIGHT_QUOTE SpecialCharacters.SIXTH_SPACE SpecialCharacters.TEXT_VARIABLE SpecialCharacters.THIN_SPACE SpecialCharacters.THIRD_SPACE SpecialCharacters.TRADEMARK_SYMBOL SpecialCharacters.ZERO_WIDTH_JOINER SpecialCharacters.ZERO_WIDTH_NONJOINER String Array of Strings String PageItems PageItem PageItemsCanalsoaccept: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.
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 String	read/write	The stroke type of the diagonal line(s). Can also accept: String.
diagonalLineStrokeWeight	Number String	read/write	The diagonal line stroke weight.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
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.
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 Row, in the format [x, y].
graphicBottomInset	Number String	read/write	The bottom inset of the graphic cell.
graphicLeftInset	Number String	read/write	The left inset of the graphic cell.
graphicRightInset	Number String	read/write	The right inset of the graphic cell.
graphicTopInset	Number String	read/write	The top inset of the graphic cell.
height	Number String	read/write	The height of the Row. For a table or column, specifies the sum of the row heights.
index	Number	readonly	The index of the Row 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 String	read/write	The stroke type of the inner column. Can also accept: String.
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 String	read/write	The stroke type of the inner row. Can also accept: String.
innerRowStrokeWeight	Number String	read/write	The stroke weight of the inner row border strokes.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
keepWithNextRow	Boolean	read/write	If true, keeps the row with the next row when the table is split across text frames or pages.
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 String	read/write	The stroke type of the left edge. Can also accept: String.
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.The API has been deprecated. Use TextLeftInset or GraphicLeftInset
maximumHeight	Number String	read/write	The maximum height to which cells in the Row 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 Row. 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 Row.
overflows	Boolean	readonly	If true, the story has overset text.
overprintFill	Boolean	read/write	If true, the fill of the object will overprint.
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.
parent	Table	readonly	The parent of the Row (a Table).
parentColumn	Column	readonly	The parent column of the cell.
parentRow	Row	readonly	The parent row of the cell.
properties	Object	read/write	A property that allows setting of several properties at the same time.
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 String	read/write	The stroke type of the right edge. Can also accept: String.
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.The API has been deprecated. Use TextLeftInset or GraphicRightInset
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.
textBottomInset	Number String	read/write	The bottom inset of the text cell.
textLeftInset	Number String	read/write	The left inset of the text cell.
textRightInset	Number String	read/write	The right inset of the text cell.
textTopInset	Number String	read/write	The top inset of the text cell.
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 String	read/write	The stroke type of the top edge. Can also accept: String.
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. The API has been deprecated. Use TextTopInset or GraphicTopInset
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 Row. For a table or row, specifies the sum of the column widths.
writingDirection	HorizontalOrVertical HorizontalOrVertical.HORIZONTAL HorizontalOrVertical.VERTICAL	read/write	The direction of the text in the cell.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

Text changeGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Text changeGrep (reverseOrder:Boolean)

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

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Text changeText (reverseOrder:Boolean)

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

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Text changeTransliterate (reverseOrder:Boolean)

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

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

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)

Text findGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Text findGrep (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Text findText (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Text findTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Row getElements ()

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

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 Row.

undefined redistribute (using:HorizontalOrVertical, thru:Varies Cell Column Row)

Redistributes the specified range of Rows so that the Rows have a uniform size. Note: The maximum or minimum height or width specified for some of the cells in the range may prevent them from being exactly even.

Parameter	Type	Description
using	HorizontalOrVertical HorizontalOrVertical.HORIZONTAL HorizontalOrVertical.VERTICAL	The direction in which to redistribute.
thru	Cell Column Row	The last Row in the range. Can accept: Cell, Column or Row. (Optional)

Parameter

Type

Description

using

HorizontalOrVertical

HorizontalOrVertical.HORIZONTAL

HorizontalOrVertical.VERTICAL

The direction in which to redistribute.

thru

Cell

Column

Row

The last Row in the range. Can accept: Cell, Column or Row. (Optional)

undefined remove ()

Deletes the Row.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
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. (Optional) (default: false)

Parameter

Type

Description

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. (Optional)

(default: false)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH SelectionOptions.SET_KEY	The selection status of the Row 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

SelectionOptions.SET_KEY

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

(default: SelectionOptions.REPLACE_WITH)

undefined split (using:HorizontalOrVertical)