Represents a custom view in Microsoft Excel.

Constructors

Section titled "Constructors"

CustomView

new CustomView(a: Workbook, b: boolean, c: boolean): CustomView

Returns CustomView

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

name

Section titled "name" 
name: string

Accessors

Section titled "Accessors"

saveHiddenRowsAndColumns

Section titled "saveHiddenRowsAndColumns"

Gets the value indicating whether hidden row and column settings are saved with the custom view.

get saveHiddenRowsAndColumns(): boolean

Returns boolean

savePrintOptions

Section titled "savePrintOptions"

Gets the value indicating whether print options are saved with the custom view.

get savePrintOptions(): boolean

Returns boolean

windowOptions

Section titled "windowOptions"

Gets the window options for the workbook associated with the custom view.

get windowOptions(): CustomViewWindowOptions

Returns CustomViewWindowOptions

Methods

Section titled "Methods"

apply

Section titled "apply"

Applies all options from the custom view to the associated workbook and its worksheets.

apply(): void

Returns void

getDisplayOptions

Section titled "getDisplayOptions"

Gets the display options associated with the specified worksheet.

getDisplayOptions(worksheet: Worksheet, createIfNull: boolean): CustomViewDisplayOptions

Parameters

  • worksheet: Worksheet

    The worksheet whose associated display options are to be retrieved.
  • createIfNull: boolean

    True to create the display options if it has not yet been allocated. The options will be initialized based on the current state of the Worksheet. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded.

Returns CustomViewDisplayOptions

getHiddenColumns

Section titled "getHiddenColumns"

Gets the hidden columns associated with the specified worksheet.

getHiddenColumns(worksheet: Worksheet, createIfNull: boolean): HiddenColumnCollection

Parameters

  • worksheet: Worksheet

    The worksheet whose associated hidden columns are to be retrieved.
  • createIfNull: boolean

    True to create the hidden column if it has not yet been allocated of the Worksheet. The options will be initialized based on the current state. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. Also this will not allocate the collection unless the [[saveHiddenRowsAndColumns]] is true.

Returns HiddenColumnCollection

getHiddenRows

Section titled "getHiddenRows"

Gets the hidden rows associated with the specified worksheet.

getHiddenRows(worksheet: Worksheet, createIfNull: boolean): HiddenRowCollection

Parameters

  • worksheet: Worksheet

    The worksheet whose associated hidden rows are to be retrieved.
  • createIfNull: boolean

    True to create the hidden column if it has not yet been allocated. The options will be initialized based on the current state of the Worksheet. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. Also this will not allocate the collection unless the [[saveHiddenRowsAndColumns]] is true.

Returns HiddenRowCollection

getPrintOptions

Section titled "getPrintOptions"

Gets the print options associated with the specified worksheet.

getPrintOptions(worksheet: Worksheet, createIfNull: boolean): PrintOptions

Parameters

  • worksheet: Worksheet

    The worksheet whose associated print options are to be retrieved.
  • createIfNull: boolean

    True to create the print options if it has not yet been allocated. The options will be initialized based on the current state of the Worksheet. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. Also this will not allocate the collection unless the [[savePrintOptions]] is true.

Returns PrintOptions

getSheetDisplayOptions

Section titled "getSheetDisplayOptions"

Gets the display options associated with the specified sheet.

getSheetDisplayOptions(sheet: Sheet, createIfNull: boolean): DisplayOptionsBase

Parameters

  • sheet: Sheet

    The sheet whose associated display options are to be retrieved.
  • createIfNull: boolean

    True to create the display options if it has not yet been allocated. The options will be initialized based on the current state of the Sheet. Note the options should only have been null if there were no options for the Sheet when the Workbook was loaded.

Returns DisplayOptionsBase

getSheetPrintOptions

Section titled "getSheetPrintOptions"

Gets the print options associated with the specified sheet.

getSheetPrintOptions(sheet: Sheet, createIfNull: boolean): PrintOptionsBase

Parameters

  • sheet: Sheet

    The sheet whose associated print options are to be retrieved.
  • createIfNull: boolean

    True to create the print options if it has not yet been allocated. The options will be initialized based on the current state of the Sheet. Note the options should only have been null if there were no options for the Sheet when the Workbook was loaded. Also this will not allocate the collection unless the [[savePrintOptions]] is true.

Returns PrintOptionsBase