Adobe InCopy CS6 (8.0) Object Model JS: Column

InCopy CS6

Class

Column

 A table column.

QuickLinks

addEventListener, changeGlyph, changeGrep, changeText, changeTransliterate, createOutlines, findGlyph, findGrep, findText, findTransliterate, getElements, merge, recompose, redistribute, remove, removeEventListener, split, toSource, toSpecifier, unmerge

Hierarchy

Table
Column
Cell | Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
autoGrowbool r/wIf 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.
bottomEdgeStrokeColorSwatch r/wThe swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke.
bottomEdgeStrokeGapColorSwatch r/wThe 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.
bottomEdgeStrokeGapOverprintbool r/wIf true, the gap color of the bottom edge border stroke will overprint. Note: Not valid when bottom edge stroke type is solid.
bottomEdgeStrokeGapTintnumber r/wThe 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.
bottomEdgeStrokeOverprintbool r/wIf true, the bottom edge border stroke will overprint.
bottomEdgeStrokeTintnumber r/wThe tint (as a percentage) of the bottom edge border stroke.
bottomEdgeStrokeTypeString
StrokeStyle
r/wThe stroke type of the bottom edge. Can also accept: String.
bottomEdgeStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the bottom edge border stroke.
bottomInsetMeasurement Unit (Number or String) r/wThe bottom inset of the cell.
cellsCells Cell readonlyA collection of table cells.
clipContentToCellbool r/wIf true, clips the cell's content to width and height of the cell.
columnSpannumber readonlyThe number of columns that the object spans.
columnsColumns Column readonlyA collection of table columns.
contents Array of Strings
Array of Strings
NothingEnum
NothingEnum
SpecialCharacters
SpecialCharacters
SpecialCharacters
String
r/wThe 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.
diagonalLineInFrontbool r/wIf true, draws the diagonal line in front of cell contents.
diagonalLineStrokeColorSwatch r/wThe diagonal line color, specified as a swatch.
diagonalLineStrokeGapColorSwatch r/wThe 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.
diagonalLineStrokeGapOverprintbool r/wIf true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid.
diagonalLineStrokeGapTintnumber r/wThe tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid.
diagonalLineStrokeOverprintbool r/wIf true, the diagonal line stroke will overprint.
diagonalLineStrokeTintnumber r/wThe diagonal line tint (as a percentage). (Range: 0 to 100)
diagonalLineStrokeTypeString
StrokeStyle
r/wThe stroke type of the diagonal line(s). Can also accept: String.
diagonalLineStrokeWeightMeasurement Unit (Number or String) r/wThe diagonal line stroke weight.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can also accept: String.
fillTintnumber r/wThe tint (as a percentage) of the fill of the object.
firstBaselineOffsetFirstBaseline:
FirstBaseline.ASCENT_OFFSET
FirstBaseline.CAP_HEIGHT
FirstBaseline.LEADING_OFFSET
FirstBaseline.EMBOX_HEIGHT
FirstBaseline.X_HEIGHT
FirstBaseline.FIXED_HEIGHT
r/wThe distance between the baseline of the text and the top inset of the cell.
gradientFillAnglenumber r/wThe angle of a linear gradient applied to the fill of the object. (Range: -180 to 180)
gradientFillLengthnumber r/wThe 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/wThe starting point (in page coordinates) of a gradient applied to the fill of the Column, in the format [x, y].
heightMeasurement Unit (Number or String) r/wThe height of the Column. For a table or column, specifies the sum of the row heights.
indexnumber readonlyThe index of the Column within its containing object.
innerColumnStrokeColorSwatch r/wThe color, specified as a swatch, of the inner column border stroke.
innerColumnStrokeGapColorSwatch r/wThe 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.
innerColumnStrokeGapOverprintbool r/wIf true, the gap color of the inner column border stroke will overprint. Note: Not valid when inner column stroke type is solid.
innerColumnStrokeGapTintnumber r/wThe 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.
innerColumnStrokeOverprintbool r/wIf true, the inner column border stroke will overprint.
innerColumnStrokeTintnumber r/wThe tint (as a percentage) of the inner column border stroke. (Range: 0 to 100)
innerColumnStrokeTypeString
StrokeStyle
r/wThe stroke type of the inner column. Can also accept: String.
innerColumnStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the inner column border stroke.
innerRowStrokeColorSwatch r/wThe color, specified as a swatch, of the inner row border stroke.
innerRowStrokeGapColorSwatch r/wThe 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.
innerRowStrokeGapOverprintbool r/wIf true, the gap color of the inner row border stroke will overprint. Note: Not valid when inner row stroke type is solid.
innerRowStrokeGapTintnumber r/wThe tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) Note: Not valid when inner row stroke type is solid.
innerRowStrokeOverprintbool r/wIf true, the inner row border stroke will overprint.
innerRowStrokeTintnumber r/wThe tint (as a percentage) of the inner row border stroke. (Range: 0 to 100)
innerRowStrokeTypeString
StrokeStyle
r/wThe stroke type of the inner row. Can also accept: String.
innerRowStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the inner row border strokes.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
keepWithNextRowbool r/wIf true, keeps the row with the next row when the table is split across text frames or pages.
leftEdgeStrokeColorSwatch r/wThe swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke.
leftEdgeStrokeGapColorSwatch r/wThe 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.
leftEdgeStrokeGapOverprintbool r/wIf true, the gap color of the left edge border stroke will overprint. Note: Not valid when left edge stroke type is solid.
leftEdgeStrokeGapTintnumber r/wThe 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.
leftEdgeStrokeOverprintbool r/wIf true, the left edge border stroke will overprint.
leftEdgeStrokeTintnumber r/wThe tint (as a percentage) of the left edge border stroke. (Range: 0 to 100)
leftEdgeStrokeTypeString
StrokeStyle
r/wThe stroke type of the left edge. Can also accept: String.
leftEdgeStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the left edge border stroke.
leftInsetMeasurement Unit (Number or String) r/wThe left inset of the cell.
maximumHeightMeasurement Unit (Number or String) r/wThe 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.
minimumFirstBaselineOffsetMeasurement Unit (Number or String) (range: 0 - 8640) r/wThe space between the baseline of the text and the top inset of the frame or cell.
minimumHeightMeasurement Unit (Number or String) r/wThe 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.
namestring readonlyThe name of the Column.
overflowsbool readonlyIf true, the story has overset text.
overprintFillbool r/wIf true, the fill of the object will overprint.
paragraphSpacingLimitMeasurement Unit (Number or String) r/wThe maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified.
parentTable readonlyThe parent of the Column (a Table).
parentColumnColumn readonlyThe parent column of the cell.
parentRowRow readonlyThe parent row of the cell.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightEdgeStrokeColorSwatch r/wThe color, specified as a swatch, of the right edge border stroke.
rightEdgeStrokeGapColorSwatch r/wThe 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.
rightEdgeStrokeGapOverprintbool r/wIf true, the gap color of the right edge border stroke will overprint. Note: Not valid when right edge stroke type is solid.
rightEdgeStrokeGapTintnumber r/wThe 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.
rightEdgeStrokeOverprintbool r/wIf true, the right edge border stroke will overprint.
rightEdgeStrokeTintnumber r/wThe tint (as a percentage) of the right edge border stroke. (Range: 0 to 100)
rightEdgeStrokeTypeString
StrokeStyle
r/wThe stroke type of the right edge. Can also accept: String.
rightEdgeStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the right edge border stroke.
rightInsetMeasurement Unit (Number or String) r/wThe right inset of the cell.
rotationAnglenumber r/wThe rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270.
rowSpannumber readonlyThe number of rows that the object spans.
rowTypeRowTypes:
RowTypes.BODY_ROW
RowTypes.HEADER_ROW
RowTypes.FOOTER_ROW
RowTypes.MIXED_STATE
r/wThe row type.
rowsRows Row readonlyA collection of table rows.
startRowStartParagraph:
StartParagraph.ANYWHERE
StartParagraph.NEXT_COLUMN
StartParagraph.NEXT_FRAME
StartParagraph.NEXT_PAGE
StartParagraph.NEXT_ODD_PAGE
StartParagraph.NEXT_EVEN_PAGE
r/wIndicates where to start the row.
topEdgeStrokeColorSwatch r/wThe swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke.
topEdgeStrokeGapColorSwatch r/wThe 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.
topEdgeStrokeGapOverprintbool r/wIf true, the gap color of the top edge border stroke will overprint. Note: Not valid when top edge stroke type is solid.
topEdgeStrokeGapTintnumber r/wThe 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.
topEdgeStrokeOverprintbool r/wIf true, the top edge border stroke will overprint.
topEdgeStrokeTintnumber r/wThe tint (as a percentage) of the top edge border stroke. (Range: 0 to 100)
topEdgeStrokeTypeString
StrokeStyle
r/wThe stroke type of the top edge. Can also accept: String.
topEdgeStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the top edge border stroke.
topInsetMeasurement Unit (Number or String) r/wThe top inset of the cell.
topLeftDiagonalLinebool r/wIf true, draws a diagonal line starting from the top left.
topRightDiagonalLinebool r/wIf true, draws a diagonal line starting from the top right.
verticalJustificationVerticalJustification:
VerticalJustification.TOP_ALIGN
VerticalJustification.CENTER_ALIGN
VerticalJustification.BOTTOM_ALIGN
VerticalJustification.JUSTIFY_ALIGN
r/wThe vertical alignment of cell.
widthMeasurement Unit (Number or String) r/wThe width of the Column. For a table or row, specifies the sum of the column widths.
writingDirectionHorizontalOrVertical:
HorizontalOrVertical.HORIZONTAL
HorizontalOrVertical.VERTICAL
r/wThe direction of the text in the cell.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of PageItem createOutlines ()
Converts text to outlines. Each line of text becomes a polygon object.

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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

Cell merge ([with: varies])
Merges the cells.

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

void recompose ()
Recomposes the text in the Column.

void redistribute (using: HorizontalOrVertical[, thru: varies])
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.

ParameterTypeDescription
usingHorizontalOrVertical:
HorizontalOrVertical.HORIZONTAL
HorizontalOrVertical.VERTICAL
The direction in which to redistribute.
thruCell
Column
Row
The last Column in the range. Can accept: Cell, Column or Row. (Optional)

void remove ()
Deletes the Column.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

ParameterTypeDescription
usingHorizontalOrVertical:
HorizontalOrVertical.HORIZONTAL
HorizontalOrVertical.VERTICAL
The direction in which to split the cell.

string toSource ()
Generates a string which, if executed, will return the Column.

string toSpecifier ()
Retrieves the object specifier.

Array of Cell unmerge ()
Unmerges all merged cells in the Column.

Element of

Cell.parent

Cell.parentColumn

Column.parentColumn

Row.parentColumn

Used in:

Column Columns.nextItem (obj: Column)

Column Columns.previousItem (obj: Column)

Return

Array of Column Column.getElements ()

Column Columns.[] (index: number)

Column Columns.anyItem ()

Array of Column Columns.everyItem ()

Column Columns.firstItem ()

Column Columns.item (index: varies)

Column Columns.itemByName (name: string)

Array of Column Columns.itemByRange (from: varies, to: varies)

Column Columns.lastItem ()

Column Columns.middleItem ()

Column Columns.nextItem (obj: Column)

Column Columns.previousItem (obj: Column)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index