pyosbxl.Table

class documentation

class Table:

View In Hierarchy

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

Method changeTableName テーブル名の変更を行います。
Method getAllRange テーブルの全範囲をセル範囲クラスで取得します。
Method getAutoFilter オートフィルタークラスの取得を行います。
Method getColumnName 列名の一括取得を行います。
Method getDataBodyRange テーブルのデータ部をセル範囲クラスで取得します。
Method getHeaderRowRange テーブルのヘッダーをセル範囲クラスで取得します。
Method getName テーブル名の取得を行います。
Method getTableStyleName テーブルスタイル名の取得を行います。
Method getTotalRowFunction 集計行の計算方法の取得を行います。
Method getTotalRowLabel 集計行のラベル名の取得を行います。
Method getTotalRowRange テーブルの集計行をセル範囲クラスで取得します。
Method isShowAutoFilter ヘッダの表示有無の取得を行います。
Method isShowHeaders 集計行の表示有無の取得を行います。
Method isShowTableStyleColumnStripes テーブルスタイルの適用有無の取得（１行おき：列）を行います。
Method isShowTableStyleFirstColumn テーブルスタイルの適用有無の取得（最初列）を行います。
Method isShowTableStyleLastColumn テーブルスタイルの適用有無の取得（最終列）を行います。
Method isShowTableStyleRowStripes テーブルスタイルの適用有無の取得（１行おき：行）を行います。
Method isShowTotals オートフィルターの表示有無の取得を行います。
Method removeAutoFilter オートフィルターの除去を行います。
Method setBuiltinStyleName テーブルスタイル名の設定（ビルトイン）を行います。
Method setColumnName 列名の一括設定を行います。
Method setCustomRowFunction 集計行の計算方法の設定(カスタム)を行います。
Method setCustomTableStyleName テーブルスタイル名の設定を行います。
Method setShowAutoFilter オートフィルターの表示有無の設定を行います。
Method setShowHeaders ヘッダの表示有無の設定を行います。
Method setShowTableStyleColumnStripes テーブルスタイルの適用有無（１行おき：列）の設定を行います。
Method setShowTableStyleFirstColumn テーブルスタイルの適用有無（最初列）の設定を行います。
Method setShowTableStyleLastColumn テーブルスタイルの適用有無（最後行）の設定を行います。
Method setShowTableStyleRowStripes テーブルスタイルの適用有無（１行おき：行）の設定を行います。
Method setShowTotals オートフィルターの表示有無の設定を行います。
Method setTotalRowFunction 集計行の計算方法の設定を行います。
Method setTotalRowLabel 集計行のラベル名の設定を行います。
def changeTableName(self, tableName: str):

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

Parameters
tableName:strテーブル名
def getAllRange(self) -> Range:

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

Returns
Rangeセル範囲クラス(テーブルの全範囲)
def getAutoFilter(self) -> AutoFilter:

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

Returns
AutoFilterオートフィルタークラス
def getColumnName(self) -> dto.VectorString:

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

Returns
VectorStringList＜列名＞
def getDataBodyRange(self) -> Range:

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

Returns
Rangeセル範囲クラス(テーブルのデータ部)
def getHeaderRowRange(self) -> Range:

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

Returns
Rangeセル範囲クラス(テーブルのヘッダー)
def getName(self) -> str:

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

Returns
strテーブル名
def getTableStyleName(self) -> str:

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

Returns
strテーブルスタイル名
def getTotalRowFunction(self, colNum: int) -> enums.XlTotalsCalculation:

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

Parameters
colNum:int列番号(先頭=1)
Returns
XlTotalsCalculation集計行の計算方法
def getTotalRowLabel(self, colNum: int) -> str:

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

Parameters
colNum:int列番号(先頭=1)
Returns
str集計行のラベル名
def getTotalRowRange(self) -> Range:

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

Returns
Rangeセル範囲クラス(テーブルの集計行)
def isShowAutoFilter(self) -> bool:

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

Returns
booltrue:ヘッダが表示されている false:ヘッダが表示されていない
def isShowHeaders(self) -> bool:

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

Returns
booltrue: 集計行が表示されている false: 集計行が表示されていない
def isShowTableStyleColumnStripes(self) -> bool:

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

Returns
booltrue: （１行おき：列）のテーブルスタイルが適用されている false: （１行おき：列）のテーブルスタイルが適用されていない
def isShowTableStyleFirstColumn(self) -> bool:

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

Returns
booltrue: 最初列のテーブルスタイルが適用されている false: 最初列のテーブルスタイルが適用されていない
def isShowTableStyleLastColumn(self) -> bool:

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

Returns
booltrue: 最終列のテーブルスタイルが適用されている false: 最終列のテーブルスタイルが適用されていない
def isShowTableStyleRowStripes(self) -> bool:

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

Returns
booltrue: （１行おき：行）のテーブルスタイルが適用されている false: （１行おき：行）のテーブルスタイルが適用されていない
def isShowTotals(self) -> bool:

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

Returns
booltrue: オートフィルターのテーブルスタイルが適用されている false: オートフィルターのテーブルスタイルが適用されていない
def removeAutoFilter(self):

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

def setBuiltinStyleName(self, builtinStyleName: enums.XlDefaultTableStyle, clearFormat: bool):

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

Parameters
builtinStyleName:XlDefaultTableStyleビルトインのテーブルスタイル
clearFormat:booltrue:セルの書式を一旦クリアした後、テーブルスタイルを適用する false:今の状態に適用する
def setColumnName(self, columnNames: dto.VectorString):

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

Parameters
columnNames:VectorStringList＜列名＞
def setCustomRowFunction(self, colNum: int, totalsCalculation: str, isArray: bool = False):

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

Parameters
colNum:int列番号(先頭=1)
totalsCalculation:str集計行の計算方法(カスタム)
isArray:bool, optionaltrue:array関数として複数列に適用する false:通常関数を適用する
def setCustomTableStyleName(self, customTableStyleName: str, clearFormat: bool):

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

Parameters
customTableStyleName:strテーブルスタイル名
clearFormat:booltrue : セルの書式を一旦クリアした後、テーブルスタイルを適用する false:今の状態に適用する
def setShowAutoFilter(self, showAutoFilter: bool):

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

Parameters
showAutoFilter:booltrue: オートフィルター表示のテーブルスタイルを適用する false: オートフィルター表示のテーブルスタイルを適用しない
def setShowHeaders(self, showHeaders: bool):

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

Parameters
showHeaders:booltrue:ヘッダを表示する false:ヘッダを表示しない
def setShowTableStyleColumnStripes(self, showTableStyleColumnStripes: bool):

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

Parameters
showTableStyleColumnStripes:booltrue:（１行おき：列）のテーブルスタイルを適用する false:（１行おき：列）のテーブルスタイルを適用しない
def setShowTableStyleFirstColumn(self, showTableStyleFirstColumn: bool):

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

Parameters
showTableStyleFirstColumn:booltrue: 最初列のテーブルスタイルを適用する false: 最初列のテーブルスタイルを適用しない
def setShowTableStyleLastColumn(self, showTableStyleLastColumn: bool):

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

Parameters
showTableStyleLastColumn:booltrue: 最後列のテーブルスタイルを適用する false: 最後列のテーブルスタイルを適用しない
def setShowTableStyleRowStripes(self, showTableStyleRowStripes: bool):

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

Parameters
showTableStyleRowStripes:booltrue:（１行おき：行）のテーブルスタイルを適用する false:（１行おき：行）のテーブルスタイルを適用しない
def setShowTotals(self, showTotals: bool):

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

Parameters
showTotals:booltrue: オートフィルター表示のテーブルスタイルを適用する false: オートフィルター表示のテーブルスタイルを適用しない
def setTotalRowFunction(self, colNum: int, totalsCalculation: enums.XlTotalsCalculation):

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

Parameters
colNum:int列番号(先頭=1)
totalsCalculation:XlTotalsCalculation集計行の計算方法
def setTotalRowLabel(self, colNum: int, totalRowLabel: str):

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

Parameters
colNum:int列番号(先頭=1)
totalRowLabel:str集計行のラベル名