Class Window

ワークシートの外観(Window)を扱うクラスです。

Methods

clearFreezePanes

clearFreezePanes(): void
領域の固定を解除します。

Returns void

clearSplit

clearSplit(): void
領域の分割を解除します。

Returns void

getDisplayFormulas

getDisplayFormulas(): boolean
数式の表示有無を取得します。

Returns boolean
true: 数式を表示 false: 数式の表示をしない

getDisplayGridlines

getDisplayGridlines(): boolean
グリッドラインの表示有無を取得します。

Returns boolean
true: グリッドラインを表示する false: グリッドラインを表示しない

getDisplayHeadings

getDisplayHeadings(): boolean
行見出しと列見出だしの表示有無を取得します。

Returns boolean
true: 行見出しと列見出だしを表示する false: 行見出しと列見出だしを表示しない

getDisplayHorizontalScrollBar

getDisplayHorizontalScrollBar(): boolean
水平スクロールバーの表示有無を取得します。

Returns boolean
true: 水平スクロールバーを表示する false: 水平スクロールバーを表示しない

getDisplayOutline

getDisplayOutline(): boolean
アウトラインの表示有無を取得します。

Returns boolean
true: アウトラインを表示する false:アウトラインを表示しない

getDisplayRuler

getDisplayRuler(): boolean
ルーラーの表示有無を取得します。

Returns boolean
true: ルーラーを表示する false: ルーラーを表示しない

getDisplayVerticalScrollBar

getDisplayVerticalScrollBar(): boolean
垂直スクロールバーの表示有無を取得します。

Returns boolean
true: 垂直スクロールバーを表示する false: 垂直スクロールバーを表示しない

getDisplayWhitespace

getDisplayWhitespace(): boolean
空白の表示有無を取得します。

Returns boolean
true: 空文字を表示する false:空文字を表示しない

getDisplayWorkbookTabs

getDisplayWorkbookTabs(): boolean
タブの表示有無を取得します。

Returns boolean
true: タブを表示する false:タブを表示しない

getDisplayZeros

getDisplayZeros(): boolean
零の表示有無を取得します。

Returns boolean
true:零を表示します。 false:零を表示しない

getFreezePanes

getFreezePanes(): boolean
領域が固定されているかどうかを取得します。

Returns boolean
true: 領域が固定されている false:領域が固定されていない

getGridlineColor

getGridlineColor(): ColorObject
グリッドライン色を取得します。

Returns ColorObject
グリッドライン色オブジェクト

getSplit

getSplit(): boolean
領域が分割されているかどうかを取得します。

Returns boolean
true:分割されている false: 分割されていない

getSplitColumn

getSplitColumn(): number
列が、何列目で分割されているかどうかを取得します。
1. A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。
Returns number
何列目で分割されているか(先頭は1から始まります。)

See
App#convertToColumnNumber

getSplitHorizontal

getSplitHorizontal(): number
水平方向の分割位置の取得を行います。
1. osbxlでは、中途半端なセルの末端で分割をいれるため、`setSplitHorizontal`で設定した値と異なる値が返されます。
Returns number
領域が分割された画面の左上からの水平方向の距離(ポイント単位)

getSplitRow

getSplitRow(): number
行が、何行目で分割されているかどうかを取得します。

Returns number
何行目で分割されているか(先頭は1から始まります。)

getSplitVertical

getSplitVertical(): number
垂直方向の分割位置の取得を行います。

Returns number
領域が分割された画面の左上からの垂直方向の距離(ポイント単位)

getType

getType(): XlWindowView
画面の表示タイプを取得します。

Returns XlWindowView
画面の表示タイプ

getZoom

getZoom(): number
ズームの取得(パーセント)を行います。

Returns number
ズーム(パーセント) 100は等倍となります。0は自動を意味します。

setDisplayFormulas

setDisplayFormulas(isDisplayFormula): void
数式の表示有無の設定をします。
Parameters
- isDisplayFormula: boolean
  true: 表示する false:表示しない
Returns void

setDisplayGridlines

setDisplayGridlines(isDisplayGridLines): void
グリッド線の表示有無の設定を設定します。
Parameters
- isDisplayGridLines: boolean
  true: グリッド線を表示する false: グリッド線を表示しない
Returns void

setDisplayHeadings

setDisplayHeadings(isDisplayHeading): void
行見出しと列見出だしの表示有無の設定をします。
Parameters
- isDisplayHeading: boolean
  boolean true: 行見出しと列見出だしを表示する false: 行見出しと列見出だしを表示しない
Returns void

setDisplayHorizontalScrollBar

setDisplayHorizontalScrollBar(isDisplayHorizontalScrollBar): void
水平スクロールバーの表示有無の設定をします。
Parameters
- isDisplayHorizontalScrollBar: boolean
  true: 水平スクロールバーを表示する false: 水平スクロールバーを表示しない
Returns void

setDisplayOutline

setDisplayOutline(isDisplayOutline): void
アウトラインの表示有無の設定をします。
Parameters
- isDisplayOutline: boolean
  true: アウトラインを表示する false:アウトラインを表示しない
Returns void

setDisplayRuler

setDisplayRuler(isDisplayRuler): void
ルーラーの表示有無の設定をします。
Parameters
- isDisplayRuler: boolean
  true: ルーラーを表示する false: ルーラーを表示しない
Returns void

setDisplayVerticalScrollBar

setDisplayVerticalScrollBar(isDisplayVerticalScrollBar): void
垂直スクロールバーの表示有無の設定をします。
Parameters
- isDisplayVerticalScrollBar: boolean
  boolean true: 垂直スクロールバーを表示する false: 垂直スクロールバーを表示しない
Returns void

setDisplayWhitespace

setDisplayWhitespace(isDisplayWhitespace): void
空文字の表示有無の設定をします。
Parameters
- isDisplayWhitespace: boolean
  true: 空文字を表示する false:空文字を表示しない
Returns void

setDisplayWorkbookTabs

setDisplayWorkbookTabs(isDisplayWorkbookTabs): void
タブの表示有無の設定をします。
Parameters
- isDisplayWorkbookTabs: boolean
  true: タブを表示する false:タブを表示しない
Returns void

setDisplayZeros

setDisplayZeros(isDisplayZeros): void
零の表示有無の設定をします。
Parameters
- isDisplayZeros: boolean
  true:零を表示します。 false:零を表示しない
Returns void

setFreezePanes

setFreezePanes(): void
領域を固定します。
1. 領域を固定する場合、あらかじめ、`setSplitColumn`メソッドや`setSplitHorizontal`メソッド、`setSplitRow`メソッドや`setSplitVertical`メソッドで、予め領域を設定しておく必要があります。
Returns void

setGridlineColor

setGridlineColor(colorObject): void
グリッドライン色を設定します。
1. 色の設定は、XlIndexColorのみサポートされます。他のタイプは設定できません。
Parameters
- colorObject: ColorObject
  グリッドライン色オブジェクト
Returns void

setSplitColumn

setSplitColumn(colNumber): void
何列目で、水平方向を分割するかどうかを設定します。
Parameters
- colNumber: number
  分割位置先頭は1から始まります。
Returns void

setSplitHorizontal

setSplitHorizontal(splitHorizontalSize): void
水平方向の分割位置の設定を行います。
1. osbxlでは、中途半端なセルの末端で分割をいれるため、`setSplitHorizontal`で設定した値と異なる値が返されます。
Parameters
- splitHorizontalSize: number
  領域が分割された画面の左上からの水平方向の距離(ポイント単位)
Returns void

setSplitRow

setSplitRow(rowNum): void
何行目で、垂直方向を分割するかどうかを設定します。
Parameters
- rowNum: number
  分割位置先頭は1から始まります。
Returns void

setSplitVertical

setSplitVertical(splitVerticalSize): void
垂直方向の分割位置の設定を行います。
Parameters
- splitVerticalSize: number
  領域が分割された画面の左上からの垂直方向の距離(ポイント単位)
Returns void

setType

setType(windowType): void
画面の表示タイプを設定します。
Parameters
- windowType: XlWindowView
  画面の表示タイプ
Returns void

setZoom

setZoom(zoom): void
ズームの設定(パーセント)を行います。
Parameters
- zoom: number
  100は等倍となります。0は自動を意味します。
Returns void

Copyright © 2023. OSB-OFFICE.Inc, All rights reserved. Generated using TypeDoc