Class Sort

ワークシートのセル範囲の並び替えを扱うクラスです。

ワークシート、テーブル、オートフィルターから呼ばれます。

Index

Methods

execute executeMultiple executeSortAscending executeSortDescending getSortConditions resetAllSort resetSort

Methods

execute

execute(sortFieldObject): void
入力された並び替え条件に基づき、並び替えの実行を行います。
Parameters
- sortFieldObject: SortFieldObject
  SortFieldObject 並び替え条件オブジェクト
Returns void

executeMultiple

executeMultiple(sortFieldObjects): void
入力された並び替え条件群に基づき、並び替えの実行を行います。
Parameters
- sortFieldObjects: SortFieldObject[]
  Array<並び替え条件オブジェクト>
Returns void

executeSortAscending

executeSortAscending(target, direction?, matchCase?): void
並び替えの実行(昇順)を行います。
Parameters
- target: number
  並び替え対象の列数。先頭(行/列)=1です。
- direction: XlRowCol = enums.XlRowCol.Rows
  enums.XlRowCol.Rows: 行方向 enums.XlRowCol.Cols: 列方向オートフィルターまたはテーブルから呼ばれた際は、行方向のみとなります。
- matchCase: boolean = false
  true: 大文字小文字を考慮 false: 大文字小文字を無視
Returns void

executeSortDescending

executeSortDescending(target, direction?, matchCase?): void
並び替えの実行(降順)を行います。
Parameters
- target: number
  並び替え対象の列数。先頭(行/列)=1です。
- direction: XlRowCol = enums.XlRowCol.Rows
  enums.XlRowCol.Rows: 行方向 enums.XlRowCol.Cols: 列方向オートフィルターまたはテーブルから呼ばれた際は、行方向のみとなります。
- matchCase: boolean = false
  true: 大文字小文字を考慮 false: 大文字小文字を無視
Returns void

getSortConditions

getSortConditions(): SortFieldObject[]
設定されている並び替え条件を取得します。

Returns SortFieldObject[]
Array<並び替え条件オブジェクト> 並び替え条件オブジェクト群

resetAllSort

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

resetSort

resetSort(target): void
並び替え条件をクリアします。
1. オートフィルターとテーブルから並び替えオブジェクトが取得された時に有効です。
Parameters
- target: number
  並び替え対象の列数。先頭(行/列)=1です。
Returns void

Copyright © 2023. OSB-OFFICE.Inc, All rights reserved. Generated using TypeDoc