Abstract base class which exposes the various workbook window options available which can be saved with both a workbook and a custom view.

This class provides a way to control how a workbook is displayed when it is viewed in Microsoft Excel.

See

Hierarchy

Hierarchy

Implements

  • IChangeInfoContext

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get scrollBars(): ScrollBars
  • Gets or sets the scroll bars shown in the workbook window.

    The vertical scroll bar occupies the entire height of the application if it is visible.

    The horizontal scroll bar occupies the width of the application not used by the worksheet tab bar, if it is visible. Otherwise, it occupies the entire width of the application.

    The scroll bars shown in the workbook window.

    Throws

    InvalidEnumArgumentException The assigned value is not defined in the scrollBars enumeration.

    See

    Returns ScrollBars

  • set scrollBars(a: ScrollBars): void
  • Parameters

    Returns void

  • get selectedSheet(): Sheet
  • Gets or sets the selected worksheet of the workbook.

    If this is an instance of CustomViewWindowOptions and the SelectedWorksheet value is null, the workbook's selected worksheet will not be changed when the associated CustomView is applied.

    Note: If the selected worksheet does not have its DisplayOptionsBase.visibility set to Visible when the workbook is saved, another worksheet will be selected.

    The selected worksheet of the workbook.

    Throws

    ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated workbook has at least one Worksheet.

    Throws

    ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Returns Sheet

  • set selectedSheet(a: Sheet): void
  • Parameters

    Returns void

  • get selectedWorksheet(): Worksheet
  • Gets or sets the selected worksheet of the workbook.

    If this is an instance of CustomViewWindowOptions and the SelectedWorksheet value is null, the workbook's selected worksheet will not be changed when the associated CustomView is applied.

    Note: If the selected worksheet does not have its DisplayOptionsBase.visibility set to Visible when the workbook is saved, another worksheet will be selected.

    The selected worksheet of the workbook.

    Throws

    ArgumentNullException The assigned value is null and this is an instance of WorkbookWindowOptions whose associated workbook has at least one Worksheet.

    Throws

    ArgumentException The assigned value does not belong to the workbook associated with this instance of WindowOptions.

    Returns Worksheet

  • set selectedWorksheet(a: Worksheet): void
  • Parameters

    Returns void

  • get tabBarVisible(): boolean
  • Gets or sets the value indicating whether the worksheet tab bar is visible.

    If the value is False, the tabBarWidth will not be used, but it will still be serialized with the workbook.

    The value indicating whether the worksheet tab bar is visible.

    See

    Returns boolean

  • set tabBarVisible(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

  • get tabBarWidth(): number
  • Gets or sets the width of the worksheet tab bar, expressed in 1/1000ths of the application width.

    This value is only used if tabBarVisible is True. Regardless of whether the tab bar is visible, the width value is always saved with the workbook.

    A value of 1000 indicates the worksheet tab bar occupies the entire width of the application, while a value of 0 indicates the worksheet tab bar has no width.

    All space not occupied by the worksheet tab bar will be used by the horizontal scroll bar, if it is visible.

    The width of the worksheet tab bar, expressed in 1/1000ths of the application width.

    Throws

    ArgumentOutOfRangeException The value assigned is outside the valid range of 0 and 1000.

    See

    Returns number

  • set tabBarWidth(a: number): void
  • Parameters

    • a: number

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Resets the window options to their default settings.

    The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank workbook.

    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