Class: RubyOSBXL::WorkSheet

Inherits:

Object

• Object
• RubyOSBXL::WorkSheet

Defined in:

lib/rubyosbxl.rb

Overview

ExcelのWorkSheetを取り扱うクラスです。

Instance Method Summary

• #activate(isActive) ⇒ void

  ワークシートのタブのアクティブ/非アクティブ(起動時の表示項目か否か)を設定します。.

• #addChartObject(chartName, left, ptop, width, height) ⇒ RubyOSBXL::Charts::ChartObject

  チャート図形クラスを追加し、そのインスタンスを取得します。.

• #clearCell(a1c1) ⇒ void

  ワークシート上のセルをワークシート初期値に戻します。.

• #clearCol(startColNumber, numOfCols) ⇒ void

  ワークシート上の列をワークシート初期値に戻します。.

• #clearColOutline(outlineLevel) ⇒ void

  列方向のアウトラインのクリアを行います。.

• #clearRow(startRowNumber, numOfRows) ⇒ void

  ワークシート上の行をワークシート初期値に戻します。.

• #clearRowOutline(outlineLevel) ⇒ void

  行方向のアウトラインのクリアを行います。.

• #copyCell(copyFromSheetName, fromA1C1, copyToA1, copyType = RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) ⇒ void

  セル範囲の上書きコピーを行います。.

• #copyCol(copyFromSheetName, copyFromColNumber, numOfCols, copyToColNumber, copyType = RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) ⇒ void

  列のコピーを行います。.

• #copyRow(copyFromSheetName, copyFromRowNumber, numOfRows, copyToRowNumber, copyType = RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) ⇒ void

  行の上書きコピーを行います。.

• #deleteCell(a1c1, direction) ⇒ void

  ワークシート上のセル範囲の削除を行います。.

• #deleteChartObject(*args) ⇒ Object
• #deleteCol(startColNumber, numOfCols) ⇒ void

  ワークシート上の列の削除を行います。.

• #deleteRow(startRowNumber, numOfRows) ⇒ void

  ワークシート上の行の削除を行います。.

• #getActiveCell ⇒ String

  ワークシートのアクティブな(選択されている)セル範囲の取得を行います。.

• #getAutoFilter(a1c1, firstRowAsHeader = true) ⇒ RubyOSBXL::AutoFilter

  オートフィルタークラスを取得します。.

• #getCells(startRow, startCol, endRow, endCol) ⇒ Object
• #getChartObject(*args) ⇒ Object
• #getCol(colNum) ⇒ RubyOSBXL::Col

  列クラスを取得します。.

• #getComments ⇒ RubyOSBXL::Comments

  コメント/メモクラスを取得します。.

• #getFormatConditions ⇒ RubyOSBXL::FormatConditions

  条件付き書式クラスのの取得.

• #getHPageBreaks ⇒ RubyOSBXL::HPageBreaks

  水平方向改行クラスを取得します。.

• #getHyperLinks ⇒ RubyOSBXL::HyperLinks

  ハイパーリンククラスを取得します。.

• #getListObjects ⇒ RubyOSBXL::ListObjects

  テーブル取得/生成クラスを取得します。.

• #getName ⇒ String

  シート名称の取得を行います。.

• #getPageSetupObject ⇒ RubyOSBXL::Dto::PageSetupObject

  ワークシートの印刷情報(ページマージン等の情報)を取得します。.

• #getPivotTables ⇒ RubyOSBXL::PivotTables

  PivotTable取得/生成クラスを取得します。.

• #getRange(a1c1) ⇒ RubyOSBXL::Range

  セル範囲クラスを取得します。.

• #getRow(rowNum) ⇒ RubyOSBXL::Row

  行クラスを取得します。.

• #getShapes ⇒ RubyOSBXL::Shapes

  図形クラスを取得します。.

• #getSort(a1c1, firstRowAsHeader = false) ⇒ RubyOSBXL::Sort

  並び替えクラスを取得します。.

• #getVPageBreaks ⇒ RubyOSBXL::VPageBreaks

  垂直方向改行クラスを取得します。.

• #getWindow ⇒ RubyOSBXL::Window

  外観情報クラスを取得します。.

• #insertCell(a1c1, direction) ⇒ void

  ワークシート上のセル範囲の挿入を行います。.

• #insertCol(startColNumber, numOfCols) ⇒ void

  ワークシート上の列の挿入を行います。.

• #insertRow(startRowNumber, numOfRows) ⇒ void

  ワークシート上の行の挿入を行います。.

• #isActive ⇒ bool

  ワークシートがアクティブかどうか(現在のワークシートのタブが起動時の表示項目か)を取得します。.

• #setActiveCell(a1c1) ⇒ void

  ワークシートのアクティブな(選択する)セル範囲の設定を行います。.

• #setColOutline(startCol, endCol, outlineLevel) ⇒ void

  列方向のアウトラインを設定します。.

• #setFormulaArray(formulas) ⇒ void

  関数の一括入力を行います。.

• #setName(name) ⇒ void

  シート名称の設定を行います。.

• #setPageSetupObject(pageSetupObject) ⇒ void

  ワークシートの印刷情報(ページマージン等の情報)を設定します。.

• #setRowOutline(startRow, endRow, outlineLevel) ⇒ void

  行方向のアウトラインを設定します。.

• #setValueArray(values) ⇒ void

  セル値の一括入力を行います。.

Instance Method Details

#activate(isActive) ⇒ void

Note:

アクティブのタブを一つにするには、現在アクティブなタブを非アクティブにして、現在のシートをアクティブに設定します。

ワークシートのタブのアクティブ/非アクティブ(起動時の表示項目か否か)を設定します。

Parameters:

• isActive (bool) —

  true: アクティブ false: 非アクティブ

#addChartObject(chartName, left, ptop, width, height) ⇒ RubyOSBXL::Charts::ChartObject

チャート図形クラスを追加し、そのインスタンスを取得します。

Parameters:

• chartName (String) —

  チャート名。空文字で設定すると、チャート名は、自動生成されます。

• left (Numeric) —

  左端(単位: ポイント数)

• ptop (Numeric) —

  上端(単位: ポイント数)

• width (Numeric) —

  幅(単位: ポイント数)

• height (Numeric) —

  高さ(単位: ポイント数)

Returns:

• (RubyOSBXL::Charts::ChartObject) —

  チャート図形クラス

#clearCell(a1c1) ⇒ void

ワークシート上のセルをワークシート初期値に戻します。

Parameters:

• a1c1 (String) —

  クリアセル範囲

#clearCol(startColNumber, numOfCols) ⇒ void

Note:

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

ワークシート上の列をワークシート初期値に戻します。

Parameters:

• startColNumber (Integer) —

  位置(列)

• numOfCols (Integer) —

  列数

See Also:

• App#convertToColumnNumber

#clearColOutline(outlineLevel) ⇒ void

列方向のアウトラインのクリアを行います。

Parameters:

• outlineLevel (Integer) —

  アウトラインレベル(閾値: 1～7) 。1は初期状態となります。

#clearRow(startRowNumber, numOfRows) ⇒ void

ワークシート上の行をワークシート初期値に戻します。

Parameters:

• startRowNumber (Integer) —

  位置(行)

• numOfRows (Integer) —

  行数

#clearRowOutline(outlineLevel) ⇒ void

行方向のアウトラインのクリアを行います。

Parameters:

• outlineLevel (Integer) —

  アウトラインレベル(閾値: 1～7) 。1は初期状態となります。

#copyCell(copyFromSheetName, fromA1C1, copyToA1, copyType = RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) ⇒ void

Note:

osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

セル範囲の上書きコピーを行います。

Parameters:

• copyFromSheetName (String) —

  コピー元シート名

• fromA1C1 (String) —

  コピーセル範囲

• copyToA1 (String) —

  現在ワークシートの適用範囲の先頭セル(左上のセル)

• copyType (RubyOSBXL::Enums::XlCopyContentType) (defaults to: RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) —

  コピー対象

#copyCol(copyFromSheetName, copyFromColNumber, numOfCols, copyToColNumber, copyType = RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) ⇒ void

Note:

osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

Note:

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

列のコピーを行います。

Parameters:

• copyFromSheetName (String) —

  コピー元シート名

• copyFromColNumber (Integer) —

  コピー元開始列

• numOfCols (Integer) —

  コピー列数

• copyToColNumber (Integer) —

  現在ワークシートの適用列

• copyType (RubyOSBXL::Enums::XlCopyContentType) (defaults to: RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) —

  コピー対象

See Also:

• App#convertToColumnNumber

#copyRow(copyFromSheetName, copyFromRowNumber, numOfRows, copyToRowNumber, copyType = RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) ⇒ void

Note:

osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

行の上書きコピーを行います。

Parameters:

• copyFromSheetName (String) —

  コピー元シート名

• copyFromRowNumber (Integer) —

  コピー元開始行

• numOfRows (Integer) —

  コピー行数

• copyToRowNumber (Integer) —

  現在ワークシートの適用行

• copyType (RubyOSBXL::Enums::XlCopyContentType) (defaults to: RubyOSBXL::Enums::XlCopyContentType::CopyContentTypeAll) —

  コピー対象

#deleteCell(a1c1, direction) ⇒ void

ワークシート上のセル範囲の削除を行います。

Parameters:

• a1c1 (String) —

  削除セル範囲

• direction (RubyOSBXL::Enums::XlInsertDirection) —

  削除方向(左 or 上) その他の挿入方向(右 or 下)を設定すると、例外が投げられます。

#deleteChartObject(param1) ⇒ void #deleteChartObject(param1) ⇒ void

Overloads:

• #deleteChartObject(param1) ⇒ void

  チャート図形クラスを削除します。

  Parameters:

  • param1 (Integer) —

    オブジェクトインデックス 1から始まります。

• #deleteChartObject(param1) ⇒ void

  チャート図形クラスを削除します。

  Parameters:

  • param1 (String) —

    チャート名

#deleteCol(startColNumber, numOfCols) ⇒ void

Note:

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

ワークシート上の列の削除を行います。

Parameters:

• startColNumber (Integer) —

  削除位置(列)

• numOfCols (Integer) —

  削除列数

See Also:

• App#convertToColumnNumber

#deleteRow(startRowNumber, numOfRows) ⇒ void

ワークシート上の行の削除を行います。

Parameters:

• startRowNumber (Integer) —

  削除位置(行)

• numOfRows (Integer) —

  削除行数

#getActiveCell ⇒ String

ワークシートのアクティブな(選択されている)セル範囲の取得を行います。

Returns:

• (String) —

  セル範囲

#getAutoFilter(a1c1, firstRowAsHeader = true) ⇒ RubyOSBXL::AutoFilter

Note:

オートフィルターは、シート単位で、１セル範囲となります。

オートフィルタークラスを取得します。

Parameters:

• a1c1 (String) —

  セル範囲

• firstRowAsHeader (bool) (defaults to: true) —

  true: 先頭行をヘッダとみなす false: ヘッダとみなさない

Returns:

• (RubyOSBXL::AutoFilter) —

  オートフィルタークラス

#getCells(startRow, startCol) ⇒ RubyOSBXL::Range #getCells(startRow, startCol, endRow, endCol) ⇒ RubyOSBXL::Range

Overloads:

• #getCells(startRow, startCol) ⇒ RubyOSBXL::Range
  Note:

  A1=(row=1, col=1)です。

  セル範囲クラスを取得します。

  Parameters:

  • startRow (Integer) —

    行番号 1から始まります。

  • startCol (Integer) —

    列番号 1から始まります。

  Returns:

  • (RubyOSBXL::Range) —

    セル範囲クラス

• #getCells(startRow, startCol, endRow, endCol) ⇒ RubyOSBXL::Range
  Note:

  A1=(row=1, col=1)です。

  セル範囲クラスを取得します。

  Parameters:

  • startRow (Integer) —

    行番号 1から始まります。

  • startCol (Integer) —

    列番号 1から始まります。

  • endRow (Integer) —

    末尾行 1から始まります。

  • endCol (Integer) —

    末尾列 1から始まります。

  Returns:

  • (RubyOSBXL::Range) —

    セル範囲クラス

#getChartObject(param1) ⇒ RubyOSBXL::Charts::ChartObject #getChartObject(param1) ⇒ RubyOSBXL::Charts::ChartObject

Overloads:

• #getChartObject(param1) ⇒ RubyOSBXL::Charts::ChartObject

  チャート図形クラスを取得します。

  Parameters:

  • param1 (Integer) —

    オブジェクトインデックス 1から始まります。

  Returns:

  • (RubyOSBXL::Charts::ChartObject) —

    チャート図形クラス

• #getChartObject(param1) ⇒ RubyOSBXL::Charts::ChartObject

  チャート図形クラスを取得します。

  Parameters:

  • param1 (String) —

    チャート名

  Returns:

  • (RubyOSBXL::Charts::ChartObject) —

    チャート図形クラス

#getCol(colNum) ⇒ RubyOSBXL::Col

Note:

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

列クラスを取得します。

Parameters:

• colNum (Integer) —

  列番号

Returns:

• (RubyOSBXL::Col) —

  列クラス

See Also:

• App#convertToColumnNumber

#getComments ⇒ RubyOSBXL::Comments

コメント/メモクラスを取得します。

Returns:

• (RubyOSBXL::Comments) —

  コメント/メモクラス

#getFormatConditions ⇒ RubyOSBXL::FormatConditions

条件付き書式クラスのの取得

Returns:

• (RubyOSBXL::FormatConditions) —

  条件付き書式クラス

#getHPageBreaks ⇒ RubyOSBXL::HPageBreaks

水平方向改行クラスを取得します。

Returns:

• (RubyOSBXL::HPageBreaks) —

  水平方向改行クラス

#getHyperLinks ⇒ RubyOSBXL::HyperLinks

ハイパーリンククラスを取得します。

Returns:

• (RubyOSBXL::HyperLinks) —

  ハイパーリンククラス

#getListObjects ⇒ RubyOSBXL::ListObjects

テーブル取得/生成クラスを取得します。

Returns:

• (RubyOSBXL::ListObjects) —

  テーブル取得/生成クラス

#getName ⇒ String

シート名称の取得を行います。

Returns:

• (String) —

  シート名称

#getPageSetupObject ⇒ RubyOSBXL::Dto::PageSetupObject

ワークシートの印刷情報(ページマージン等の情報)を取得します。

Returns:

• (RubyOSBXL::Dto::PageSetupObject) —

  印刷情報クラス

#getPivotTables ⇒ RubyOSBXL::PivotTables

PivotTable取得/生成クラスを取得します。

Returns:

• (RubyOSBXL::PivotTables) —

  PivotTable取得/生成クラス

#getRange(a1c1) ⇒ RubyOSBXL::Range

セル範囲クラスを取得します。

Parameters:

• a1c1 (String) —

  セル範囲

Returns:

• (RubyOSBXL::Range) —

  セル範囲クラス

#getRow(rowNum) ⇒ RubyOSBXL::Row

行クラスを取得します。

Parameters:

• rowNum (Integer) —

  行番号 1から始まります。

Returns:

• (RubyOSBXL::Row) —

  行クラス

#getShapes ⇒ RubyOSBXL::Shapes

図形クラスを取得します。

Returns:

• (RubyOSBXL::Shapes) —

  図形クラス

#getSort(a1c1, firstRowAsHeader = false) ⇒ RubyOSBXL::Sort

並び替えクラスを取得します。

Parameters:

• a1c1 (String) —

  セル範囲

• firstRowAsHeader (bool) (defaults to: false) —

  true: 先頭行をヘッダとみなす false: ヘッダとみなさない

Returns:

• (RubyOSBXL::Sort) —

  並び替えクラス

#getVPageBreaks ⇒ RubyOSBXL::VPageBreaks

垂直方向改行クラスを取得します。

Returns:

• (RubyOSBXL::VPageBreaks) —

  垂直方向改行クラス

#getWindow ⇒ RubyOSBXL::Window

外観情報クラスを取得します。

Returns:

• (RubyOSBXL::Window) —

  外観情報クラス

#insertCell(a1c1, direction) ⇒ void

ワークシート上のセル範囲の挿入を行います。

Parameters:

• a1c1 (String) —

  挿入セル範囲

• direction (RubyOSBXL::Enums::XlInsertDirection) —

  挿入方向(右 or 下) その他の挿入方向(左 or 上)を設定すると、例外が投げられます。

#insertCol(startColNumber, numOfCols) ⇒ void

Note:

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

ワークシート上の列の挿入を行います。

Parameters:

• startColNumber (Integer) —

  挿入位置(列)

• numOfCols (Integer) —

  挿入列数

See Also:

• App#convertToColumnNumber

#insertRow(startRowNumber, numOfRows) ⇒ void

ワークシート上の行の挿入を行います。

Parameters:

• startRowNumber (Integer) —

  挿入位置(行)

• numOfRows (Integer) —

  挿入行数

#isActive ⇒ bool

ワークシートがアクティブかどうか(現在のワークシートのタブが起動時の表示項目か)を取得します。

Returns:

• (bool) —

  true: アクティブ false: 非アクティブ

#setActiveCell(a1c1) ⇒ void

ワークシートのアクティブな(選択する)セル範囲の設定を行います。

Parameters:

• a1c1 (String) —

  セル範囲

#setColOutline(startCol, endCol, outlineLevel) ⇒ void

Note:

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

列方向のアウトラインを設定します。

Parameters:

• startCol (Integer) —

  開始列

• endCol (Integer) —

  終了列

• outlineLevel (Integer) —

  アウトラインレベル(閾値: 1～7) 。1は初期状態となります。

See Also:

• App#convertToColumnNumber

#setFormulaArray(formulas) ⇒ void

関数の一括入力を行います。

Parameters:

• formulas (Array<RubyOSBXL::Dto::InputFormulaObject>) —

  Array<入力する関数オブジェクト>

#setName(name) ⇒ void

シート名称の設定を行います。

Parameters:

• name (String) —

  シート名称

#setPageSetupObject(pageSetupObject) ⇒ void

ワークシートの印刷情報(ページマージン等の情報)を設定します。

Parameters:

• pageSetupObject (RubyOSBXL::Dto::PageSetupObject) —

  印刷情報クラス

#setRowOutline(startRow, endRow, outlineLevel) ⇒ void

行方向のアウトラインを設定します。

Parameters:

• startRow (Integer) —

  開始行

• endRow (Integer) —

  終了行

• outlineLevel (Integer) —

  アウトラインレベル(閾値: 1～7) 。1は初期状態となります。

#setValueArray(values) ⇒ void

セル値の一括入力を行います。

Parameters:

• values (Array<RubyOSBXL::Dto::InputValueObject>) —

  Array<入力するセル値オブジェクト>