SSpread.BeforeUserSortイベント

データの並べ替えをするときに発生します。

※このイベント発生時には並べ替えは完了していません。並べ替え完了後を想定した処理を行う場合AfterUserSortイベントを使用してください。

具体的には、以下の操作時にイベントが発生します。

・ユーザーが列ヘッダをクリック

・ColUserSortIndicatorプロパティに$ColUserSortIndicatorAscending（並べ替え／昇順）、$ColUserSortIndicatorDescending（並べ替え／降順）を設定

・UserColActionプロパティに$UserColActionSort（並べ替え／インジケータ表示）、$UserColActionSortNoIndicator（並べ替え／インジケータ非表示）を設定

Eventオブジェクトには以下の子オブジェクトが付加されています。

型

名前

説明

Number

Col

並べ替えを行う列の列番号

Number

State

直前に実行された並べ替えの種類

以下の値が設定されます。

定数	値	説明
$BeforeUserSortStateNone	0	並べ替えなし
$BeforeUserSortStateAcending	1	昇順の並べ替え
$BeforeUserSortStateDescending	2	降順の並べ替え

使用例

Function OnBeforeUserSort(e) {

    var sortDescription;

    switch (e.State){

        case $BeforeUserSortStateNone:

            sortDescription = "並べ替えされていませんでした";

            break;

        case $BeforeUserSortStateAcending:

            sortDescription = "昇順の並べ替えをされていました";

            break;

        case $BeforeUserSortStateDescending:

            sortDescription = "降順の並べ替えをされていました";

            break;

    MessageBox(str(e.Col) + "列目は" + sortDescription);