Represents the window options which are saved with the workbook.

The properties explicitly defined on this class and not inherited from the base class, [[WindowOptions]], are options that can be saved with a workbook, but not with a custom view.

See

  • [[Workbook.windowOptions]]
  • [[CustomViewWindowOptions]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get boundsInTwips(): IgRect
  • Gets or sets the bounds of the workbook's MDI child window in twips (1/20th of a point).

    Note: This setting cannot be saved with a [[CustomView]] in the Excel file. It can only be saved with a [[Workbook]]. Therefore, there is no corresponding property in [[CustomViewWindowOptions]] and a newly created CustomView will not be initialized with the setting from this property.

    The bounds of the workbook's MDI child window in twips (1/20th of a point).

    Throws

    [[ArgumentException]] The width or height of the value assigned are less than zero.

    Returns IgRect

  • set boundsInTwips(a): void
  • Parameters

    • a: IgRect

    Returns void

  • get firstVisibleTabIndex(): number
  • Gets or sets the index of the first visible tab in the worksheet tab bar.

    If the worksheet tab bar is not visible, this value will not be used, but it is still saved with the workbook.

    Note: This setting cannot be saved with a [[CustomView]] in the Excel file. It can only be saved with a [[Workbook]]. Therefore, there is no corresponding property in [[CustomViewWindowOptions]] and a newly created CustomView will not be initialized with the setting from this property.

    The index of the first visible tab in the worksheet tab bar.

    Throws

    [[ArgumentOutOfRangeException]] The value assigned is less than zero.

    See

    • [[WindowOptions.tabBarVisible]]
    • [[WindowOptions.tabBarWidth]]

    Returns number

  • set firstVisibleTabIndex(a): void
  • Parameters

    • a: number

    Returns void

  • get minimized(): boolean
  • Gets or sets the value indicating whether the workbook's MDI child window is minimized in Microsoft Excel.

    Note: This setting cannot be saved with a [[CustomView]] in the Excel file. It can only be saved with a [[Workbook]]. Therefore, there is no corresponding property in [[CustomViewWindowOptions]] and a newly created CustomView will not be initialized with the setting from this property.

    The value indicating whether the workbook's MDI child window is minimized in Microsoft Excel.

    See

    [[CustomViewWindowOptions.maximized]]

    Returns boolean

  • set minimized(a): void
  • Parameters

    • a: boolean

    Returns void

  • get objectDisplayStyle(): ObjectDisplayStyle
  • Gets or sets the way the objects and shapes are displayed in the workbook. The way the objects and shapes are displayed in the workbook.

    Throws

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

    See

    • [[WorksheetShape]]
    • [[Worksheet.shapes]]

    Returns ObjectDisplayStyle

  • set objectDisplayStyle(a): void
  • Parameters

    Returns void

  • 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

    • [[tabBarWidth]]
    • [[tabBarVisible]]

    Returns ScrollBars

  • set scrollBars(a): 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): 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): 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

    • [[tabBarWidth]]
    • [[WorkbookWindowOptions.firstVisibleTabIndex]]

    Returns boolean

  • set tabBarVisible(a): 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

    • [[tabBarVisible]]
    • [[scrollBars]]
    • [[WorkbookWindowOptions.firstVisibleTabIndex]]

    Returns number

  • set tabBarWidth(a): void
  • Parameters

    • a: number

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Returns Base

  • 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