SortColumnCommand イベント

ユーザーが列をソートしたときに発生します。

構文

Visual Basic
C#

'Declaration
 
Public Event SortColumnCommand As SpreadCommandEventHandler

public event SpreadCommandEventHandler SortColumnCommand

イベントデータ

イベントハンドラが、このイベントに関連するデータを含む、SpreadCommandEventArgs 型の引数を受け取りました。次の SpreadCommandEventArgs プロパティには、このイベントの固有の情報が記載されます。

プロパティ	説明
CommandArgument	System.Web.UI.WebControls.CommandEventArgsから継承されます。
CommandName	System.Web.UI.WebControls.CommandEventArgsから継承されます。
EditValues	値の配列リスト内のポストバックデータを取得します。
Handled	イベントが処理済みであるかどうかを表すブール値を取得または設定します。
SheetView	更新されたシートを取得します。
SortFrozenRows	ソートコマンドが実行されたときに固定行をソートするかどうかを取得または設定します。

解説

このイベントが発生するには、SheetView AllowSortプロパティがTrueに設定されている必要があります。SheetView.AllowSortプロパティがTrueに設定されている場合、ユーザーは列ヘッダのセルをダブルクリックすれば列の内容をソートできます。列ヘッダに複数の行が含まれている場合は、ソートする列の列ヘッダのセルをダブルクリックするとソートが発生します。

SpreadCommandEventHandlerは、このイベントに関連するデータを含むSpreadCommandEventArgsタイプの引数を受け取ります。

例

この例では、このイベントの使い方を示します。

C#
Visual Basic

FarPoint.Web.Spread.Column col;
col = FpSpread1.ActiveSheetView.Columns[1];
FpSpread1.ActiveSheetView.Cells[0, 1].Text = "Alignment";
FpSpread1.ActiveSheetView.Cells[1, 1].Text = "CarbAdjust";
FpSpread1.ActiveSheetView.Cells[2, 1].Text = "Brakes";
col.SortIndicator = FarPoint.Web.Spread.Model.SortIndicator.Descending;
FpSpread1.ActiveSheetView.AllowSort = true;

private void FpSpread1SortColumnCommand(object sender, FarPoint.Web.Spread.SpreadCommandEventArgs e) 
{
    TextBox1.Text = "The column sorted was column #" + e.CommandArgument;
}

Dim col As FarPoint.Web.Spread.Column
col = FpSpread1.ActiveSheetView.Columns(1)
FpSpread1.ActiveSheetView.Cells(0, 1).Text = "Alignment"
FpSpread1.ActiveSheetView.Cells(1, 1).Text = "CarbAdjust"
FpSpread1.ActiveSheetView.Cells(2, 1).Text = "Brakes"
col.SortIndicator = FarPoint.Web.Spread.Model.SortIndicator.Descending
FpSpread1.ActiveSheetView.AllowSort = True

Private Sub FpSpread1SortColumnCommand(ByVal sender As Object, ByVal e As FarPoint.Web.Spread.SpreadCommandEventArgs) Handles
FpSpread1.SortColumnCommand
    TextBox1.Text = "The column sorted was column #" & e.CommandArgument
End Sub

参照

FpSpread クラス
 FpSpread メンバ