pyosbxl.WorkSheet

class documentation

class WorkSheet:

ExcelのWorkSheetを取り扱うクラスです。

Method	`activate`	ワークシートのタブのアクティブ/非アクティブ(起動時の表示項目か否か)を設定します。
Method	`addChartObject`	チャート図形クラスを追加し、そのインスタンスを取得します。
Method	`clearCell`	ワークシート上のセルをワークシート初期値に戻します。
Method	`clearCol`	ワークシート上の列をワークシート初期値に戻します。
Method	`clearColOutline`	列方向のアウトラインのクリアを行います。
Method	`clearRow`	ワークシート上の行をワークシート初期値に戻します。
Method	`clearRowOutline`	行方向のアウトラインのクリアを行います。
Method	`copyCell`	セル範囲の上書きコピーを行います。
Method	`copyCol`	セル範囲の上書きコピーを行います(コピー対象: CopyContentTypeAll)。
Method	`copyRow`	行の上書きコピーを行います。
Method	`deleteCell`	ワークシート上のセル範囲の削除を行います。
Method	`deleteChartObject`	チャート図形クラスを削除します。
Method	`deleteCol`	ワークシート上の列の削除を行います。
Method	`deleteRow`	ワークシート上の行の削除を行います。
Method	`getActiveCell`	ワークシートのアクティブな(選択されている)セル範囲の取得を行います。
Method	`getAutoFilter`	オートフィルタークラスを取得します。
Method	`getCells`	セル範囲クラスを取得します。A1:B2=(startRow=1,startCol=1,endRow=2,endCol=2)です。
Method	`getChartObject`	チャート図形クラスを取得します。
Method	`getCol`	列クラスを取得します。
Method	`getComments`	コメント/メモクラスを取得します。
Method	`getFormatConditions`	条件付き書式クラスを取得します。
Method	`getHPageBreaks`	水平方向改行クラスを取得します。
Method	`getHyperLinks`	ハイパーリンククラスを取得します。
Method	`getListObjects`	テーブル取得/生成クラスを取得します。
Method	`getName`	シート名称の取得を行います。
Method	`getPageSetupObject`	ワークシートの印刷情報(ページマージン等の情報)を取得します。
Method	`getPivotTables`	PivotTable取得/生成クラスを取得します。
Method	`getRange`	セル範囲クラスを取得します。
Method	`getRow`	行クラスを取得します。
Method	`getShapes`	図形クラスを取得します。
Method	`getSort`	並び替えクラスを取得します。
Method	`getVPageBreaks`	垂直方向改行クラスを取得します。
Method	`getWindow`	外観情報クラスを取得します。
Method	`insertCell`	ワークシート上のセル範囲の挿入を行います。
Method	`insertCol`	ワークシート上の列の挿入を行います。
Method	`insertRow`	ワークシート上の行の挿入を行います。
Method	`isActive`	ワークシートがアクティブかどうか(現在のワークシートのタブが起動時の表示項目か)を取得します。
Method	`setActiveCell`	ワークシートのアクティブな(選択する)セル範囲の設定を行います。
Method	`setColOutline`	列方向のアウトラインを設定します。
Method	`setFormulaArray`	関数の一括入力を行います。
Method	`setName`	シート名称の設定を行います。
Method	`setPageSetupObject`	ワークシートの印刷情報(ページマージン等の情報)を設定します。
Method	`setRowOutline`	行方向のアウトラインを設定します。
Method	`setValueArray`	セル値の一括入力を行います。

def activate(self, isActive: bool): ¶

ワークシートのタブのアクティブ/非アクティブ(起動時の表示項目か否か)を設定します。

Parameters
isActive:`bool`	アクティブのタブを一つにするには、現在アクティブなタブを非アクティブにして、現在のシートをアクティブに設定します。

def addChartObject(self, chartName: str, left: float, top: float, width: float, height: float) -> chart.ChartObject: ¶

チャート図形クラスを追加し、そのインスタンスを取得します。

Parameters
chartName:`str`	チャート名。空文字で設定すると、チャート名は、自動生成されます。
left:`float`	左端(単位:ポイント数)
top:`float`	上端(単位:ポイント数)
width:`float`	幅(単位:ポイント数)
height:`float`	高さ(単位:ポイント数)
Returns
`ChartObject`	追加したチャート図形クラス

def clearCell(self, A1C1: str): ¶

ワークシート上のセルをワークシート初期値に戻します。

Parameters
A1C1:`str`	クリアセル範囲(A1C1)

def clearCol(self, startColNumber: int, numOfCols: int): ¶

ワークシート上の列をワークシート初期値に戻します。

A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

Parameters
startColNumber:`int`	位置(列)
numOfCols:`int`	列数

def clearColOutline(self, outlineLevel: int): ¶

列方向のアウトラインのクリアを行います。

Parameters
outlineLevel:`int`	アウトラインレベル(1～7) 。1は初期状態となります。

def clearRow(self, startRowNumber: int, numOfRows: int): ¶

ワークシート上の行をワークシート初期値に戻します。

Parameters
startRowNumber:`int`	位置(行)
numOfRows:`int`	行数

def clearRowOutline(self, outlineLevel: int): ¶

行方向のアウトラインのクリアを行います。

Parameters
outlineLevel:`int`	アウトラインレベル(1～7) 。1は初期状態となります。

def copyCell(self, copyFromSheetName: str, fromA1C1: str, copyToA1: str, copyType: enums.XlCopyContentType = enums.XlCopyContentType.CopyContentTypeAll): ¶

セル範囲の上書きコピーを行います。

osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

Parameters
copyFromSheetName:`str`	コピー元シート名
fromA1C1:`str`	コピーセル範囲(A1C1)
copyToA1:`str`	現在ワークシートの適用範囲の先頭セル(左上のセル)
copyType:`XlCopyContentType`, optional	コピー対象

def copyCol(self, copyFromSheetName: str, copyFromColNumber: int, numOfCols: int, copyToColNumber: int, copyType: enums.XlCopyContentType = enums.XlCopyContentType.CopyContentTypeAll): ¶

セル範囲の上書きコピーを行います(コピー対象: CopyContentTypeAll)。

osbxlでは、図形(チャート含む)および、ピボットテーブル、queryTable形式のテーブル、データテーブルはコピー対象から外れます。

Parameters
copyFromSheetName:`str`	コピー元シート名
copyFromColNumber:`int`	コピーセル範囲(A1C1)
numOfCols:`int`	コピー列数
copyToColNumber:`int`	現在ワークシートの適用列
copyType:`XlCopyContentType`, optional	コピー対象

def copyRow(self, copyFromSheetName: str, copyFromRowNumber: int, numOfRows: int, copyToRowNumber: int, copyType: enums.XlCopyContentType = enums.XlCopyContentType.CopyContentTypeAll): ¶

行の上書きコピーを行います。

copyTypeを設定しない場合、XlCopyContentType::CopyContentTypeAllとなります。

Parameters
copyFromSheetName:`str`	コピー元シート名
copyFromRowNumber:`int`	コピー元開始行
numOfRows:`int`	コピー行数
copyToRowNumber:`int`	現在ワークシートの適用行
copyType:`XlCopyContentType`, optional	コピー対象

def deleteCell(self, A1C1: str, direction: enums.XlInsertDirection): ¶

ワークシート上のセル範囲の削除を行います。

Parameters
A1C1:`str`	削除セル範囲(A1C1)
direction:`XlInsertDirection`	削除方向(左 or 上) その他の挿入方向(右 or 下)を設定すると、例外が投げられます。

def deleteChartObject(self, arg: int|str): ¶

チャート図形クラスを削除します。

Parameters
arg:`int` or `str`	(int)の場合、チャートインデックスで削除します。チャートインデックス 1から始まります。 (str)の場合、チャート名で削除します。

def deleteCol(self, startColNumber: int, numOfCols: int): ¶

ワークシート上の列の削除を行います。

A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

Parameters
startColNumber:`int`	削除位置(列)
numOfCols:`int`	削除列数

def deleteRow(self, startRowNumber: int, numOfRows: int): ¶

ワークシート上の行の削除を行います。

Parameters
startRowNumber:`int`	削除位置(行)
numOfRows:`int`	削除行数

def getActiveCell(self) -> str: ¶

ワークシートのアクティブな(選択されている)セル範囲の取得を行います。

Returns
`str`	セル範囲(A1C1)

def getAutoFilter(self, A1C1: str, firstRowAsHeader: bool = True) -> AutoFilter: ¶

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

オートフィルターは、シート単位で、１セル範囲となります。

Parameters
A1C1:`str`	セル範囲(A1C1)
firstRowAsHeader:`bool`, optional	true: 先頭行をヘッダとみなす false: ヘッダとみなさない
Returns
`AutoFilter`	オートフィルタークラス

def getCells(self, startRow: int, startCol: int, endRow: Optional[int] = None, endCol: Optional[int] = None) -> Range: ¶

セル範囲クラスを取得します。A1:B2=(startRow=1,startCol=1,endRow=2,endCol=2)です。

endRow,endColを指定すると、複数セルを含んだセル範囲も取得できます。

Parameters
startRow:`int`	先頭行 1から始まります。
startCol:`int`	先頭列 1から始まります。
endRow:`int`, optional	末尾行 1から始まります。
endCol:`int`, optional	末尾列 1から始まります。
Returns
`Range`	セル範囲クラス

def getChartObject(self, arg: int|str) -> chart.ChartObject: ¶

チャート図形クラスを取得します。

Parameters
arg:`int` or `str`	int の場合、オブジェクトインデックスによって取得します。オブジェクトインデックスは、1から始まります。 str の場合、チャート名によって取得します。
Returns
`ChartObject`	チャート図形クラス

def getCol(self, colNum: int) -> Col: ¶

列クラスを取得します。

A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

Parameters
colNum:`int`	列番号
Returns
`Col`	列クラスインスタンス

def getComments(self) -> Comments: ¶

コメント/メモクラスを取得します。

Returns
`Comments`	コメント/メモクラス

def getFormatConditions(self) -> FormatConditions: ¶

条件付き書式クラスを取得します。

Returns
`FormatConditions`	条件付き書式クラスのインスタンス

def getHPageBreaks(self) -> HPageBreaks: ¶

水平方向改行クラスを取得します。

Returns
`HPageBreaks`	水平方向改行クラス

def getHyperLinks(self) -> HyperLinks: ¶

ハイパーリンククラスを取得します。

Returns
`HyperLinks`	ハイパーリンククラス

def getListObjects(self) -> ListObjects: ¶

テーブル取得/生成クラスを取得します。

Returns
`ListObjects`	テーブル取得/生成クラス

def getName(self) -> str: ¶

シート名称の取得を行います。

Returns
`str`	シート名称

def getPageSetupObject(self) -> dto.PageSetupObject: ¶

ワークシートの印刷情報(ページマージン等の情報)を取得します。

Returns
`PageSetupObject`	印刷情報クラスのインスタンス

def getPivotTables(self) -> PivotTables: ¶

PivotTable取得/生成クラスを取得します。

Returns
`PivotTables`	PivotTable取得/生成クラス

def getRange(self, A1C1: str) -> Range: ¶

セル範囲クラスを取得します。

Parameters
A1C1:`str`	セル範囲(A1C1)
Returns
`Range`	セル範囲クラス

def getRow(self, rowNum: int) -> Row: ¶

行クラスを取得します。

Parameters
rowNum:`int`	行番号 1から始まります。
Returns
`Row`	行クラスインスタンス

def getShapes(self) -> Shapes: ¶

図形クラスを取得します。

Returns
`Shapes`	図形クラス

def getSort(self, A1C1: str, firstRowAsHeader: bool = False) -> Sort: ¶

並び替えクラスを取得します。

Parameters
A1C1:`str`	セル範囲(A1C1)
firstRowAsHeader:`bool`, optional	true: 先頭行をヘッダとみなす false: ヘッダとみなさない
Returns
`Sort`	並び替えクラス

def getVPageBreaks(self) -> VPageBreaks: ¶

垂直方向改行クラスを取得します。

Returns
`VPageBreaks`	垂直方向改行クラス

def getWindow(self) -> Window: ¶

外観情報クラスを取得します。

Returns
`Window`	外観情報クラス

def insertCell(self, A1C1: str, direction: enums.XlInsertDirection): ¶

ワークシート上のセル範囲の挿入を行います。

Parameters
A1C1:`str`	挿入セル範囲(A1C1)
direction:`XlInsertDirection`	挿入方向(右 or 下) その他の挿入方向(左 or 上)を設定すると、例外が投げられます。

def insertCol(self, startColNumber: int, numOfCols: int): ¶

ワークシート上の列の挿入を行います。

A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

Parameters
startColNumber:`int`	挿入位置(列)
numOfCols:`int`	挿入列数

def insertRow(self, startRowNumber: int, numOfRows: int): ¶

ワークシート上の行の挿入を行います。

Parameters
startRowNumber:`int`	挿入位置(行)
numOfRows:`int`	挿入行数

def isActive(self) -> bool: ¶

ワークシートがアクティブかどうか(現在のワークシートのタブが起動時の表示項目か)を取得します。

Returns
`bool`	true:アクティブ false:非アクティブ

def setActiveCell(self, A1C1: str): ¶

ワークシートのアクティブな(選択する)セル範囲の設定を行います。

Parameters
A1C1:`str`	セル範囲(A1C1)

def setColOutline(self, startCol: int, endCol: int, outlineLevel: int): ¶

列方向のアウトラインを設定します。

startCol,endColは、A1形式ではなく、数値で関数パラメータを設定します。App#convertToColumnNumber メソッド等で変換可能です。

Parameters
startCol:`int`	開始列
endCol:`int`	終了列
outlineLevel:`int`	アウトラインレベル(1～7) 。1は初期状態となります。

def setFormulaArray(self, formulas: dto.VectorInputFormulaObject): ¶

関数の一括入力を行います。

Parameters
formulas:`VectorInputFormulaObject`	List＜入力する関数オブジェクト＞

def setName(self, name: str): ¶

シート名称の設定を行います。

Parameters
name:`str`	シート名称

def setPageSetupObject(self, pageSetupObject: dto.PageSetupObject): ¶

ワークシートの印刷情報(ページマージン等の情報)を設定します。

Parameters
pageSetupObject:`PageSetupObject`	印刷情報クラス

def setRowOutline(self, startRow: int, endRow: int, outlineLevel: int): ¶

行方向のアウトラインを設定します。

Parameters
startRow:`int`	開始行
endRow:`int`	終了行
outlineLevel:`int`	アウトラインレベル(1～7) 。1は初期状態となります。

def setValueArray(self, values: dto.VectorInputValueObject): ¶

セル値の一括入力を行います。

Parameters
values:`VectorInputValueObject`	List＜入力するセル値オブジェクト＞