SheetDragMoving イベント

ユーザーがシート名タブをドラッグしてシートを移動するときに発生します。

構文

Visual Basic
C#

public event SheetDragMovingEventHandler SheetDragMoving

'Declaration
 
Public Event SheetDragMoving As SheetDragMovingEventHandler

'使用法
 
Dim instance As FpSpread
Dim handler As SheetDragMovingEventHandler
 
AddHandler instance.SheetDragMoving, handler

イベントデータ

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

プロパティ	説明
Cancel	シートのドラッグ移動アクションをキャンセルするかどうかを取得または設定します。
Restrict	シートのToSheetIndex位置への移動を許可するかどうかを取得または設定します。
SheetIndex	移動するシートのインデックスを取得します。
ToSheetIndex	シートが移動される新しい位置を取得します。

解説

タブストリップ上のシートタブを選択し、別のタブにドラッグしてマウスを離すと、選択したシートが元のインデックスから新しいインデックスに移動します。ユーザーがシートタブ名のドラッグを開始すると、SheetDragMovingイベントが発生します。ユーザーがシートの移動を完了すると、その直後にSheetDragMovedイベントが発生します。Cancelプロパティをtrueに設定することで、特定のシートが移動されないようにすることができます。

このイベントは、ユーザーがマウスを使用してシートを移動するときにのみ発生します。

例

次のサンプルコードは、シート3の位置にシートが移動されないようにします。

C#
Visual Basic

private void fpSpread1_SheetDragMoving(object sender, FarPoint.Win.Spread.SheetDragMovingEventArgs e)
        {
            if (e.ToSheetIndex == 3)
            {
                e.Cancel = true;
                //or e.Restrict = true;
            }
        }

        private void fpSpread1_SheetDragMoved(object sender, FarPoint.Win.Spread.SheetDragMovedEventArgs e)
        {
            listBox1.Items.Add("previous " + e.OldSheetIndex);
            listBox1.Items.Add("new " + e.NewSheetIndex);
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            fpSpread1.Sheets.Count = 5;
            fpSpread1.AllowSheetMove = true;
        }

Private Sub FpSpread1_SheetDragMoved(sender As Object, e As FarPoint.Win.Spread.SheetDragMovedEventArgs) Handles FpSpread1.SheetDragMoved
        ListBox1.Items.Add("previous " & e.OldSheetIndex)
        ListBox1.Items.Add("new " & e.NewSheetIndex)
    End Sub

    Private Sub FpSpread1_SheetDragMoving(sender As Object, e As FarPoint.Win.Spread.SheetDragMovingEventArgs) Handles FpSpread1.SheetDragMoving
        If e.ToSheetIndex = 3 Then
            e.Cancel = True
           'or e.Restrict = True
        End If
    End Sub

    Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
        FpSpread1.Sheets.Count = 5
        FpSpread1.AllowSheetMove = True
    End Sub

参照

FpSpread クラス
 FpSpread メンバ