Class: RubyOSBXL::Window

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyosbxl.rb

Overview

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

Instance Method Summary collapse

Instance Method Details

#clearFreezePanes ⇒ void

領域の固定を解除します。

#clearSplit ⇒ void

領域の分割を解除します。

#getDisplayFormulas ⇒ bool

数式の表示有無を取得します。

Returns:

  • (bool) —

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

#getDisplayGridlines ⇒ bool

グリッドラインの表示有無を取得します。

Returns:

  • (bool) —

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

#getDisplayHeadings ⇒ bool

行見出しと列見出だしの表示有無を取得します。

Returns:

  • (bool) —

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

#getDisplayHorizontalScrollBar ⇒ bool

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

Returns:

  • (bool) —

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

#getDisplayOutline ⇒ bool

アウトラインの表示有無を取得します。

Returns:

  • (bool) —

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

#getDisplayRuler ⇒ bool

ルーラーの表示有無を取得します。

Returns:

  • (bool) —

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

#getDisplayVerticalScrollBar ⇒ bool

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

Returns:

  • (bool) —

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

#getDisplayWhitespace ⇒ bool

空白の表示有無を取得します。

Returns:

  • (bool) —

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

#getDisplayWorkbookTabs ⇒ bool

タブの表示有無を取得します。

Returns:

  • (bool) —

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

#getDisplayZeros ⇒ bool

零の表示有無を取得します。

Returns:

  • (bool) —

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

#getFreezePanes ⇒ bool

領域が固定されているか取得します。

Returns:

  • (bool) —

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

#getGridlineColor ⇒ RubyOSBXL::Dto::ColorObject

グリッドライン色を取得します。

Returns:

#getSplit ⇒ bool

領域が分割されているか取得します。

Returns:

  • (bool) —

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

#getSplitColumn ⇒ Integer

Note:

A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

列が、何列目で分割されているか取得します。

Returns:

  • (Integer) —

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

See Also:

#getSplitHorizontal ⇒ Integer

Note:

osbxlでは、中途半端なセルの末端で分割をいれるため、setSplitHorizontalで設定した値と異なる値が返されます。

水平方向の分割位置の取得を行います。

Returns:

  • (Integer) —

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

#getSplitRow ⇒ Integer

行が、何行目で分割されているか取得します。

Returns:

  • (Integer) —

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

#getSplitVertical ⇒ Integer

垂直方向の分割位置の取得を行います。

Returns:

  • (Integer) —

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

#getType ⇒ RubyOSBXL::Enums::XlWindowView

画面の表示タイプを取得します。

Returns:

#getZoom ⇒ Integer

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

Returns:

  • (Integer) —

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

#setDisplayFormulas(isDisplayFormula) ⇒ void

数式の表示有無の設定をします。

Parameters:

  • isDisplayFormula (bool) —

    true: 表示する false: 表示しない

#setDisplayGridlines(isDisplayGridLines) ⇒ void

グリッド線の表示有無の設定を設定します。

Parameters:

  • isDisplayGridLines (bool) —

    true: グリッド線を表示する false: グリッド線を表示しない

#setDisplayHeadings(isDisplayHeading) ⇒ void

行見出しと列見出だしの表示有無の設定をします。

Parameters:

  • isDisplayHeading (bool) —

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

#setDisplayHorizontalScrollBar(isDisplayHorizontalScrollBar) ⇒ void

水平スクロールバーの表示有無の設定をします。

Parameters:

  • isDisplayHorizontalScrollBar (bool) —

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

#setDisplayOutline(isDisplayOutline) ⇒ void

アウトラインの表示有無の設定をします。

Parameters:

  • isDisplayOutline (bool) —

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

#setDisplayRuler(isDisplayRuler) ⇒ void

ルーラーの表示有無の設定をします。

Parameters:

  • isDisplayRuler (bool) —

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

#setDisplayVerticalScrollBar(isDisplayVerticalScrollBar) ⇒ void

垂直スクロールバーの表示有無の設定をします。

Parameters:

  • isDisplayVerticalScrollBar (bool) —

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

#setDisplayWhitespace(isDisplayWhitespace) ⇒ void

空文字の表示有無の設定をします。

Parameters:

  • isDisplayWhitespace (bool) —

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

#setDisplayWorkbookTabs(isDisplayWorkbookTabs) ⇒ void

タブの表示有無の設定をします。

Parameters:

  • isDisplayWorkbookTabs (bool) —

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

#setDisplayZeros(isDisplayZeros) ⇒ void

零の表示有無の設定をします。

Parameters:

  • isDisplayZeros (bool) —

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

#setFreezePanes ⇒ void

Note:

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

領域を固定します。

#setGridlineColor(colorObject) ⇒ void

Note:

色の設定は、XlIndexColorのみサポートされます。他のタイプは設定できません。

グリッドライン色を設定します。

Parameters:

#setSplitColumn(colNumber) ⇒ void

何列目で、水平方向を分割するか設定します。

Parameters:

  • colNumber (Integer) —

    分割位置 先頭は1から始まります。

#setSplitHorizontal(splitHorizontalSize) ⇒ void

Note:

osbxlでは、中途半端なセルの末端で分割をいれるため、setSplitHorizontalで設定した値と異なる値が返されます。

水平方向の分割位置の設定を行います。

Parameters:

  • splitHorizontalSize (Integer) —

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

#setSplitRow(rowNum) ⇒ void

何行目で、垂直方向を分割するか設定します。

Parameters:

  • rowNum (Integer) —

    分割位置 先頭は1から始まります。

#setSplitVertical(splitVerticalSize) ⇒ void

垂直方向の分割位置の設定を行います。

Parameters:

  • splitVerticalSize (Integer) —

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

#setType(windowType) ⇒ void

画面の表示タイプを設定します。

Parameters:

#setZoom(zoom) ⇒ void

ズームの設定(パーセント)を行います。

Parameters:

  • zoom (Integer) —

    100は等倍となります。0は自動を意味します。