pyosbxl.Window

class documentation

class Window:

View In Hierarchy

ワークシートの外観(Window)を扱うクラスです。

Method clearFreezePanes 領域の固定を解除します。
Method clearSplit 領域の分割を解除します。
Method getDisplayFormulas 数式の表示有無を取得します。
Method getDisplayGridlines グリッドラインの表示有無を取得します。
Method getDisplayHeadings 行見出しと列見出だしの表示有無を取得します。
Method getDisplayHorizontalScrollBar 水平スクロールバーの表示有無を取得します。
Method getDisplayOutline アウトラインの表示有無を取得します。
Method getDisplayRuler ルーラーの表示有無を取得します。
Method getDisplayVerticalScrollBar 垂直スクロールバーの表示有無を取得します。
Method getDisplayWhitespace 空白の表示有無を取得します。
Method getDisplayWorkbookTabs タブの表示有無を取得します。
Method getDisplayZeros 零の表示有無を取得します。
Method getFreezePanes 領域が固定されているかどうかを取得します。
Method getGridlineColor グリッドライン色オブジェクトを取得します。
Method getSplit 領域が分割されているかどうかを取得します。
Method getSplitColumn 列の分割位置を取得します。
Method getSplitHorizontal 水平方向の分割位置の取得を行います。
Method getSplitRow 行の分割位置を取得します。
Method getSplitVertical 垂直方向の分割位置の取得を行います。
Method getType 画面の表示タイプを取得します。
Method getZoom ズームの取得(パーセント)を行います。
Method setDisplayFormulas 数式の表示有無の設定をします。
Method setDisplayGridlines グリッド線の表示有無の設定を設定します。
Method setDisplayHeadings 行見出しと列見出だしの表示有無の設定をします。
Method setDisplayHorizontalScrollBar 水平スクロールバーの表示有無の設定をします。
Method setDisplayOutline アウトラインの表示有無の設定をします。
Method setDisplayRuler ルーラーの表示有無の設定をします。
Method setDisplayVerticalScrollBar 垂直スクロールバーの表示有無の設定をします。
Method setDisplayWhitespace 空文字の表示有無の設定をします。
Method setDisplayWorkbookTabs タブの表示有無の設定をします。
Method setDisplayZeros 零の表示有無の設定をします。
Method setFreezePanes 領域を固定します。
Method setGridlineColor グリッドライン色オブジェクトを設定します。
Method setSplitColumn 何列目で、水平方向を分割するかどうか設定します。
Method setSplitHorizontal 水平方向の分割位置の取得を行います。
Method setSplitRow _summary_
Method setSplitVertical 何行目で、垂直方向を分割するかどうかを設定します。
Method setType 画面の表示タイプを設定します。
Method setZoom ズームの設定(パーセント)を行います。
def clearFreezePanes(self):

領域の固定を解除します。

def clearSplit(self):

領域の分割を解除します。

def getDisplayFormulas(self) -> bool:

数式の表示有無を取得します。

Returns
booltrue: 数式を表示 false: 数式の表示をしない
def getDisplayGridlines(self) -> bool:

グリッドラインの表示有無を取得します。

Returns
booltrue: グリッドラインを表示する false: グリッドラインを表示しない
def getDisplayHeadings(self) -> bool:

行見出しと列見出だしの表示有無を取得します。

Returns
booltrue: 行見出しと列見出だしを表示する false: 行見出しと列見出だしを表示しない
def getDisplayHorizontalScrollBar(self) -> bool:

水平スクロールバーの表示有無を取得します。

Returns
booltrue: 水平スクロールバーを表示する false: 水平スクロールバーを表示しない
def getDisplayOutline(self) -> bool:

アウトラインの表示有無を取得します。

Returns
booltrue: アウトラインを表示する false:アウトラインを表示しない
def getDisplayRuler(self) -> bool:

ルーラーの表示有無を取得します。

Returns
booltrue: ルーラーを表示する false: ルーラーを表示しない
def getDisplayVerticalScrollBar(self) -> bool:

垂直スクロールバーの表示有無を取得します。

Returns
booltrue: 垂直スクロールバーを表示する false: 垂直スクロールバーを表示しない
def getDisplayWhitespace(self) -> bool:

空白の表示有無を取得します。

Returns
booltrue: 空文字を表示する false:空文字を表示しない
def getDisplayWorkbookTabs(self) -> bool:

タブの表示有無を取得します。

Returns
booltrue: タブを表示する false:タブを表示しない
def getDisplayZeros(self) -> bool:

零の表示有無を取得します。

Returns
booltrue:零を表示します。 false:零を表示しない
def getFreezePanes(self) -> bool:

領域が固定されているかどうかを取得します。

Returns
booltrue: 領域が固定されている false:領域が固定されていない
def getGridlineColor(self) -> dto.ColorObject:

グリッドライン色オブジェクトを取得します。

Returns
ColorObjectグリッドライン色オブジェクト
def getSplit(self) -> bool:

領域が分割されているかどうかを取得します。

Returns
booltrue:分割されている false: 分割されていない
def getSplitColumn(self) -> int:

列の分割位置を取得します。

Returns
int先頭は1から始まります。
def getSplitHorizontal(self) -> float:

水平方向の分割位置の取得を行います。

osbxlでは、中途半端なセルの末端で分割をいれるため、setSplitHorizontalで設定した値と異なる値が返されます。

Returns
float領域が分割された画面の左上からの水平方向の距離(ポイント単位)
def getSplitRow(self) -> int:

行の分割位置を取得します。

Returns
int分割位置 先頭は1から始まります。
def getSplitVertical(self) -> float:

垂直方向の分割位置の取得を行います。

Returns
float領域が分割された画面の左上からの垂直方向の距離(ポイント単位)
def getType(self) -> enums.XlWindowView:

画面の表示タイプを取得します。

Returns
XlWindowView画面の表示タイプ
def getZoom(self) -> int:

ズームの取得(パーセント)を行います。

Returns
intズーム(パーセント) 100は等倍となります。0は自動を意味します。
def setDisplayFormulas(self, isDisplayFormula: bool):

数式の表示有無の設定をします。

Parameters
isDisplayFormula:boolboolean true: 表示する false:表示しない
def setDisplayGridlines(self, isDisplayGridLines: bool):

グリッド線の表示有無の設定を設定します。

Parameters
isDisplayGridLines:booltrue: グリッド線を表示する false: グリッド線を表示しない
def setDisplayHeadings(self, isDisplayHeading: bool):

行見出しと列見出だしの表示有無の設定をします。

Parameters
isDisplayHeading:booltrue: 行見出しと列見出だしを表示する false: 行見出しと列見出だしを表示しない
def setDisplayHorizontalScrollBar(self, isDisplayHorizontalScrollBar: bool):

水平スクロールバーの表示有無の設定をします。

Parameters
isDisplayHorizontalScrollBar:booltrue: 水平スクロールバーを表示する false: 水平スクロールバーを表示しない
def setDisplayOutline(self, isDisplayOutline: bool):

アウトラインの表示有無の設定をします。

Parameters
isDisplayOutline:booltrue: アウトラインを表示する false:アウトラインを表示しない
def setDisplayRuler(self, isDisplayRuler: bool):

ルーラーの表示有無の設定をします。

Parameters
isDisplayRuler:booltrue: ルーラーを表示する false: ルーラーを表示しない
def setDisplayVerticalScrollBar(self, isDisplayVerticalScrollBar: bool):

垂直スクロールバーの表示有無の設定をします。

Parameters
isDisplayVerticalScrollBar:booltrue: 垂直スクロールバーを表示する false: 垂直スクロールバーを表示しない
def setDisplayWhitespace(self, isDisplayWhitespace: bool):

空文字の表示有無の設定をします。

Parameters
isDisplayWhitespace:booltrue: 空文字を表示する false:空文字を表示しない
def setDisplayWorkbookTabs(self, isDisplayWorkbookTabs: bool):

タブの表示有無の設定をします。

Parameters
isDisplayWorkbookTabs:booltrue: タブを表示する false:タブを表示しない
def setDisplayZeros(self, isDisplayZeros: bool):

零の表示有無の設定をします。

Parameters
isDisplayZeros:booltrue:零を表示します。 false:零を表示しない
def setFreezePanes(self):

領域を固定します。

領域を固定する場合、あらかじめ、setSplitColumnメソッドやsetSplitHorizontalメソッド、setSplitRowメソッドやsetSplitVerticalメソッドで、予め領域を設定しておく必要があります。

def setGridlineColor(self, colorObject: dto.ColorObject):

グリッドライン色オブジェクトを設定します。

Parameters
colorObject:ColorObject色の設定は、XlIndexColorのみサポートされます。他のタイプは設定できません。
def setSplitColumn(self, colNumber: int):

何列目で、水平方向を分割するかどうか設定します。

Parameters
colNumber:int分割位置 先頭は1から始まります。
def setSplitHorizontal(self, splitHorizontalSize: float):

水平方向の分割位置の取得を行います。

Parameters
splitHorizontalSize:floatosbxlでは、中途半端なセルの末端で分割をいれるため、setSplitHorizontalで設定した値と異なる値が返されます。
def setSplitRow(self, rowNum: int):

_summary_

Parameters
rowNum:int_description_
def setSplitVertical(self, splitVerticalSize: float):

何行目で、垂直方向を分割するかどうかを設定します。

Parameters
splitVerticalSize:float分割位置 先頭は1から始まります。
def setType(self, windowType: enums.XlWindowView):

画面の表示タイプを設定します。

Parameters
windowType:XlWindowView画面の表示タイプ
def setZoom(self, zoom: int):

ズームの設定(パーセント)を行います。

Parameters
zoom:int100は等倍となります。0は自動を意味します。