pyosbxl.WorkBook

class documentation

class WorkBook:

View In Hierarchy

Excelのワークブックを取り扱うクラスです。

ワークシートの生成や削除や位置移動、読み込みや保存を行います。 また、カスタムスタイルやカスタムテーブルスタイルの作成、削除も可能です。

openWorkBook等で取得されたインスタンスは、不要となった時点でcloseメソッドを呼び、ワークブックを閉じる必要があります。

Method addCustomStyle カスタムセルスタイルを追加します。
Method addCustomTableStyle カスタムテーブルスタイルを追加します。
Method addExternalWorkBook ワークシートの参照先として用いる外部ワークブックを追加します。
Method addPivotCustomTableStyle カスタムテーブルスタイルを追加します(ピボットテーブル)。
Method addWorkSheet ワークシートを追加します。
Method close ワークブックを閉じます。
Method deleteCustomStyle カスタムセルスタイルを削除します。
Method deleteCustomTableStyle カスタムテーブルスタイルを削除します。
Method deleteWorkSheet ワークシートを削除します。
Method getCustomStyle カスタムセルスタイルを取得します。
Method getCustomTableStyle カスタムテーブルスタイルを取得します。
Method getExternalWorkBookPath 外部ワークブック一覧を取得します。
Method getNames 名前付き範囲クラスのインスタンスを取得します。
Method getSheetCount ワークシート数を取得します。
Method getSheetNumber ワークシートを移動します。
Method isDate1904 Excelの日付1904年形式であるかどうかを取得します。
Method moveSheet ワークシートを移動します。
Method openWorkSheet ワークシートを開きます。
Method save ワークブックを同一ファイルに保存します。パスワード付きワークブックを読み込んだ場合、パスワード付きで保存されます。
Method saveAs ワークブックを別ファイルに保存します。
Method setCompanyName ワークブックのファイル属性として所属組織(Company)を設定します。
Method setCreateAuthor ワークブックのファイル属性としてドキュメント作成者を設定します。
Method setLastAuthor ワークブックのファイル属性としてドキュメントの最終更新者を設定します。
Method setManagerName ワークブックのファイル属性として管理者(マネージャー)を設定します。
Method updateExternalWorkBook ワークシートの参照先として用いる外部ワークブックを更新します(参照先のデータを再度取り込みます)。
def addCustomStyle(self, styleName: str, customStyleObject: dto.CustomStyleObject, builtinNumber: Optional[enums.XlBuiltInStyle] = None):

カスタムセルスタイルを追加します。

XlBuiltInStyleを指定した場合、カスタムセルスタイルを既存のスタイルからコピー＆上書きして追加します。

Parameters
styleName:strセルスタイル名
customStyleObject:CustomStyleObjectセルスタイルオブジェクト
builtinNumber:XlBuiltInStyle, optional派生元スタイル
def addCustomTableStyle(self, tableStyleName: str, customTableStyleObject: dto.CustomTableStyleObject, defaultStyle: Optional[enums.XlDefaultTableStyle] = None):

カスタムテーブルスタイルを追加します。

XlDefaultTableStyleを指定した場合、カスタムテーブルスタイルを既存のスタイルからコピー＆上書きして追加します。

CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。

設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

Parameters
tableStyleName:strテーブルスタイル名
customTableStyleObject:CustomTableStyleObjectテーブルスタイルオブジェクト
defaultStyle:XlDefaultTableStyle, optional派生元テーブルスタイル
def addExternalWorkBook(self, path: str) -> int:

ワークシートの参照先として用いる外部ワークブックを追加します。

Parameters
path:str外部ブックを参照する関数や値を新規に入力する前に、本メソッドで外部ワークブックを予め登録しておく必要があります。
Returns
int追加された外部ブックID 1から始まります。
def addPivotCustomTableStyle(self, tableStyleName: str, customTableStyleObject: dto.CustomTableStyleObject, defaultPivotStyle: Optional[enums.XlPivotDefaultTableStyle] = None):

カスタムテーブルスタイルを追加します(ピボットテーブル)。

XlPivotDefaultTableStyleを指定した場合、カスタムテーブルスタイルを既存のスタイルからコピー＆上書きして追加します(ピボットテーブル)。

CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。

設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

Parameters
tableStyleName:strピボットテーブルスタイル名
customTableStyleObject:CustomTableStyleObjectテーブルスタイルオブジェクト
defaultPivotStyle:XlPivotDefaultTableStyle, optional派生元ピボットテーブルスタイル
def addWorkSheet(self, sheetName: str, position: int = -1) -> WorkSheet:

ワークシートを追加します。

positionの先頭は1です。positionの前にシートを挿入します(-1の場合は最後尾になります)。

Parameters
sheetName:strシート名
position:int, optional挿入位置
Returns
WorkSheet追加したワークシートクラス
def close(self):

ワークブックを閉じます。

def deleteCustomStyle(self, styleName: str):

カスタムセルスタイルを削除します。

Parameters
styleName:strセルスタイル名
def deleteCustomTableStyle(self, tableStyleName: str):

カスタムテーブルスタイルを削除します。

テーブルスタイル、ピボットテーブルスタイル両方とも削除可能です。

Parameters
tableStyleName:strテーブルスタイル名または、ピボットテーブルスタイル名
def deleteWorkSheet(self, sheetName: str):

ワークシートを削除します。

Parameters
sheetName:strシート名
def getCustomStyle(self, styleName: str) -> dto.CustomStyleObject:

カスタムセルスタイルを取得します。

Parameters
styleName:strセルスタイル名
Returns
CustomStyleObjectセルスタイルオブジェクト
def getCustomTableStyle(self, tableStyleName: str) -> dto.CustomTableStyleObject:

カスタムテーブルスタイルを取得します。

テーブルスタイルも、ピボットテーブルスタイルも取得可能です。

Parameters
tableStyleName:strテーブルスタイル名または、ピボットテーブルスタイル名
Returns
CustomTableStyleObjectテーブルスタイルオブジェクト
def getExternalWorkBookPath(self) -> dto.MapIntString:

外部ワークブック一覧を取得します。

Returns
MapIntStringmap＜int,String＞ int:externalId(外部ワークブックID)、String:外部ワークブックのファイルパス。外部ワークシートIDは1から始まります。
def getNames(self) -> Names:

名前付き範囲クラスのインスタンスを取得します。

Returns
Names名前付き範囲クラスのインスタンス
def getSheetCount(self) -> int:

ワークシート数を取得します。

Returns
intワークシート数
def getSheetNumber(self, sheetName: str) -> int:

ワークシートを移動します。

Parameters
sheetName:strシート名
Returns
intシート番号 (先頭シートを1とします)
def isDate1904(self) -> bool:

Excelの日付1904年形式であるかどうかを取得します。

Returns
booltrue: 1904年形式 false: 既定形式
def moveSheet(self, sheetName: str, position: int):

ワークシートを移動します。

Parameters
sheetName:strシート名
position:int移動後のポジション (先頭シートを1とします)
def openWorkSheet(self, sheetName: str) -> WorkSheet:

ワークシートを開きます。

Parameters
sheetName:strシート名
Returns
WorkSheet読み込んだワークシートクラス
def save(self, passWord: Optional[str] = None):

ワークブックを同一ファイルに保存します。パスワード付きワークブックを読み込んだ場合、パスワード付きで保存されます。

passWordを指定した場合、ワークブックをパスワード付きで同一ファイルに保存します。

保存可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

Parameters
passWord:str, optionalパスワード
def saveAs(self, savePath: str, passWord: Optional[str] = None):

ワークブックを別ファイルに保存します。

passWordを指定した場合、ワークブックを別ファイルにパスワード付きで保存します。

保存可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

Parameters
savePath:str保存Excelの絶対パス
passWord:str, optionalパスワード。読み込んだパスワード付きワークブックを空文字で設定すると、パスワードなしとなります。
def setCompanyName(self, company: str):

ワークブックのファイル属性として所属組織(Company)を設定します。

Parameters
company:str所属組織
def setCreateAuthor(self, author: str):

ワークブックのファイル属性としてドキュメント作成者を設定します。

Parameters
author:strドキュメント作成者
def setLastAuthor(self, author: str):

ワークブックのファイル属性としてドキュメントの最終更新者を設定します。

Parameters
author:strドキュメントの最終更新者
def setManagerName(self, manager: str):

ワークブックのファイル属性として管理者(マネージャー)を設定します。

Parameters
manager:str管理者(マネージャー)
def updateExternalWorkBook(self, externalId: int):

ワークシートの参照先として用いる外部ワークブックを更新します(参照先のデータを再度取り込みます)。

externalIdは、getExternalWorkBookPathメソッドで確認できます。

シートの外部ワークシートは、取り込まれた(キャッシュされた)データを元に計算されます。

(更新された)外部ワークシートの最新データを取得するには、本メソッドを呼ぶ必要があります。

Parameters
externalId:int外部ワークシートID 1から始まります。