Adds an event listener.
Object
CellStyle
A cell style.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| ParagraphStyle | String | NothingEnum | read/write | The paragraph style applied to the text. Can return: ParagraphStyle or NothingEnum enumerator. Can also accept: String. | |
| CellStyle | String | read/write | The style that this style is based on. Can return: CellStyle or String. | |
| Swatch | NothingEnum | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. Can return: Swatch or NothingEnum enumerator. | |
| Swatch | NothingEnum | 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. Can return: Swatch or NothingEnum enumerator. | |
| Boolean | NothingEnum | 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. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 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. Can return: Real or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, the bottom edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum | read/write | The tint (as a percentage) of the bottom edge border stroke. Can return: Real or NothingEnum enumerator. | |
| String | StrokeStyle | NothingEnum | read/write | The stroke type of the bottom edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. | |
| Unit | NothingEnum | read/write | The stroke weight of the bottom edge border stroke. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The bottom inset of the cell.The API has been deprecated. Use TextBottomInset or GraphicBottomInset. Can return: Unit or NothingEnum enumerator. | |
| Boolean | NothingEnum | 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. Can return: Boolean or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, clips the graphic cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, clips the text cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, draws the diagonal line in front of cell contents. Can return: Boolean or NothingEnum enumerator. | |
| Swatch | NothingEnum | read/write | The diagonal line color, specified as a swatch. Can return: Swatch or NothingEnum enumerator. | |
| Swatch | NothingEnum | 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. Can return: Swatch or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | 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. | |
| Real | NothingEnum | read/write | 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. | |
| Boolean | NothingEnum | read/write | If true, the diagonal line stroke will overprint. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 0–100 | read/write | The diagonal line tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator. | |
| String | StrokeStyle | NothingEnum | read/write | The stroke type of the diagonal line(s). Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. | |
| Unit | NothingEnum | read/write | The diagonal line stroke weight. Can return: Unit or NothingEnum enumerator. | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| String | Swatch | NothingEnum | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can return: Swatch or NothingEnum enumerator. Can also accept: String. | |
| Real | NothingEnum | read/write | The tint (as a percentage) of the fill of the object. Can return: Real or NothingEnum enumerator. | |
| FirstBaseline | NothingEnum | read/write | The distance between the baseline of the text and the top inset of the cell. Can return: FirstBaseline enumerator or NothingEnum enumerator. | |
| Real | NothingEnum | read/write | The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. | |
| Real | NothingEnum | read/write | The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object. Can return: Real or NothingEnum enumerator. | |
| 2 Units[] | NothingEnum[] | read/write | 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. | |
| Unit | NothingEnum | read/write | The bottom inset of the graphic cell. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The left inset of the graphic cell. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The right inset of the graphic cell. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The top inset of the graphic cell. Can return: Unit or NothingEnum enumerator. | |
| Number | readonly | The unique ID of the CellStyle. | |
| Number | readonly | The index of the CellStyle within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| String | read/write | A property that can be set to any string. | |
| Swatch | NothingEnum | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. Can return: Swatch or NothingEnum enumerator. | |
| Swatch | NothingEnum | 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. Can return: Swatch or NothingEnum enumerator. | |
| Boolean | NothingEnum | 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. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 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. Can return: Real or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, the left edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 0–100 | read/write | The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. | |
| String | StrokeStyle | NothingEnum | read/write | The stroke type of the left edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. | |
| Unit | NothingEnum | read/write | The stroke weight of the left edge border stroke. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The left inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicLeftInset. Can return: Unit or NothingEnum enumerator. | |
| Unit(0-8640points) | NothingEnum | read/write | 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. | |
| String | read/write | The name of the style. | |
| Boolean | NothingEnum | read/write | If true, the fill of the object will overprint. Can return: Boolean or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | 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. | |
| Application | CellStyleGroup | Document | readonly | The parent of the CellStyle (a Document, Application or CellStyleGroup). | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| Swatch | NothingEnum | read/write | The color, specified as a swatch, of the right edge border stroke. Can return: Swatch or NothingEnum enumerator. | |
| Swatch | NothingEnum | 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. Can return: Swatch or NothingEnum enumerator. | |
| Boolean | NothingEnum | 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. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 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. Can return: Real or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, the right edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 0–100 | read/write | The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. | |
| String | StrokeStyle | NothingEnum | read/write | The stroke type of the right edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. | |
| Unit | NothingEnum | read/write | The stroke weight of the right edge border stroke. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The right inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicRightInset. Can return: Unit or NothingEnum enumerator. | |
| Real | NothingEnum | read/write | 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. | |
| Unit | NothingEnum | read/write | The bottom inset of the text cell. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The left inset of the text cell. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The right inset of the text cell. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The top inset of the text cell. Can return: Unit or NothingEnum enumerator. | |
| Swatch | NothingEnum | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. Can return: Swatch or NothingEnum enumerator. | |
| Swatch | NothingEnum | 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. Can return: Swatch or NothingEnum enumerator. | |
| Boolean | NothingEnum | 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. . Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 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. Can return: Real or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, the top edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. | |
| Real | NothingEnum 0–100 | read/write | The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. | |
| String | StrokeStyle | NothingEnum | read/write | The stroke type of the top edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. | |
| Unit | NothingEnum | read/write | The stroke weight of the top edge border stroke. Can return: Unit or NothingEnum enumerator. | |
| Unit | NothingEnum | read/write | The top inset of the cell. The API has been deprecated. Use TextTopInset or GraphicTopInset. Can return: Unit or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, draws a diagonal line starting from the top left. Can return: Boolean or NothingEnum enumerator. | |
| Boolean | NothingEnum | read/write | If true, draws a diagonal line starting from the top right. Can return: Boolean or NothingEnum enumerator. | |
| VerticalJustification | NothingEnum | read/write | The vertical alignment of cell. Can return: VerticalJustification enumerator or NothingEnum enumerator. |
Methods
Duplicates the CellStyle.
→ String
Gets the label value associated with the specified key.
→ CellStyle[]
Resolves the object specifier, creating an array of object references.
→ void
Sets the label to the value associated with the specified key.
Moves the style to the specified location.
reference?
CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | 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.
→ void
Deletes the style.
→ Boolean
Removes the event listener.
→ String
Generates a string which, if executed, will return the CellStyle.
→ String
Retrieves the object specifier.
Object of 16
Properties elsewhere that hold a CellStyle.
Application.allCellStylesCell.appliedCellStyleCellStyle.basedOnCellStyleGroup.allCellStylesDocument.allCellStylesEvent.parentEventListener.parentMutationEvent.parentTableStyle.bodyRegionCellStyleTableStyle.footerRegionCellStyleTableStyle.headerColumnCellStyleTableStyle.headerRegionCellStyleTableStyle.leftColumnRegionCellStyleTableStyle.rightColumnRegionCellStyleXMLExportMap.mappedStyleXMLImportMap.mappedStyle
Parameter of 15
Method parameters that accept a CellStyle.
CellStyle.move(reference)CellStyle.remove(replacingWith)CellStyleGroup.move(reference)CellStyles.itemByRange(from)CellStyles.nextItem(obj)CellStyles.previousItem(obj)CharacterStyle.move(reference)CharacterStyleGroup.move(reference)ParagraphStyle.move(reference)ParagraphStyleGroup.move(reference)TableStyle.move(reference)TableStyleGroup.move(reference)XMLElement.applyCellStyle(using)XMLExportMaps.add(mappedStyle)XMLImportMaps.add(mappedStyle)
Return 16
Methods that return a CellStyle.
CellStyle.duplicate()CellStyle.getElements()CellStyle.move()CellStyles.[]()CellStyles.add()CellStyles.anyItem()CellStyles.everyItem()CellStyles.firstItem()CellStyles.item()CellStyles.itemByID()CellStyles.itemByName()CellStyles.itemByRange()CellStyles.lastItem()CellStyles.middleItem()CellStyles.nextItem()CellStyles.previousItem()