pyosbxl.dto.BordersObject

class documentation

class BordersObject:

Constructor: BordersObject()

View In Hierarchy

枠線の書式を一括して取り扱うオブジェクトです。条件付き書式、カスタムセルスタイルは、外枠のみ設定可能です。

Method __init__ コンストラクタ。インスタンスを作成します。
Method clearBorder 特定の枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。
Method clearBorders 全枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。
Method getBorder 個別の枠線種類の設定情報を取得します。
Method getBorders 全枠線種類の設定情報を一括して取得します（ユーザー設定していない枠線情報も取得されます）。
Method setBorder 特定の枠線種類の枠線オブジェクトを適用します。
Method setBorders 全枠線種類の設定情報を一括して適用します。
Method setOuterLineStyles 外枠の枠線種類のオブジェクトに対して、一括して枠線スタイルを設定します。
def __init__(self):

コンストラクタ。インスタンスを作成します。

def clearBorder(self, borderindex: enums.XlBordersIndex):

特定の枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。

Parameters
borderindex:XlBordersIndex枠線種類
def clearBorders(self):

全枠線種類の枠線オブジェクトをクリアします(ワークシートの初期状態に戻します)。

def getBorder(self, borderindex: enums.XlBordersIndex) -> BorderObject:

個別の枠線種類の設定情報を取得します。

Parameters
borderindex:XlBordersIndex枠線種類
Returns
BorderObject枠線書式オブジェクト
def getBorders(self) -> VectorBorderObject:

全枠線種類の設定情報を一括して取得します（ユーザー設定していない枠線情報も取得されます）。

Returns
VectorBorderObjectList＜枠線書式オブジェクト＞
def setBorder(self, border: BorderObject):

特定の枠線種類の枠線オブジェクトを適用します。

Parameters
border:BorderObject枠線オブジェクト
def setBorders(self, borders: VectorBorderObject):

全枠線種類の設定情報を一括して適用します。

Parameters
borders:VectorBorderObjectList＜枠線書式オブジェクト＞
def setOuterLineStyles(self, linestyle: enums.XlLineStyleBorderWeight, colorObject: Optional[ColorObject] = None):

外枠の枠線種類のオブジェクトに対して、一括して枠線スタイルを設定します。

colorObjectを設定した場合、外枠の枠線種類のオブジェクトに対して、一括して枠線スタイルと色オブジェクトを設定します。

Parameters
linestyle:XlLineStyleBorderWeight枠線スタイル
colorObject:ColorObject, optional色オブジェクト