Adobe InDesign CS (3.0) Object Model JS: Column

InDesign CS

Class

Column

 A table column.

QuickLinks

createOutlines, merge, redistribute, remove, search, select, split, unmerge

Hierarchy

Cell | Column | Row | Table
Column
Cell | Column | Row

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.
bottomEdgeStrokeTypeStrokeStyle r/wThe stroke type of the bottom edge
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 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 readonlyA collection of table columns.
contentsNothingEnumSpecialCharacters
String
r/wThe cell's text contents. Can return: String or SpecialCharacters enumerator. Can also accept: NothingEnum enumerator.
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)
diagonalLineStrokeTypeStrokeStyle r/wThe diagonal line stroke type.
diagonalLineStrokeWeightMeasurement Unit (Number or String) r/wThe diagonal line stroke weight.
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 object, 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)
innerColumnStrokeTypeStrokeStyle r/wThe stroke type of the inner column border stroke.
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)
innerRowStrokeTypeStrokeStyle r/wThe stroke type of the inner row
innerRowStrokeWeightMeasurement Unit (Number or String) r/wThe stroke weight of the inner row border strokes.
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)
leftEdgeStrokeTypeStrokeStyle r/wThe stroke type of the left edge border stroke.
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) r/wThe minimum distance in points 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.
parentCell
Column
Row
Table
readonlyThe parent of the Column (a Table, Cell, Column or Row).
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)
rightEdgeStrokeTypeStrokeStyle r/wThe stroke type of the right edge border stroke.
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 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.
textCellRotationFollowsStoryDirectionbool r/wWhether text cell direction matches the story direction
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)
topEdgeStrokeTypeStrokeStyle r/wThe stroke type of the top edge border stroke.
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.

Methods

Instances

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.

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

Cell merge (with: Cell)
Merge cells together

ParameterTypeDescription
withCellThe cell to merge with

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

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

ParameterTypeDescription
forstringWhat to look for (Optional)
wholeWordboolIf true, then disregard text embedded within a larger word (Optional)
caseSensitiveboolIf true, then search only for text that matches case (Optional)
replacingWithstringWhat to replace the found text with, either a string or a special character (Optional)
withFindAttributesObjectA record of find preference settings to use (Optional)
withChangeAttributesObjectA record of change preference settings to use (Optional)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE])
Select this object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE
How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE)

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.

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

Element of

Cell.parent

Cell.parentColumn

Column.parent

Column.parentColumn

Row.parent

Row.parentColumn

Used in:

void Column.redistribute (using: HorizontalOrVertical[, thru: any])

Column Columns.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

void Row.redistribute (using: HorizontalOrVertical[, thru: any])

Return

Column Columns.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3dContents :: Index