Class Table

テーブルを扱うクラスです。

Methods

changeTableName getAllRange getAutoFilter getColumnName getDataBodyRange getHeaderRowRange getName getTableStyleName getTotalRowFunction getTotalRowLabel getTotalRowRange isShowAutoFilter isShowHeaders isShowTableStyleColumnStripes isShowTableStyleFirstColumn isShowTableStyleLastColumn isShowTableStyleRowStripes isShowTotals removeAutoFilter setBuiltinStyleName setColumnName setCustomRowFunction setCustomTableStyleName setShowAutoFilter setShowHeaders setShowTableStyleColumnStripes setShowTableStyleFirstColumn setShowTableStyleLastColumn setShowTableStyleRowStripes setShowTotals setTotalRowFunction setTotalRowLabel

Methods

changeTableName

  • changeTableName(tableName): void

  • テーブル名の変更を行います。

    Parameters

    • tableName: string

      テーブル名

    Returns void

getAllRange

  • getAllRange(): Range

  • テーブルの全範囲をセル範囲クラスで取得します。

    Returns Range

    セル範囲クラス

getAutoFilter

  • getAutoFilter(): AutoFilter

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

    Returns AutoFilter

    オートフィルタークラス

getColumnName

  • getColumnName(): string[]

  • 列名の一括取得を行います。

    Returns string[]

    Array<列名>

getDataBodyRange

  • getDataBodyRange(): Range

  • テーブルのデータ部をセル範囲クラスで取得します。

    Returns Range

    セル範囲クラス

getHeaderRowRange

  • getHeaderRowRange(): Range

  • テーブルのヘッダをセル範囲クラスで取得します。

    Returns Range

    セル範囲クラス

getName

  • getName(): string

  • テーブル名の取得を行います。

    Returns string

    テーブル名

getTableStyleName

  • getTableStyleName(): string

  • テーブルスタイル名の取得を行います。

    Returns string

    テーブルスタイル名

getTotalRowFunction

  • getTotalRowFunction(colNum): XlTotalsCalculation

  • 集計行の計算方法の取得を行います。

    Parameters

    • colNum: number

      列番号(先頭=1)

    Returns XlTotalsCalculation

    集計行の計算方法

getTotalRowLabel

  • getTotalRowLabel(colNum): string

  • 集計行のラベル名の取得を行います。

    Parameters

    • colNum: number

      列番号(先頭=1)

    Returns string

    集計行のラベル名の取得

getTotalRowRange

  • getTotalRowRange(): Range

  • テーブルの集計行をセル範囲クラスで取得します。

    Returns Range

    セル範囲クラス

isShowAutoFilter

  • isShowAutoFilter(): boolean

  • オートフィルターの表示有無の取得を行います。

    Returns boolean

    true: オートフィルターのテーブルスタイルが適用されている false: オートフィルターのテーブルスタイルが適用されていない

isShowHeaders

  • isShowHeaders(): boolean

  • ヘッダの表示有無の取得を行います。

    Returns boolean

    true:ヘッダが表示されている false:ヘッダが表示されていない

isShowTableStyleColumnStripes

  • isShowTableStyleColumnStripes(): boolean

  • テーブルスタイルの適用有無の取得（１行おき：列）を行います。

    Returns boolean

    true: （１行おき：列）のテーブルスタイルが適用されている false: （１行おき：列）のテーブルスタイルが適用されていない

isShowTableStyleFirstColumn

  • isShowTableStyleFirstColumn(): boolean

  • テーブルスタイルの適用有無の取得（最初列）を行います。

    Returns boolean

    true: 最初列のテーブルスタイルが適用されている false: 最初列のテーブルスタイルが適用されていない

isShowTableStyleLastColumn

  • isShowTableStyleLastColumn(): boolean

  • テーブルスタイルの適用有無の取得（最終列）を行います。

    Returns boolean

    true: 最終列のテーブルスタイルが適用されている false: 最終列のテーブルスタイルが適用されていない

isShowTableStyleRowStripes

  • isShowTableStyleRowStripes(): boolean

  • テーブルスタイルの適用有無の取得（１行おき：行）を行います。

    Returns boolean

    true: （１行おき：行）のテーブルスタイルが適用されている false: （１行おき：行）のテーブルスタイルが適用されていない

isShowTotals

  • isShowTotals(): boolean

  • 集計行の表示有無の取得を行います。

    Returns boolean

    true: 集計行が表示されている false: 集計行が表示されていない

removeAutoFilter

  • removeAutoFilter(): void

  • オートフィルターの除去を行います。

    Returns void

setBuiltinStyleName

  • setBuiltinStyleName(builtinStyleName, clearFormat): void

  • テーブルスタイル名の設定（ビルトイン）を行います。

    Parameters

    • builtinStyleName: XlDefaultTableStyle

      ビルトインのテーブルスタイル

    • clearFormat: boolean

      true : セルの書式を一旦クリアした後、テーブルスタイルを適用する false:今の状態に適用する

    Returns void

setColumnName

  • setColumnName(columnNames): void

  • 列名の一括設定を行います。

    Parameters

    • columnNames: string[]

      Array

    Returns void

setCustomRowFunction

  • setCustomRowFunction(colNum, totalsCalculation, isArray?): void

  • 集計行の計算方法の設定(カスタム)を行います。

    Parameters

    • colNum: number

      列番号(先頭=1)

    • totalsCalculation: string

      集計行の計算方法(カスタム)

    • isArray: boolean = false

      true: array関数として複数列に適用する false:通常関数を適用する

    Returns void

setCustomTableStyleName

  • setCustomTableStyleName(customTableStyleName, clearFormat): void

  • テーブルスタイル名の設定を行います。

    Parameters

    • customTableStyleName: string

      テーブルスタイル名

    • clearFormat: boolean

      true : セルの書式を一旦クリアした後、テーブルスタイルを適用する false:今の状態に適用する

    Returns void

setShowAutoFilter

  • setShowAutoFilter(showAutoFilter): void

  • オートフィルターの表示有無の設定を行います。

    Parameters

    • showAutoFilter: boolean

      true: オートフィルター表示のテーブルスタイルを適用する false: オートフィルター表示のテーブルスタイルを適用しない

    Returns void

setShowHeaders

  • setShowHeaders(showHeaders): void

  • ヘッダの表示有無の設定を行います。

    Parameters

    • showHeaders: boolean

      true:ヘッダを表示する false:ヘッダを表示しない

    Returns void

setShowTableStyleColumnStripes

  • setShowTableStyleColumnStripes(showTableStyleColumnStripes): void

  • テーブルスタイルの適用有無（１行おき：列）の設定を行います。

    Parameters

    • showTableStyleColumnStripes: boolean

      boolean true: （１行おき：列）のテーブルスタイルを適用する false: （１行おき：列）のテーブルスタイルを適用しない

    Returns void

setShowTableStyleFirstColumn

  • setShowTableStyleFirstColumn(showTableStyleFirstColumn): void

  • テーブルスタイルの適用有無（最初列）の設定を行います。

    Parameters

    • showTableStyleFirstColumn: boolean

      true: 最初列のテーブルスタイルを適用する false: 最初列のテーブルスタイルを適用しない

    Returns void

setShowTableStyleLastColumn

  • setShowTableStyleLastColumn(showTableStyleLastColumn): void

  • テーブルスタイルの適用有無（最後行）の設定を行います。

    Parameters

    • showTableStyleLastColumn: boolean

      true: 最後列のテーブルスタイルを適用する false: 最後列のテーブルスタイルを適用しない

    Returns void

setShowTableStyleRowStripes

  • setShowTableStyleRowStripes(showTableStyleRowStripes): void

  • テーブルスタイルの適用有無（１行おき：行）の設定を行います。

    Parameters

    • showTableStyleRowStripes: boolean

      true: （１行おき：行）のテーブルスタイルを適用する false: （１行おき：行）のテーブルスタイルを適用しない

    Returns void

setShowTotals

  • setShowTotals(showTotals): void

  • 集計行の表示有無の設定を行います。

    Parameters

    • showTotals: boolean

      true:集計行を表示する false:集計行を表示しない

    Returns void

setTotalRowFunction

  • setTotalRowFunction(colNum, totalsCalculation): void

  • 集計行の計算方法の設定を行います。

    Parameters

    • colNum: number

      列番号(先頭=1)

    • totalsCalculation: XlTotalsCalculation

      集計行の計算方法

    Returns void

setTotalRowLabel

  • setTotalRowLabel(colNum, totalRowLabel): void

  • 集計行のラベル名の設定を行います。

    Parameters

    • colNum: number

      列番号(先頭=1)

    • totalRowLabel: string

      集計行のラベル名

    Returns void

Settings

Member Visibility

Theme

On This Page

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