class documentation

class Border:

View In Hierarchy

個別の枠線を扱うクラスです。枠線書式(一括)クラスにて枠線種類をパラメータとして与え、取得します。

Method clearBorder セル範囲に対し、該当する枠線をワークシート初期値に戻します。
Method getBorderObject セル範囲の全ての該当する枠線オブジェクトを取得します。
Method getColor 枠線の色オブジェクトを取得します。
Method getColorObject セル範囲の全ての該当する枠線の色オブジェクトを取得します。
Method getLineStyleBorderWeight セル範囲の該当する枠線の線スタイルを取得します。
Method setBorderObject セル範囲に対し、該当する枠線オブジェクトを設定します。
Method setLineStyle セル範囲に対し、該当する枠線の線スタイルと(設定された場合)枠線の色オブジェクトを設定します。
def clearBorder(self):

セル範囲に対し、該当する枠線をワークシート初期値に戻します。

def getBorderObject(self) -> dto.MapStringBorderObject:

セル範囲の全ての該当する枠線オブジェクトを取得します。

Returns
MapStringBorderObjectMap<セル範囲(A1), 枠線の書式オブジェクト>
def getColor(self) -> Color:

枠線の色オブジェクトを取得します。

Returns
Color枠線の色オブジェクト
def getColorObject(self) -> dto.MapStringColorObject:

セル範囲の全ての該当する枠線の色オブジェクトを取得します。

Returns
MapStringColorObjectMap<セル範囲(A1), 枠線の色オブジェクト>
def getLineStyleBorderWeight(self) -> dto.MapStringXlLineStyleBorderWeight:

セル範囲の該当する枠線の線スタイルを取得します。

Returns
MapStringXlLineStyleBorderWeightMap<セル範囲(A1), 枠線の線スタイル>
def setBorderObject(self, borderObject: dto.BorderObject):

セル範囲に対し、該当する枠線オブジェクトを設定します。

Parameters
borderObject:BorderObject枠線の書式オブジェクト
def setLineStyle(self, lineStyleWeight: enums.XlLineStyleBorderWeight, colorObject: Optional[dto.ColorObject] = None):

セル範囲に対し、該当する枠線の線スタイルと(設定された場合)枠線の色オブジェクトを設定します。

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