pyosbxl.Sort

class documentation

class Sort:

View In Hierarchy

ワークシートのセル範囲の並び替えを扱うクラスです。ワークシート、テーブル、オートフィルターから呼ばれます。

Method execute 入力された並び替え条件に基づき、並び替えの実行を行います。
Method executeMultiple 入力された並び替え条件群に基づき、並び替えの実行を行います。
Method executeSortAscending 並び替えの実行(昇順)を行います。
Method executeSortDescending 並び替えの実行(降順)を行います。
Method getSortConditions 設定されている並び替え条件を取得します。
Method resetAllSort 並び替え条件を全クリアします。オートフィルターとテーブルから並び替えオブジェクトが取得された時に有効です。
Method resetSort 並び替え条件をクリアします。オートフィルターとテーブルから並び替えオブジェクトが取得された時に有効です。
def execute(self, sortFieldObject: dto.SortFieldObject):

入力された並び替え条件に基づき、並び替えの実行を行います。

Parameters
sortFieldObject:SortFieldObject並び替え条件オブジェクト
def executeMultiple(self, sortFieldObjects: dto.VectorSortFieldObject):

入力された並び替え条件群に基づき、並び替えの実行を行います。

Parameters
sortFieldObjects:VectorSortFieldObjectList＜並び替え条件オブジェクト＞
def executeSortAscending(self, target: int, direction: enums.XlRowCol = enums.XlRowCol.Rows, matchCase: bool = False):

並び替えの実行(昇順)を行います。

Parameters
target:int並び替え対象の列数。先頭(行/列)=1です。
direction:XlRowCol, optionalXlRowCol.Rows: 行方向 XlRowCol.Cols: 列方向 オートフィルターまたはテーブルから呼ばれた際は、行方向のみとなります。
matchCase:bool, optionaltrueの時、大文字小文字を考慮し、falseの時は、大文字小文字を無視します。
def executeSortDescending(self, target: int, direction: enums.XlRowCol = enums.XlRowCol.Rows, matchCase: bool = False):

並び替えの実行(降順)を行います。

Parameters
target:int並び替え対象の列数。先頭(行/列)=1です。
direction:XlRowCol, optionalXlRowCol.Rows: 行方向 XlRowCol.Cols: 列方向 オートフィルターまたはテーブルから呼ばれた際は、行方向のみとなります。
matchCase:bool, optionaltrue: 大文字小文字を考慮 false: 大文字小文字を無視
def getSortConditions(self) -> dto.VectorSortFieldObject:

設定されている並び替え条件を取得します。

Returns
VectorSortFieldObjectList＜並び替え条件オブジェクト＞
def resetAllSort(self):

並び替え条件を全クリアします。オートフィルターとテーブルから並び替えオブジェクトが取得された時に有効です。

def resetSort(self, target: int):

並び替え条件をクリアします。オートフィルターとテーブルから並び替えオブジェクトが取得された時に有効です。

Parameters
target:int並び替え対象の列数。先頭(行/列)=1です。