pyosbxl.Range

class documentation

class Range:

ワークシートのセル範囲を扱うクラスです。

Method	`clearAllFormat`	セル範囲の書式すべてをワークシートの初期値に戻します。
Method	`clearContent`	セル範囲の値をクリアします。
Method	`clearDataTable`	データテーブルのクリアを行います。データテーブルを消去します。Rangeのセル範囲の中に、データテーブルの(データ部=TABLE関数)が入っていれば、消去します。
Method	`clearNumberFormat`	セル範囲のセル書式をクリアします。
Method	`getAddress`	セル範囲(A1C1文字列形式)の取得を行います。
Method	`getAlignment`	セル配置クラスの取得を行います。
Method	`getBorders`	枠線一括クラスの取得を行います。
Method	`getCharacters`	文字列クラスの取得を行います。
Method	`getFill`	塗りつぶしクラスの取得を行います。
Method	`getFont`	フォントクラスの取得を行います。
Method	`getFormula`	セル範囲の関数を取得します。
Method	`getNumberFormat`	セル配置のセル書式を取得します。
Method	`getPhonetics`	フリガナクラスの取得を行います。
Method	`getProtection`	セル保護クラスの取得を行います。
Method	`getTotalColumnWidth`	セル範囲の列に収まる文字数の取得を行います。
Method	`getTotalRowHeight`	セル範囲の高さの取得を行います。セル範囲の数を取得します。
Method	`getTotalWidth`	セル範囲の幅の取得を行います。セル範囲のピクセル数を取得します。OSBXLでは、DPIを96DPIとした計算値を取得します。
Method	`getValue`	セル範囲の値を取得します。
Method	`merge`	セル範囲を結合します。
Method	`setBooleanValue`	セル配置の値を設定します(論理値)。
Method	`setBuiltinStyle`	セル範囲にExcelビルトイン(組み込み)のセルスタイルを適用します。
Method	`setCustomStyle`	セル範囲にカスタムセルスタイルの適用を行います。
Method	`setDataTable`	データテーブルの設定を行います。
Method	`setDateStringValue`	セル配置の値を設定します(日付/時刻設定メソッド(文字列から入力))。
Method	`setDateValue`	セル配置の値を設定します(日付時刻オブジェクト)。
Method	`setFormula`	数式の設定を行います。
Method	`setNumberFormat`	セル配置のセル書式を設定します。
Method	`setNumberValue`	セル配置の値を設定します(数値)。
Method	`setValue`	セル配置の値を設定します(汎用)。
Method	`unMerge`	マージの解除を行います。

def clearAllFormat(self): ¶

セル範囲の書式すべてをワークシートの初期値に戻します。

def clearContent(self): ¶

セル範囲の値をクリアします。

def clearDataTable(self): ¶

データテーブルのクリアを行います。データテーブルを消去します。Rangeのセル範囲の中に、データテーブルの(データ部=TABLE関数)が入っていれば、消去します。

def clearNumberFormat(self): ¶

セル範囲のセル書式をクリアします。

def getAddress(self) -> str: ¶

セル範囲(A1C1文字列形式)の取得を行います。

Returns
`str`	セル範囲(A1C1文字列形式)

def getAlignment(self) -> Alignment: ¶

セル配置クラスの取得を行います。

Returns
`Alignment`	セル配置クラス

def getBorders(self) -> Borders: ¶

枠線一括クラスの取得を行います。

Returns
`Borders`	枠線一括クラス

def getCharacters(self, start: int, length: Optional[int] = None) -> Characters: ¶

文字列クラスの取得を行います。

Parameters
start:`int`	開始位置(先頭文字=1)
length:`int`, optional	(指定した場合)文字数
Returns
`Characters`	文字列クラス

def getFill(self) -> Fill: ¶

塗りつぶしクラスの取得を行います。

Returns
`Fill`	塗りつぶしクラス

def getFont(self) -> Font: ¶

フォントクラスの取得を行います。

Returns
`Font`	フォントクラス

def getFormula(self) -> dto.MapStringString: ¶

セル範囲の関数を取得します。

Returns
`MapStringString`	Map＜セル範囲(A1), 関数＞

def getNumberFormat(self) -> dto.MapStringString: ¶

セル配置のセル書式を取得します。

Returns
`MapStringString`	Map＜セル範囲(A1C1), セル書式＞

def getPhonetics(self) -> Phonetics: ¶

フリガナクラスの取得を行います。

Returns
`Phonetics`	フリガナクラス

def getProtection(self) -> Protection: ¶

セル保護クラスの取得を行います。

Returns
`Protection`	セル保護クラス

def getTotalColumnWidth(self) -> float: ¶

セル範囲の列に収まる文字数の取得を行います。

セル範囲の列に収まる文字数を設定します。文字数の単位は、現在のフォントの0~9の文字の中で一番横幅が長い文字となります(Excel同様です)。

Returns
`float`	セル範囲の列に収まる文字数

def getTotalRowHeight(self) -> float: ¶

セル範囲の高さの取得を行います。セル範囲の数を取得します。

Returns
`float`	セル範囲の高さ

def getTotalWidth(self) -> float: ¶

セル範囲の幅の取得を行います。セル範囲のピクセル数を取得します。OSBXLでは、DPIを96DPIとした計算値を取得します。

Returns
`float`	セル範囲のピクセル数

def getValue(self) -> dto.MapStringString: ¶

セル範囲の値を取得します。

Returns
`MapStringString`	Map＜セル範囲(A1), 値＞

def merge(self, mergeEachRow: bool = False): ¶

セル範囲を結合します。

Parameters
mergeEachRow:`bool`, optional	true: 行単位に分割して結合 false:セル範囲全体を結合

def setBooleanValue(self, value: bool, forceString: bool = False, numberFormat: str = ''): ¶

セル配置の値を設定します(論理値)。

Parameters
value:`bool`	値 true: TRUE false: FALSE
forceString:`bool`, optional	true: 強制的に文字列と扱う false: 通常
numberFormat:`str`, optional	セルの書式

def setBuiltinStyle(self, builtinNumber: enums.XlBuiltInStyle): ¶

セル範囲にExcelビルトイン(組み込み)のセルスタイルを適用します。

Parameters
builtinNumber:`XlBuiltInStyle`	Excelビルトイン(組み込み)のセルスタイル

def setCustomStyle(self, customStyleName: str): ¶

セル範囲にカスタムセルスタイルの適用を行います。

Parameters
customStyleName:`str`	カスタムセルスタイル名

def setDataTable(self, rowA1: str, colA1: str): ¶

データテーブルの設定を行います。

データテーブルの範囲は、Rangeのセル範囲となります。

rowA1およびcolA1の両方に値を設定すると、複方向(行、列)のデータテーブルとなり、片方に値を設定すると、単方向(行または列)となります。

複方向の時は、計算セルは、左上のセルとなります。

単方向の時は、Rangeのセル範囲は、２行または、２列である必要があります。

データーテーブルの向きが行の時は２列目の先頭セルに計算式がある必要があり、列の時は、２行目の先頭セルに計算式がある必要があります。

Parameters
rowA1:`str`	単方向データテーブルの向きが行の時は、空文字を設定します。
colA1:`str`	方向データテーブルの向きが列の時は、空文字を設定します。

def setDateStringValue(self, value: str, forceString: bool = False, numberFormat: str = ''): ¶

セル配置の値を設定します(日付/時刻設定メソッド(文字列から入力))。

Parameters
value:`str`	値
forceString:`bool`, optional	true: 強制的に文字列と扱う false: 通常
numberFormat:`str`, optional	セルの書式

def setDateValue(self, value: dto.DateTimeObject, forceString: bool = False, numberFormat: str = ''): ¶

セル配置の値を設定します(日付時刻オブジェクト)。

Parameters
value:`DateTimeObject`	値
forceString:`bool`, optional	true: 強制的に文字列と扱う false: 通常
numberFormat:`str`, optional	セルの書式

def setFormula(self, formula: str, isArray: bool = False, setAllCell: bool = False): ¶

数式の設定を行います。

ARRAY数式の場合、setAllCellは無視されます。

ExcelのSpill機能をサポートしています。そのため、1セルに対して、複数セルの返却値が返されることがあります。

Excel同様に、セル範囲は、相対参照、絶対参照($つき)を設定可能です。

Parameters
formula:`str`	数式
isArray:`bool`, optional	true: Array数式としてセル範囲全体が入力対象 false:通常数式
setAllCell:`bool`, optional	false:対象セルのTopLeftセル(先頭セル)だけformulaを設定する true:全セルに数式を設定する

def setNumberFormat(self, numberFormat: str): ¶

セル配置のセル書式を設定します。

Parameters
numberFormat:`str`	セル書式

def setNumberValue(self, value: float, forceString: bool = False, numberFormat: str = ''): ¶

セル配置の値を設定します(数値)。

Parameters
value:`float`	値
forceString:`bool`, optional	true: 強制的に文字列と扱う false: 通常
numberFormat:`str`, optional	セルの書式

def setValue(self, value: str, forceString: bool = False, numberFormat: str = ''): ¶

セル配置の値を設定します(汎用)。

Parameters
value:`str`	値
forceString:`bool`, optional	true: 強制的に文字列と扱う false: 通常
numberFormat:`str`, optional	セルの書式空文字の場合は、設定しません。

def unMerge(self): ¶

マージの解除を行います。