Class WorkSheet

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

Methods

activate addChartObject clearCell clearCol clearColOutline clearRow clearRowOutline copyCell copyCol copyRow deleteCell deleteChartObject deleteCol deleteRow getActiveCell getAutoFilter getCells getChartObject getCol getComments getFormatConditions getHPageBreaks getHyperLinks getListObjects getName getPageSetupObject getPivotTables getRange getRow getShapes getSort getVPageBreaks getWindow insertCell insertCol insertRow isActive setActiveCell setColOutline setFormulaArray setName setPageSetupObject setRowOutline setValueArray

Methods

activate

  • activate(isActive): void

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

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

    Parameters

    • isActive: boolean

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

    Returns void

addChartObject

  • addChartObject(chartName, left, top, width, height): ChartObject

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

    Parameters

    • chartName: string

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

    • left: number

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

    • top: number

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

    • width: number

      幅(単位:ポイント数)

    • height: number

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

    Returns ChartObject

    追加したチャートのチャート図形クラス

clearCell

  • clearCell(A1C1): void

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

    Parameters

    • A1C1: string

      クリアセル範囲(A1C1)

    Returns void

clearCol

  • clearCol(startColNumber, numOfCols): void

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

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

    Parameters

    • startColNumber: number

      位置(列)

    • numOfCols: number

      列数

    Returns void

    See

    App#convertToColumnNumber

clearColOutline

  • clearColOutline(outlineLevel): void

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

    Parameters

    • outlineLevel: number

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

    Returns void

clearRow

  • clearRow(startRowNumber, numOfRows): void

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

    Parameters

    • startRowNumber: number

      位置(行)

    • numOfRows: number

      行数

    Returns void

clearRowOutline

  • clearRowOutline(outlineLevel): void

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

    Parameters

    • outlineLevel: number

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

    Returns void

copyCell

  • copyCell(copyFromSheetName, fromA1C1, copyToA1, copyType?): void

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

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

    Parameters

    • copyFromSheetName: string

      コピー元シート名

    • fromA1C1: string

      コピーセル範囲(A1C1)

    • copyToA1: string

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

    • copyType: XlCopyContentType = enums.XlCopyContentType.CopyContentTypeAll

      コピー対象

    Returns void

copyCol

  • copyCol(copyFromSheetName, copyFromColNumber, numOfCols, copyToColNumber, copyType?): void

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

    1. osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。
    2. copyFromColNumberは、A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

    Parameters

    • copyFromSheetName: string

      コピー元シート名

    • copyFromColNumber: number

      コピー元開始列

    • numOfCols: number

      コピー列数

    • copyToColNumber: number

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

    • copyType: XlCopyContentType = enums.XlCopyContentType.CopyContentTypeAll

      コピー対象

    Returns void

    See

    App#convertToColumnNumber

copyRow

  • copyRow(copyFromSheetName, copyFromRowNumber, numOfRows, copyToRowNumber, copyType?): void

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

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

    Parameters

    • copyFromSheetName: string

      コピー元シート名

    • copyFromRowNumber: number

      コピー元開始行

    • numOfRows: number

      コピー行数

    • copyToRowNumber: number

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

    • copyType: XlCopyContentType = enums.XlCopyContentType.CopyContentTypeAll

      コピー対象

    Returns void

deleteCell

  • deleteCell(A1C1, direction): void

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

    Parameters

    • A1C1: string

      削除セル範囲(A1C1)

    • direction: XlInsertDirection

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

    Returns void

deleteChartObject

  • deleteChartObject(param): void

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

    Parameters

    • param: string | number

      チャート名またはオブジェクトインデックス。オブジェクトインデックスは、1から始まります。

    Returns void

deleteCol

  • deleteCol(startColNumber, numOfCols): void

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

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

    Parameters

    • startColNumber: number

      削除位置(列)

    • numOfCols: number

      削除列数

    Returns void

    See

    App#convertToColumnNumber

deleteRow

  • deleteRow(startRowNumber, numOfRows): void

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

    Parameters

    • startRowNumber: number

      削除位置(行)

    • numOfRows: number

      削除行数

    Returns void

getActiveCell

  • getActiveCell(): string

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

    Returns string

    セル範囲(A1C1)

getAutoFilter

  • getAutoFilter(A1C1, firstRowAsHeader?): AutoFilter

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

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

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    • firstRowAsHeader: boolean = true

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

    Returns AutoFilter

    オートフィルタークラス

getCells

  • getCells(startRow, startCol, endRow?, endCol?): Range

  • セル範囲クラスを取得します。endRow,endColを指定した場合は、長方形の範囲となります。

    1. A1:B2=(startRow=1,startCol=1,endRow=2,endCol=2)です。

    Parameters

    • startRow: number

      先頭行 1から始まります。

    • startCol: number

      先頭列 1から始まります。

    • Optional endRow: number

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

    • Optional endCol: number

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

    Returns Range

    セル範囲クラス

getChartObject

  • getChartObject(param): ChartObject

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

    Parameters

    • param: string | number

      チャート名またはオブジェクトインデックス。オブジェクトインデックスは、1から始まります。

    Returns ChartObject

    チャート図形クラス

getCol

  • getCol(colNum): Col

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

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

    Parameters

    • colNum: number

      列番号

    Returns Col

    列クラス

    See

    App#convertToColumnNumber

getComments

  • getComments(): Comments

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

    Returns Comments

    コメント/メモクラス

getFormatConditions

getHPageBreaks

  • getHPageBreaks(): HPageBreaks

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

    Returns HPageBreaks

    水平方向改行クラス

getHyperLinks

  • getHyperLinks(): HyperLinks

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

    Returns HyperLinks

    ハイパーリンククラス

getListObjects

  • getListObjects(): ListObjects

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

    Returns ListObjects

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

getName

  • getName(): string

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

    Returns string

    シート名称

getPageSetupObject

  • getPageSetupObject(): PageSetupObject

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

    Returns PageSetupObject

    印刷情報クラス

getPivotTables

  • getPivotTables(): PivotTables

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

    Returns PivotTables

    PivotTable取得/生成クラス

getRange

  • getRange(A1C1): Range

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

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns Range

    セル範囲クラス

getRow

  • getRow(rowNum): Row

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

    Parameters

    • rowNum: number

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

    Returns Row

    行クラス

getShapes

  • getShapes(): Shapes

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

    Returns Shapes

    図形クラス

getSort

  • getSort(A1C1, firstRowAsHeader?): Sort

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

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    • firstRowAsHeader: boolean = false

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

    Returns Sort

    並び替えクラス

getVPageBreaks

  • getVPageBreaks(): VPageBreaks

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

    Returns VPageBreaks

    垂直方向改行クラス

getWindow

  • getWindow(): Window

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

    Returns Window

    外観情報クラス

insertCell

  • insertCell(A1C1, direction): void

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

    Parameters

    • A1C1: string

      挿入セル範囲(A1C1)

    • direction: XlInsertDirection

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

    Returns void

insertCol

  • insertCol(startColNumber, numOfCols): void

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

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

    Parameters

    • startColNumber: number

      挿入位置(列)

    • numOfCols: number

      挿入列数

    Returns void

    See

    App#convertToColumnNumber

insertRow

  • insertRow(startRowNumber, numOfRows): void

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

    Parameters

    • startRowNumber: number

      挿入位置(行)

    • numOfRows: number

      挿入行数

    Returns void

isActive

  • isActive(): boolean

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

    Returns boolean

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

setActiveCell

  • setActiveCell(A1C1): void

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

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns void

setColOutline

  • setColOutline(startCol, endCol, outlineLevel): void

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

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

    Parameters

    • startCol: number

      開始列

    • endCol: number

      終了列

    • outlineLevel: number

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

    Returns void

    See

    App#convertToColumnNumber

setFormulaArray

  • setFormulaArray(formulas): void

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

    Parameters

    Returns void

setName

  • setName(name): void

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

    Parameters

    • name: string

      シート名称

    Returns void

setPageSetupObject

  • setPageSetupObject(pageSetupObject): void

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

    Parameters

    Returns void

setRowOutline

  • setRowOutline(startRow, endRow, outlineLevel): void

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

    Parameters

    • startRow: number

      開始行

    • endRow: number

      終了行

    • outlineLevel: number

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

    Returns void

setValueArray

  • setValueArray(values): void

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

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

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