constructor

• new SpreadsheetCellRangeFormat(a): SpreadsheetCellRangeFormat

• Parameters

  • a: RangeWorksheetCellFormatBase

  Returns SpreadsheetCellRangeFormat

Static $t

alignment

• get alignment(): HorizontalCellAlignment

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

  Throws

  [[InvalidEnumArgumentException]] The value assigned is not defined in the [[HorizontalCellAlignment]] enumeration.

  See

  [[verticalAlignment]]

  Returns HorizontalCellAlignment

• set alignment(a): void

• Parameters

  • a: HorizontalCellAlignment

  Returns void

fill

• get fill(): CellFill

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

  See

  • [[CellFill]]
  • [[CellFillPattern]]
  • [[CellFillLinearGradient]]
  • [[CellFillRectangularGradient]]

  Returns CellFill

• set fill(a): void

• Parameters

  • a: CellFill

  Returns void

font

• get font(): IWorkbookFont

• Gets or sets the default font formatting.

  This font formatting is just the default font used in the cell. This can be overridden by strings on a character by character basis by using the [[FormattedString]] class.

  The default font formatting.

  Returns IWorkbookFont

formatString

• get formatString(): string

• Gets or sets the number format string.

  For more information on excel format strings, consult Microsoft Excel help.

  The number format string.

  Throws

  [[ArgumentException]] The assigned value is an invalid format string and [[Workbook.validateFormatStrings]] is True.

  See

  [[Workbook.validateFormatStrings]]

  Returns string

• set formatString(a): void

• Parameters

  • a: string

  Returns void

hidden

• get hidden(): boolean

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

  The Hidden value is used in Excel file only if the associated [[Worksheet]] or [[Workbook]] is protected. Otherwise the value is ignored.

  The value which indicates whether the cell value is hidden in protected mode.

  See

  Returns boolean

• set hidden(a): void

• Parameters

  • a: boolean

  Returns void

indent

• get indent(): number

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

  A value of -1 indicates that the default value should be used.

  The indent in units of average character widths or -1 to use the default indent.

  Throws

  [[ArgumentOutOfRangeException]] The assigned value is not -1 and is outside the valid indent level range of 0 and 250.

  Returns number

• set indent(a): void

• Parameters

  • a: number

  Returns void

locked

• get locked(): boolean

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

  The Locked value is used in Excel file only if the associated [[Worksheet]] or [[Workbook]] is protected. Otherwise the value is ignored.

  The valid which indicates whether the cell is locked in protected mode.

  See

  Returns boolean

• set locked(a): void

• Parameters

  • a: boolean

  Returns void

rotation

• get rotation(): number

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

  Cell text rotation, in degrees; 0 – 90 is up 0 – 90 degrees, 91 – 180 is down 1 – 90 degrees, and 255 is vertical.

  The rotation of the cell content in degrees.

  Returns number

• set rotation(a): void

• Parameters

  • a: number

  Returns void

shrinkToFit

• get shrinkToFit(): boolean

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

  If True, the size of the cell font will shrink so all data fits within the cell.

  The value indicating whether the cell content will shrink to fit the cell.

  Throws

  [[InvalidEnumArgumentException]] The value assigned is not defined in the ExcelDefaultableBoolean enumeration.

  Returns boolean

• set shrinkToFit(a): void

• Parameters

  • a: boolean

  Returns void

style

• get style(): WorkbookStyle

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

  The parent style of a cell or differential format provides default format values. Depending on which FormatOptions flags are present, only certain groups of format properties will be resolved from parent style. When any of the properties in a group is set to a non-default value, the FormatOptions will automatically have that flag included so the format provides values in that group rather than the style providing values in that group.

  By default, all cell and differential formats will have a parent style of the normal style, which is exposed by the [[WorkbookStyleCollection.normalStyle]] property. If a value of null is assigned as the Style for a cell or differential format, then NormalStyle will actually be set.

  A [[WorkbookStyle]] instance if this is a cell or differential format, or null if this is a style format.

  Throws

  [[InvalidOperationException]] The value assigned is non-null and the format is a style format.

  Throws

  [[ArgumentException]] The value assigned is from a different [[Workbook]].

  See

  • [[Workbook.styles]]
  • [[WorkbookStyle]]

  Returns WorkbookStyle

• set style(a): void

• Parameters

  • a: WorkbookStyle

  Returns void

verticalAlignment

• get verticalAlignment(): VerticalCellAlignment

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

  Throws

  [[InvalidEnumArgumentException]] The value assigned is not defined in the [[VerticalCellAlignment]] enumeration.

  See

  [[alignment]]

  Returns VerticalCellAlignment

• set verticalAlignment(a): void

• Parameters

  • a: VerticalCellAlignment

  Returns void

wrapText

• get wrapText(): boolean

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

  If True, and the row associated with the cell has a default [[WorksheetRow.height]], the row's height will automatically be increased to fit wrapped content.

  The value which indicates whether text will wrap in a cell.

  Throws

  [[InvalidEnumArgumentException]] The value assigned is not defined in the ExcelDefaultableBoolean enumeration.

  Returns boolean

• set wrapText(a): void

• Parameters

  • a: boolean

  Returns void

setBorders

• setBorders(borders, borderColor, borderStyle): void

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

  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