Represents a column in a Microsoft Excel worksheet.

Hierarchy

Hierarchy

Implements

  • IChangeInfoContext
  • IWorksheetRegionAddressContext

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get cellFormat(): IWorksheetCellFormat
  • Gets the default cell format for cells in this row or column.

    Any default properties of the cell's format will take their value from this format when getting a resolved format.

    The default cell format for cells in this row or column.

    Returns IWorksheetCellFormat

  • get hidden(): boolean
  • Gets or sets the value indicating whether the row or column is hidden. The Hidden state also controls the expanded state of rows or columns in outline groups. Basically, an outline group simply provides an easy way to hide and unhide all rows or columns in the group at the same time, via the expansion indicator. The value indicating whether the row or column is hidden.

    Throws

    [[InvalidOperationException]] From the stter if the object was removed from the worksheet.

    See

    • [[outlineLevel]]
    • [[CustomView.getHiddenColumns]]
    • [[CustomView.getHiddenRows]]

    Returns boolean

  • set hidden(a): void
  • Parameters

    • a: boolean

    Returns void

  • get index(): number
  • Gets the 0-based index of the column in the worksheet. The 0-based index of the column in the worksheet.

    Returns number

  • get outlineLevel(): number
  • Gets or sets the outline level for the row or column.

    Microsoft Excel supports hierarchical grouping of rows and columns with a maximum of seven levels of hierarchy. To create a group, set adjacent rows or columns to same outline level. When rows or columns are grouped, an outline indicator will provide a visual representation of the outline level. In addition, an outline group has an expansion indicator at one end of the group, which allows the user to easily hide and unhide all rows or column in the group with a single click.

    The outline level for the row or column.

    Throws

    [[ArgumentOutOfRangeException]] The value assigned is outside the valid outline level range of 0 and 7.

    Throws

    [[InvalidOperationException]] From the stter if the object was removed from the worksheet.

    See

    [[hidden]]

    Returns number

  • set outlineLevel(a): void
  • Parameters

    • a: number

    Returns void

  • get width(): number
  • Gets or sets the column width including padding, in 256ths of the '0' digit character width in the workbook's default font.

    If the width of the column is less than zero, the [[Worksheet.defaultColumnWidth]] of the owning worksheet will be used as the column's width.

    The value assigned must be between -1 and 65535. Invalid values will be automatically adjusted to valid values.

    Setting or getting this property is equivalent to calling [[setWidth]] or [[getWidth]] using the [[WorksheetColumnWidthUnit]] value of Character256th.

    The column width including padding, in 256ths of the '0' digit character width in the workbook's default font.

    Throws

    [[InvalidOperationException]] From the setter if the column was removed from the worksheet.

    See

    • [[getWidth]]
    • [[setWidth]]
    • [[Workbook.characterWidth256thsToPixels]]
    • [[Workbook.pixelsToCharacterWidth256ths]]

    Returns number

  • set width(a): void
  • Parameters

    • a: number

    Returns void

  • get worksheet(): Worksheet
  • Gets the worksheet to which the row or column belongs. The worksheet to which the row or column belongs.

    Returns Worksheet

Methods

  • Sets the [[width]] to the extent required to display the contents of this column.

    Throws

    [[InvalidOperationException]] The column is not associated with a [[Worksheet]] such as when the column has been deleted or the Worksheet is not associated with a [[Workbook]] such as when the Worksheet has been deleted.

    Returns void

  • Sets the width to the extent required to display all of the contents for the specified range of rows.

    Throws

    [[InvalidOperationException]] The column is not associated with a [[Worksheet]] such as when the column has been deleted or the Worksheet is not associated with a [[Workbook]] such as when the Worksheet has been deleted.

    Throws

    [[ArgumentOutOfRangeException]] The 'startRowIndex' must be greater than or equal to 0, less than or equal to the 'endRowIndex' and less than or equal to the Count of the Rows in the Worksheet. Similarly the 'endRowIndex' must be greater than or equal to the 'startRowIndex' and less than the [[WorksheetRowCollection.maxCount]] of the Worksheet's [[Worksheet.rows]] collection which depends upon the [[Workbook.currentFormat]]

    Parameters

    • startRowIndex: number

      A 0-based index of the first row whose contents are to be calculated

    • endRowIndex: number

      A 0-based index of the last row whose contents are to be calculated

    Returns void

  • Returns the width required for the column to display all of its contents.

    Throws

    [[InvalidOperationException]] The column is not associated with a [[Worksheet]] such as when the column has been deleted or the Worksheet is not associated with a [[Workbook]] such as when the Worksheet has been deleted.

    Returns number

  • Returns the width required for the column to display all of the contents for the specified range of rows.

    Throws

    [[InvalidOperationException]] The column is not associated with a [[Worksheet]] such as when the column has been deleted or the Worksheet is not associated with a [[Workbook]] such as when the Worksheet has been deleted.

    Throws

    [[ArgumentOutOfRangeException]] The 'startRowIndex' must be greater than or equal to 0, less than or equal to the 'endRowIndex' and less than or equal to the Count of the Rows in the Worksheet. Similarly the 'endRowIndex' must be greater than or equal to the 'startRowIndex' and less than the [[WorksheetRowCollection.maxCount]] of the Worksheet's [[Worksheet.rows]] collection which depends upon the [[Workbook.currentFormat]]

    Parameters

    • startRowIndex: number

      A 0-based index of the first row whose contents are to be calculated

    • endRowIndex: number

      A 0-based index of the last row whose contents are to be calculated

    Returns number

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Gets the resolved cell formatting for the cells in the row or column.

    Throws

    [[InvalidOperationException]] If the object was removed from the worksheet.

    See

    [[cellFormat]]

    Returns IWorksheetCellFormat

  • Gets the column width in the specified units, or NaN if the column has the default width.

    If 'units' is Character256th, the value returned will be the same as the value of the [[width]] property, with one exception: if the column has the default width, this method will return NaN and Width will return -1.

    Throws

    [[InvalidEnumArgumentException]] 'units' is not defined in the [[WorksheetColumnWidthUnit]] enumeration.

    See

    • [[width]]
    • [[setWidth]]
    • [[Worksheet.getDefaultColumnWidth]]

    Parameters

    Returns number

  • Sets the column width in the specified units.

    Setting a value of NaN will reset the column width so that the column uses the default column width of the worksheet.

    Throws

    [[ArgumentException]] 'value' is infinity.

    Throws

    [[InvalidEnumArgumentException]] 'units' is not defined in the [[WorksheetColumnWidthUnit]] enumeration.

    Throws

    [[InvalidOperationException]] If the column was removed from the worksheet.

    See

    • [[width]]
    • [[getWidth]]
    • [[Worksheet.setDefaultColumnWidth]]

    Parameters

    • value: number

      The width to set on the column, expressed in the specified 'units'.

    • units: WorksheetColumnWidthUnit

      The units in which the 'value' is expressed.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean