A cell style.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| appliedParagraphStyle | any | r/w | The paragraph style applied to the CellStyle. Can return: ParagraphStyle or NothingEnum enumerator. Can also accept: String. |
| basedOn | any | r/w | The object that the CellStyle is based on. Can return: CellStyle, String or NothingEnum enumerator. |
| bottomEdgeStrokeColor | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. Can return: Swatch or NothingEnum enumerator. |
| bottomEdgeStrokeGapColor | any | 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. Can return: Swatch or NothingEnum enumerator. |
| bottomEdgeStrokeGapOverprint | any | 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. Can return: Boolean or NothingEnum enumerator. |
| bottomEdgeStrokeGapTint | any | 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. Can return: Real or NothingEnum enumerator. |
| bottomEdgeStrokeOverprint | any | r/w | If true, the bottom edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| bottomEdgeStrokeTint | any | r/w | The tint (as a percentage) of the bottom edge border stroke. Can return: Real or NothingEnum enumerator. |
| bottomEdgeStrokeType | any | r/w | The stroke type of the bottom edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. |
| bottomEdgeStrokeWeight | any | r/w | The stroke weight of the bottom edge border stroke. Can return: Unit or NothingEnum enumerator. |
| bottomInset | any | r/w | The bottom inset of the cell. Can return: Unit or NothingEnum enumerator. |
| clipContentToCell | any | r/w | If true, clips the cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator. |
| diagonalLineInFront | any | r/w | If true, draws the diagonal line in front of cell contents. Can return: Boolean or NothingEnum enumerator. |
| diagonalLineStrokeColor | any | r/w | The diagonal line color, specified as a swatch. Can return: Swatch or NothingEnum enumerator. |
| diagonalLineStrokeGapColor | any | 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. Can return: Swatch or NothingEnum enumerator. |
| diagonalLineStrokeGapOverprint | any | r/w | If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid. Can return: Boolean or NothingEnum enumerator. |
| diagonalLineStrokeGapTint | any | r/w | The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid. Can return: Real or NothingEnum enumerator. |
| diagonalLineStrokeOverprint | any | r/w | If true, the diagonal line stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| diagonalLineStrokeTint | any | r/w | The diagonal line tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| diagonalLineStrokeType | any | r/w | The stroke type of the diagonal line(s). Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. |
| diagonalLineStrokeWeight | any | r/w | The diagonal line stroke weight. Can return: Unit or NothingEnum enumerator. |
| fillColor | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the CellStyle. Can return: Swatch or NothingEnum enumerator. Can also accept: String. |
| fillTint | any | r/w | The tint (as a percentage) of the fill of the CellStyle. Can return: Real or NothingEnum enumerator. |
| firstBaselineOffset | any | r/w | The distance between the baseline of the text and the top inset of the cell. Can return: FirstBaseline enumerator or NothingEnum enumerator. |
| gradientFillAngle | any | r/w | The angle of a linear gradient applied to the CellStyle's fill. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. |
| gradientFillLength | any | r/w | The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the CellStyle. Can return: Real or NothingEnum enumerator. |
| gradientFillStart | any | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the CellStyle, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator. |
| id | any | readonly | The unique ID of the CellStyle. Can return: Long Integer or NothingEnum enumerator. |
| index | any | readonly | The index of the CellStyle within its containing object. Can return: Long Integer or NothingEnum enumerator. |
| label | any | r/w | A property that can be set to any string. Can return: String or NothingEnum enumerator. |
| leftEdgeStrokeColor | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. Can return: Swatch or NothingEnum enumerator. |
| leftEdgeStrokeGapColor | any | 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. Can return: Swatch or NothingEnum enumerator. |
| leftEdgeStrokeGapOverprint | any | 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. Can return: Boolean or NothingEnum enumerator. |
| leftEdgeStrokeGapTint | any | 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. Can return: Real or NothingEnum enumerator. |
| leftEdgeStrokeOverprint | any | r/w | If true, the left edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| leftEdgeStrokeTint | any | r/w | The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| leftEdgeStrokeType | any | r/w | The stroke type of the left edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. |
| leftEdgeStrokeWeight | any | r/w | The stroke weight of the left edge border stroke. Can return: Unit or NothingEnum enumerator. |
| leftInset | any | r/w | The left inset of the cell. Can return: Unit or NothingEnum enumerator. |
| minimumFirstBaselineOffset | any | r/w | The space between the baseline of the text and the top inset of the frame or cell. Can return: Unit (0 - 8640 points) or NothingEnum enumerator (0 - 8640). |
| name | any | r/w | The name of the CellStyle. Can return: String or NothingEnum enumerator. |
| overprintFill | any | r/w | If true, the fill of the CellStyle will overprint. Can return: Boolean or NothingEnum enumerator. |
| paragraphSpacingLimit | any | r/w | The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified. Can return: Unit or NothingEnum enumerator. |
| parent | any | readonly | The parent of the CellStyle (a Document, Application or CellStyleGroup). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rightEdgeStrokeColor | any | r/w | The color, specified as a swatch, of the right edge border stroke. Can return: Swatch or NothingEnum enumerator. |
| rightEdgeStrokeGapColor | any | 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. Can return: Swatch or NothingEnum enumerator. |
| rightEdgeStrokeGapOverprint | any | 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. Can return: Boolean or NothingEnum enumerator. |
| rightEdgeStrokeGapTint | any | 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. Can return: Real or NothingEnum enumerator. |
| rightEdgeStrokeOverprint | any | r/w | If true, the right edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| rightEdgeStrokeTint | any | r/w | The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| rightEdgeStrokeType | any | r/w | The stroke type of the right edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. |
| rightEdgeStrokeWeight | any | r/w | The stroke weight of the right edge border stroke. Can return: Unit or NothingEnum enumerator. |
| rightInset | any | r/w | The right inset of the cell. Can return: Unit or NothingEnum enumerator. |
| rotationAngle | any | r/w | The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270. Can return: Real or NothingEnum enumerator. |
| topEdgeStrokeColor | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. Can return: Swatch or NothingEnum enumerator. |
| topEdgeStrokeGapColor | any | 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. Can return: Swatch or NothingEnum enumerator. |
| topEdgeStrokeGapOverprint | any | 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. . Can return: Boolean or NothingEnum enumerator. |
| topEdgeStrokeGapTint | any | 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. Can return: Real or NothingEnum enumerator. |
| topEdgeStrokeOverprint | any | r/w | If true, the top edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| topEdgeStrokeTint | any | r/w | The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| topEdgeStrokeType | any | r/w | The stroke type of the top edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. |
| topEdgeStrokeWeight | any | r/w | The stroke weight of the top edge border stroke. Can return: Unit or NothingEnum enumerator. |
| topInset | any | r/w | The top inset of the cell. Can return: Unit or NothingEnum enumerator. |
| topLeftDiagonalLine | any | r/w | If true, draws a diagonal line starting from the top left. Can return: Boolean or NothingEnum enumerator. |
| topRightDiagonalLine | any | r/w | If true, draws a diagonal line starting from the top right. Can return: Boolean or NothingEnum enumerator. |
| verticalJustification | any | r/w | The vertical alignment of cell. Can return: VerticalJustification enumerator or NothingEnum enumerator. |
Methods
CellStyle
duplicate ()
Duplicates the CellStyle.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of CellStyle
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. |
CellStyle
move (to:
LocationOptions[, reference:
any])
Moves the CellStyle to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions
: BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location relative to the reference object or within the containing object. |
| reference |
ParagraphStyle
ParagraphStyleGroup CharacterStyle CharacterStyleGroup CellStyle CellStyleGroup TableStyle TableStyleGroup Document Application |
The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) |
void remove ([replacingWith:
CellStyle])
Deletes the CellStyle.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | CellStyle | The CellStyle to apply in place of the deleted CellStyle. (Optional) |
string toSource ()
Generates a string which, if executed, will return the CellStyle.
string toSpecifier ()
Retrieves the object specifier.
Element of:
Application.allCellStylesCell.appliedCellStyle
CellStyleGroup.allCellStyles
Document.allCellStyles
TableStyle.bodyRegionCellStyle
TableStyle.footerRegionCellStyle
TableStyle.headerRegionCellStyle
TableStyle.leftColumnRegionCellStyle
TableStyle.rightColumnRegionCellStyle
Used in:
CellStyle.remove ( [replacingWith: CellStyle])CellStyles.previousItem ( obj: CellStyle)
CellStyles.nextItem ( obj: CellStyle)
Returned by:
CellStyle CellStyle.duplicate ( )Array of CellStyle CellStyle.getElements ( )
CellStyle CellStyle.move ( to: LocationOptions[, reference: any] )
CellStyle CellStyles.add ( [withProperties: Object] )
CellStyle CellStyles.anyItem ( )
Array of CellStyle CellStyles.everyItem ( )
CellStyle CellStyles.firstItem ( )
CellStyle CellStyles.item ( index: any )
CellStyle CellStyles.itemByID ( id: number )
CellStyle CellStyles.itemByName ( name: string )
Array of CellStyle CellStyles.itemByRange ( from: any, to: any )
CellStyle CellStyles.lastItem ( )
CellStyle CellStyles.middleItem ( )
CellStyle CellStyles.nextItem ( obj: CellStyle )
CellStyle CellStyles.previousItem ( obj: CellStyle )