Adds an event listener.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Boolean | read/write | If true, the height of the cell or the cells in the Column 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 | |
| Cells |
readonly | A collection of table cells. | |
| 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 |
readonly | A collection of table columns. | |
| NothingEnum[] | NothingEnums[] | PageItem[] | PageItem[] | SpecialCharacters[] | SpecialCharacters[] | SpecialCharacters[] | String[] | Strings[] | Strings[] | PageItems[] |
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. | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
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. | |
| 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 Column, 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. | |
| Number | String unit | read/write | The right inset of the graphic cell. | |
| Number | String unit | read/write | The top inset of the graphic cell. | |
| Number | String unit | read/write | The height of the Column. For a table or column, specifies the sum of the row heights. | |
| Number | readonly | The index of the Column 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. | |
| 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. | |
| 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 | |
| Number | String unit | read/write | The maximum height to which cells in the Column 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 Column. 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. | |
| String | readonly | The name of the Column. | |
| Boolean | readonly | If true, the story has overset text. | |
| Boolean | read/write | If true, the fill of the object will overprint. | |
| 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. | |
| Table | readonly | The parent of the Column (a Table). | |
| Column | readonly | The parent column of the cell. | |
| Row | readonly | The parent row of the cell. | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| 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 |
readonly | A collection of table rows. | |
| StartParagraph | read/write | Indicates where to start the row. | |
| Number | String unit | read/write | The bottom inset of the text cell. | |
| Number | String unit | read/write | The left inset of the text cell. | |
| Number | String unit | read/write | The right inset of the text cell. | |
| Number | String unit | read/write | The top inset of the text cell. | |
| 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 Column. For a table or row, specifies the sum of the column widths. | |
| HorizontalOrVertical | read/write | The direction of the text in the cell. |
Methods
→ Text[]
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
→ Text[]
Finds text that matches the find what value and replaces the text with the change to value.
→ Text[]
Finds text that matches the find what value and replaces the text with the change to value.
→ Text[]
Finds text that matches the find character type value and replaces the text with the change character type value.
→ 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.
→ Text[]
Finds glyphs that match the find what value.
→ Text[]
Finds text that matches the find what value.
→ Text[]
Finds text that matches the find what value.
→ Text[]
Finds text that matches the find character type value.
→ Column[]
Resolves the object specifier, creating an array of object references.
→ Cell
Merges the cells.
→ void
Recomposes the text in the Column.
→ void
Redistributes the specified range of Columns so that the Columns 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.
→ void
Deletes the Column.
→ Boolean
Removes the event listener.
→ void
Selects the object.
existingSelection?
SelectionOptions
The selection status of the Column in relation to previously selected objects.
→ void
Splits the cell along the specified axis.
→ String
Generates a string which, if executed, will return the Column.
→ String
Retrieves the object specifier.
→ Cell[]
Unmerges all merged cells in the Column.
Object of 7
Properties elsewhere that hold a Column.
Parameter of 29
Method parameters that accept a Column.
Cell.merge(with)Character.duplicate(reference)Character.move(reference)Column.merge(with)Column.redistribute(thru)Columns.add(reference)Columns.itemByRange(from)Columns.nextItem(obj)Columns.previousItem(obj)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)Text.duplicate(reference)Text.move(reference)TextColumn.duplicate(reference)TextColumn.move(reference)TextStyleRange.duplicate(reference)TextStyleRange.move(reference)Word.duplicate(reference)Word.move(reference)XmlStory.duplicate(reference)
Return 12
Methods that return a Column.