pyosbxl.App

class documentation

class App:

Constructor: App()

osbxlのアプリケーション起動クラスです。

Excelの新規作成、既存ファイルの読み込みを行います。各種ユーティリティ(セル範囲←→数値や日付←→数値)も備え持ちます。

Method	`__init__`	コンストラクタ。オブジェクトの初期化を行います。
Method	`convertFromColumnNumber`	列の数値表記をA1表記に変換します。列番号は1から始まります。(A列が、1です)
Method	`convertFromRowColNumber`	セルの数値表記をA1C1表記にに変換します。列番号、行番号は、1から始まります。((1,1)は、A1となります)
Method	`convertFromRowColNumber2`	セル範囲の数値表記をA1C1表記にに変換します。列番号、行番号は、1から始まります。((1,1)は、A1となります)
Method	`convertToColumnNumber`	列のA1表記を数値型表記に変換します。返却値は、1から始まります。
Method	`createWorkBook`	ワークブックを作成します。作成可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
Method	`getNumericValue`	日付時刻型オブジェクトからExcel内部でもっている数値の値(シリアル値)を取得します。
Method	`getVersion`	アプリケーションのバージョンを取得します。
Method	`openPasswordWorkBook`	パスワード付きワークブックを開きます。読み込み可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。
Method	`openWorkBook`	ワークブックを開きます。読み込み可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

def __init__(self): ¶

コンストラクタ。オブジェクトの初期化を行います。

def convertFromColumnNumber(self, colNumber: int, absDisplay: bool = False) -> str: ¶

列の数値表記をA1表記に変換します。列番号は1から始まります。(A列が、1です)

Parameters
colNumber:`int`	列番号
absDisplay:`bool`, optional	trueの場合、$付き表記(セルの絶対参照)で取得します。
Returns
`str`	A1表記

def convertFromRowColNumber(self, rowNumber: int, colNumber: int, absRowDisplay: bool = False, absColDisplay: bool = False) -> str: ¶

セルの数値表記をA1C1表記にに変換します。列番号、行番号は、1から始まります。((1,1)は、A1となります)

Parameters
rowNumber:`int`	行番号
colNumber:`int`	列番号
absRowDisplay:`bool`	trueの場合、$付き表記(セルの絶対参照)で取得します。
absColDisplay:`bool`	trueの場合、$付き表記(セルの絶対参照)で取得します。
Returns
`str`	A1表記

def convertFromRowColNumber2(self, startRowNumber: int, startColNumber: int, endRowNumber: int, endColNumber: int, absStartRowDisplay: bool = False, absStartColDisplay: bool = False, absEndRowDisplay: bool = False, absEndColDisplay: bool = False) -> str: ¶

セル範囲の数値表記をA1C1表記にに変換します。列番号、行番号は、1から始まります。((1,1)は、A1となります)

Parameters
startRowNumber:`int`	先頭行番号
startColNumber:`int`	先頭列番号
endRowNumber:`int`	末尾行番号
endColNumber:`int`	末尾列番号
absStartRowDisplay:`bool`, optional	trueの場合、$付き表記(セルの絶対参照)で取得します。
absStartColDisplay:`bool`, optional	trueの場合、$付き表記(セルの絶対参照)で取得します。
absEndRowDisplay:`bool`, optional	trueの場合、$付き表記(セルの絶対参照)で取得します。
absEndColDisplay:`bool`, optional	trueの場合、$付き表記(セルの絶対参照)で取得します。
Returns
`str`	A1C1表記

def convertToColumnNumber(self, A1: str) -> int: ¶

列のA1表記を数値型表記に変換します。返却値は、1から始まります。

Parameters
A1:`str`	A1表記
Returns
`int`	列の数値変換値

def createWorkBook(self, bookPath: str, defalutFont: enums.XlFont = enums.XlFont.YU_GOTHIC, defaultFontSize: float = 11.0) -> WorkBook: ¶

ワークブックを作成します。作成可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

Parameters
bookPath:`str`	ワークブックのファイルパス
defalutFont:`XlFont`, optional	フォント列挙体
defaultFontSize:`float`, optional	フォントサイズ
Returns
`WorkBook`	作成したワークブッククラス

def getNumericValue(self, dateTimeObject: dto.DateTimeObject, is1904: bool = False) -> float: ¶

日付時刻型オブジェクトからExcel内部でもっている数値の値(シリアル値)を取得します。

Parameters
dateTimeObject:`DateTimeObject`	変換元日付時刻型オブジェクト最小値は、is1904メソッドに依存した値となり、最大値は、9999/12/31となります。
is1904:`bool`, optional	ワークブックの年月が1904年形式(最小値が1904/1/1)の場合: true, 通常(最小値が1900/1/1)の場合: false
Returns
`float`	シリアル値

def getVersion(self) -> str: ¶

アプリケーションのバージョンを取得します。

Returns
`str`	アプリケーションのバージョン

def openPasswordWorkBook(self, bookPath: str, passWord: str) -> WorkBook: ¶

パスワード付きワークブックを開きます。読み込み可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

Parameters
bookPath:`str`	ワークブックのファイルパス
passWord:`str`	パスワード
Returns
`WorkBook`	ワークブッククラス

def openWorkBook(self, bookPath: str) -> WorkBook: ¶

ワークブックを開きます。読み込み可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

Parameters
bookPath:`str`	ワークブックのファイルパス
Returns
`WorkBook`	ワークブッククラス