pyosbxl.dto.SortFieldObject

class documentation

class SortFieldObject:

Constructor: SortFieldObject()

View In Hierarchy

セルの並び替えオブジェクト。通常のワークシートの他、オートフィルター、テーブルから使用できます。

Method __init__ コンストラクタ。インスタンスを作成します。
Method getCellColor 並び替え条件のセルのフィルオブジェクトを取得します。
Method getDirection 並び替えの向きを取得します。テーブルでは、行方向のみとなります。
Method getFontColor 並び替え条件のセルのフォント色オブジェクトを取得します。
Method getIconId アイコンセットによる並び替えを行う時、対象のアイコンセットの中のアイコンIDを取得します。
Method getIconSet アイコンセットによる並び替えを行う時、対象のアイコンセットを取得します。
Method getMatchCase アルファベットの大文字小文字を無視するかどうかを取得します。
Method getSortAscending 昇順の並び替えかえを行うか降順の並び替えを行うかを取得します。
Method getSortOn 並び替えのキーとなる対象を取得します。
Method getTarget 対象が何列目かを取得します。
Method getTargetA1 並び替えがフォント色またはセルの背景の時に使用するキーとなる色をもつセルを取得します。
Method setCellColor 並び替え条件のセルに塗りつぶしオブジェクトを適用します。
Method setDirection 並び替えの向きを設定します。
Method setFontColor 並び替え条件のセルのフォントに色オブジェクトを適用します。
Method setMatchCase アルファベットの大文字小文字を無視するかどうかを設定します。
Method setSortOnCellColor セルの背景色による並び替えを設定します。
Method setSortOnFontColor フォント色による並び替えを設定します。
Method setSortOnIcon アイコンによる並び替えを設定します。
Method setSortOnValues セル値による並び替えを設定します。
def __init__(self):

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

def getCellColor(self) -> FillObject:

並び替え条件のセルのフィルオブジェクトを取得します。

Returns
FillObjectフィルオブジェクト
def getDirection(self) -> enums.XlRowCol:

並び替えの向きを取得します。テーブルでは、行方向のみとなります。

Returns
XlRowCol並び替えの向き
def getFontColor(self) -> ColorObject:

並び替え条件のセルのフォント色オブジェクトを取得します。

Returns
ColorObjectフォント色オブジェクト
def getIconId(self) -> int:

アイコンセットによる並び替えを行う時、対象のアイコンセットの中のアイコンIDを取得します。

Returns
intアイコンセットの中のアイコンID 先頭アイコンは、1となります。
def getIconSet(self) -> enums.XlFilterIconSet:

アイコンセットによる並び替えを行う時、対象のアイコンセットを取得します。

Returns
XlFilterIconSetアイコンセット
def getMatchCase(self) -> bool:

アルファベットの大文字小文字を無視するかどうかを取得します。

Returns
booltrue:無視する false:無視しない
def getSortAscending(self) -> bool:

昇順の並び替えかえを行うか降順の並び替えを行うかを取得します。

Returns
booltrue: 昇順 false: 降順
def getSortOn(self) -> enums.XlSortOn:

並び替えのキーとなる対象を取得します。

Returns
XlSortOn並び替えのキー
def getTarget(self) -> int:

対象が何列目かを取得します。

Returns
int列数(先頭=1列目)
def getTargetA1(self) -> str:

並び替えがフォント色またはセルの背景の時に使用するキーとなる色をもつセルを取得します。

Returns
strセル単一範囲(A1) 空文字は、自動を意味します。
def setCellColor(self, cellColor: FillObject):

並び替え条件のセルに塗りつぶしオブジェクトを適用します。

Parameters
cellColor:FillObject塗りつぶしオブジェクト
def setDirection(self, direction: enums.XlRowCol):

並び替えの向きを設定します。

Parameters
direction:XlRowColテーブルでは、行方向のみとなります。
def setFontColor(self, fontColor: ColorObject):

並び替え条件のセルのフォントに色オブジェクトを適用します。

Parameters
fontColor:ColorObjectフォント色オブジェクト
def setMatchCase(self, matchCase: bool):

アルファベットの大文字小文字を無視するかどうかを設定します。

Parameters
matchCase:booltrue:無視する false:無視しない
def setSortOnCellColor(self, target: int, A1: str, asceding: bool):

セルの背景色による並び替えを設定します。

Parameters
target:int何列目を並び替えるか 先頭列=1となります。
A1:strキーとなる色をもつセルを取得します。空文字の場合、自動となります。
asceding:booltrue:昇順 false:降順
def setSortOnFontColor(self, target: int, A1: str, asceding: bool):

フォント色による並び替えを設定します。

Parameters
target:int何列目を並び替えるか 先頭列=1となります。
A1:strキーとなる色をもつセルを取得します。空文字の場合、自動となります。
asceding:booltrue:昇順 false:降順
def setSortOnIcon(self, target: int, iconSet: enums.XlFilterIconSet, iconId: int, asceding: bool):

アイコンによる並び替えを設定します。

Parameters
target:int何列目を並び替えるか 先頭列=1となります。
iconSet:XlFilterIconSet対象アイコンセットを設定します。
iconId:int対象アイコンセットのうちの何番目のアイコンを並び替えるか設定します（先頭=1となります)
asceding:booltrue:昇順 false:降順
def setSortOnValues(self, target: int, asceding: bool):

セル値による並び替えを設定します。

Parameters
target:int何列目を並び替えるか 先頭列=1となります。
asceding:booltrue:昇順 false:降順