Returns and sets formatting information on a range of cells.

Constructors

Section titled "Constructors"

SpreadsheetCellRangeFormat 

new SpreadsheetCellRangeFormat(a: RangeWorksheetCellFormatBase): SpreadsheetCellRangeFormat

Returns SpreadsheetCellRangeFormat

Properties

Section titled "Properties"

propertyChanged

Section titled "propertyChanged"

Inherited from: PropertyChangeNotifierExtended 

propertyChanged: object

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

alignment

Section titled "alignment"

Gets or sets the horizontal alignment of the content in a cell. The horizontal alignment of the content in a cell.

 
get alignment(): HorizontalCellAlignment

Returns HorizontalCellAlignment 

set alignment(a: HorizontalCellAlignment): void

Parameters

  • a: HorizontalCellAlignment

Returns void

fill

Section titled "fill"

Gets or sets the fill of the cell. The fill of the cell.

 
get fill(): CellFill

Returns CellFill 

set fill(a: CellFill): void

Parameters

  • a: CellFill

Returns void

font

Section titled "font"

Gets or sets the default font formatting.

 
get font(): IWorkbookFont

Returns IWorkbookFont

formatString

Section titled "formatString"

Gets or sets the number format string.

 
get formatString(): string

Returns string 

set formatString(a: string): void

Parameters

  • a: string

Returns void

hidden

Section titled "hidden"

Gets or sets the value which indicates whether the cell value is hidden in protected mode.

 
get hidden(): boolean | null

Returns boolean | null 

set hidden(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

indent

Section titled "indent"

Gets or sets the indent in units of average character widths.

 
get indent(): number

Returns number 

set indent(a: number): void

Parameters

  • a: number

Returns void

locked

Section titled "locked"

Gets or sets the value which indicates whether the cell is locked in protected mode.

 
get locked(): boolean | null

Returns boolean | null 

set locked(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

rotation

Section titled "rotation"

Gets or sets the rotation of the cell content in degrees.

 
get rotation(): number

Returns number 

set rotation(a: number): void

Parameters

  • a: number

Returns void

shrinkToFit

Section titled "shrinkToFit"

Gets or sets the value indicating whether the cell content will shrink to fit the cell.

 
get shrinkToFit(): boolean | null

Returns boolean | null 

set shrinkToFit(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

style

Section titled "style"

Gets or sets the parent [[WorkbookStyle]] of the format.

 
get style(): WorkbookStyle

Returns WorkbookStyle 

set style(a: WorkbookStyle): void

Parameters

  • a: WorkbookStyle

Returns void

verticalAlignment

Section titled "verticalAlignment"

Gets or sets the vertical alignment of the content in a cell. The vertical alignment of the content in a cell.

 
get verticalAlignment(): VerticalCellAlignment

Returns VerticalCellAlignment 

set verticalAlignment(a: VerticalCellAlignment): void

Parameters

  • a: VerticalCellAlignment

Returns void

wrapText

Section titled "wrapText"

Gets or sets the value which indicates whether text will wrap in a cell.

 
get wrapText(): boolean | null

Returns boolean | null 

set wrapText(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

Methods

Section titled "Methods"

addListener

Section titled "addListener"

Inherited from: PropertyChangeNotifierExtended 

addListener(a: ITypedPropertyChangeListener$2<any, string>, b: boolean): void

Parameters

  • a: ITypedPropertyChangeListener$2<any, string>
  • b: boolean

Returns void

d

Section titled "d"

Inherited from: PropertyChangeNotifierExtended 

d(a: any, b: string, c: any): void

Parameters

  • a: any
  • b: string
  • c: any

Returns void

onPropertyValueChanged

Section titled "onPropertyValueChanged"

Inherited from: PropertyChangeNotifierExtended 

onPropertyValueChanged(a: any, b: string, c: any): void

Parameters

  • a: any
  • b: string
  • c: any

Returns void

removeListener

Section titled "removeListener"

Inherited from: PropertyChangeNotifierExtended 

removeListener(a: ITypedPropertyChangeListener$2<any, string>): void

Parameters

  • a: ITypedPropertyChangeListener$2<any, string>

Returns void

setBorders

Section titled "setBorders"

Sets the specified borders for the associated range to the specified style and color.

 
setBorders(borders: SpreadsheetCellRangeBorders, borderColor: WorkbookColorInfo, borderStyle: CellBorderLineStyle): void

Parameters

  • borders: SpreadsheetCellRangeBorders

    Identifies the borders to be changed
  • borderColor: WorkbookColorInfo

    The color for the borders
  • borderStyle: CellBorderLineStyle

    The style for the borders

Returns void