DragEventArgs.Effect Свойство

Определение

Получает или задает эффект сброса в операции перетаскивания.Gets or sets the target drop effect in a drag-and-drop operation.

public:
 property System::Windows::Forms::DragDropEffects Effect { System::Windows::Forms::DragDropEffects get(); void set(System::Windows::Forms::DragDropEffects value); };
public System.Windows.Forms.DragDropEffects Effect { get; set; }
member this.Effect : System.Windows.Forms.DragDropEffects with get, set
Public Property Effect As DragDropEffects

Значение свойства

Одно из значений перечисления DragDropEffects.One of the DragDropEffects values.

Примеры

В следующем примере демонстрируется операция перетаскивания между двумя элементами управления ListBox.The following example demonstrates a drag-and-drop operation between two ListBox controls. В примере вызывается метод DoDragDrop, когда начинается действие перетаскивания.The example calls the DoDragDrop method when the drag action starts. Действие перетаскивания начинается, если мышь переместила больше SystemInformation.DragSize из положения мыши во время события MouseDown.The drag action starts if the mouse has moved more than SystemInformation.DragSize from the mouse location during the MouseDown event. Метод IndexFromPoint используется для определения индекса элемента, перетаскиваемого во время события MouseDown.The IndexFromPoint method is used to determine the index of the item to drag during the MouseDown event.

В примере также демонстрируется использование пользовательских курсоров для операции перетаскивания.The example also demonstrates using custom cursors for the drag-and-drop operation. В этом примере предполагается, что два файла курсора, 3dwarro.cur и 3dwno.cur, существуют в каталоге приложения для настраиваемых курсоров перетаскивания и без перетаскивания соответственно.The example assumes that two cursor files, 3dwarro.cur and 3dwno.cur, exist in the application directory, for the custom drag and no-drop cursors, respectively. Пользовательские курсоры будут использоваться, если установлен флажок UseCustomCursorsCheckCheckBox.The custom cursors will be used if the UseCustomCursorsCheckCheckBox is checked. Пользовательские курсоры задаются в обработчике событий GiveFeedback.The custom cursors are set in the GiveFeedback event handler.

Состояние клавиатуры вычисляется в обработчике событий DragOver для правой ListBox, чтобы определить, какая операция перетаскивания будет основываться на состоянии клавиш SHIFT, CTRL, ALT или CTRL + ALT.The keyboard state is evaluated in the DragOver event handler for the right ListBox, to determine what the drag operation will be based upon state of the SHIFT, CTRL, ALT, or CTRL+ALT keys. Расположение в ListBox, где происходит удаление, также определяется во время события DragOver.The location in the ListBox where the drop would occur is also determined during the DragOver event. Если данные для удаления не являются String, DragEventArgs.Effect устанавливается в значение DragDropEffects.None.If the data to drop is not a String, then the DragEventArgs.Effect is set to DragDropEffects.None. Наконец, состояние удаления отображается в LabelDropLocationLabel.Finally, the status of the drop is displayed in the DropLocationLabelLabel.

Данные, которые нужно удалить для правильного ListBox, определяются в обработчике событий DragDrop, а String значение добавляется в соответствующее место ListBox.The data to drop for the right ListBox is determined in the DragDrop event handler and the String value is added at the appropriate place in the ListBox. Если операция перетаскивания выходит за границы формы, операция перетаскивания отменяется в обработчике событий QueryContinueDrag.If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the QueryContinueDrag event handler.

Этот фрагмент кода демонстрирует использование класса DragEventArgs.This code excerpt demonstrates using the DragEventArgs class. Полный пример кода см. в описании метода DoDragDrop.See the DoDragDrop method for the complete code example.

void ListDragTarget_DragOver( Object^ /*sender*/, System::Windows::Forms::DragEventArgs^ e )
{
   // Determine whether string data exists in the drop data. If not, then
   // the drop effect reflects that the drop cannot occur.
   if (  !e->Data->GetDataPresent( System::String::typeid ) )
   {
      e->Effect = DragDropEffects::None;
      DropLocationLabel->Text = "None - no string data.";
      return;
   }

   // Set the effect based upon the KeyState.
   if ( (e->KeyState & (8 + 32)) == (8 + 32) && ((e->AllowedEffect & DragDropEffects::Link) == DragDropEffects::Link) )
   {
      // KeyState 8 + 32 = CTL + ALT
      // Link drag-and-drop effect.
      e->Effect = DragDropEffects::Link;
   }
   else
   if ( (e->KeyState & 32) == 32 && ((e->AllowedEffect & DragDropEffects::Link) == DragDropEffects::Link) )
   {
      // ALT KeyState for link.
      e->Effect = DragDropEffects::Link;
   }
   else
   if ( (e->KeyState & 4) == 4 && ((e->AllowedEffect & DragDropEffects::Move) == DragDropEffects::Move) )
   {
      // SHIFT KeyState for move.
      e->Effect = DragDropEffects::Move;
   }
   else
   if ( (e->KeyState & 8) == 8 && ((e->AllowedEffect & DragDropEffects::Copy) == DragDropEffects::Copy) )
   {
      // CTL KeyState for copy.
      e->Effect = DragDropEffects::Copy;
   }
   else
   if ( (e->AllowedEffect & DragDropEffects::Move) == DragDropEffects::Move )
   {
      // By default, the drop action should be move, if allowed.
      e->Effect = DragDropEffects::Move;
   }
   else
            e->Effect = DragDropEffects::None;





   
   // Get the index of the item the mouse is below.
   // The mouse locations are relative to the screen, so they must be
   // converted to client coordinates.
   indexOfItemUnderMouseToDrop = ListDragTarget->IndexFromPoint( ListDragTarget->PointToClient( Point(e->X,e->Y) ) );
   
   // Updates the label text.
   if ( indexOfItemUnderMouseToDrop != ListBox::NoMatches )
   {
      DropLocationLabel->Text = String::Concat( "Drops before item # ", (indexOfItemUnderMouseToDrop + 1) );
   }
   else
            DropLocationLabel->Text = "Drops at the end.";
}
private void ListDragTarget_DragOver(object sender, System.Windows.Forms.DragEventArgs e) 
{

    // Determine whether string data exists in the drop data. If not, then
    // the drop effect reflects that the drop cannot occur.
    if (!e.Data.GetDataPresent(typeof(System.String))) {

        e.Effect = DragDropEffects.None;
        DropLocationLabel.Text = "None - no string data.";
        return;
    }

    // Set the effect based upon the KeyState.
    if ((e.KeyState & (8+32)) == (8+32) && 
        (e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) {
        // KeyState 8 + 32 = CTL + ALT

        // Link drag-and-drop effect.
        e.Effect = DragDropEffects.Link;
    } else if ((e.KeyState & 32) == 32 && 
        (e.AllowedEffect & DragDropEffects.Link) == DragDropEffects.Link) {

        // ALT KeyState for link.
        e.Effect = DragDropEffects.Link;
    } else if ((e.KeyState & 4) == 4 && 
        (e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move) {

        // SHIFT KeyState for move.
        e.Effect = DragDropEffects.Move;
    } else if ((e.KeyState & 8) == 8 && 
        (e.AllowedEffect & DragDropEffects.Copy) == DragDropEffects.Copy) {

        // CTL KeyState for copy.
        e.Effect = DragDropEffects.Copy;
    } else if ((e.AllowedEffect & DragDropEffects.Move) == DragDropEffects.Move)  {

        // By default, the drop action should be move, if allowed.
        e.Effect = DragDropEffects.Move;
    } else
    {
        e.Effect = DragDropEffects.None;
    }

    // Get the index of the item the mouse is below. 

    // The mouse locations are relative to the screen, so they must be 
    // converted to client coordinates.

    indexOfItemUnderMouseToDrop = 
        ListDragTarget.IndexFromPoint(ListDragTarget.PointToClient(new Point(e.X, e.Y)));

    // Updates the label text.
    if (indexOfItemUnderMouseToDrop != ListBox.NoMatches){

        DropLocationLabel.Text = "Drops before item #" + (indexOfItemUnderMouseToDrop + 1);
    } else
    {
        DropLocationLabel.Text = "Drops at the end.";
    }
}
Private Sub ListDragTarget_DragOver(ByVal sender As Object, ByVal e As DragEventArgs) Handles ListDragTarget.DragOver
    ' Determine whether string data exists in the drop data. If not, then
    ' the drop effect reflects that the drop cannot occur.
    If Not (e.Data.GetDataPresent(GetType(System.String))) Then

        e.Effect = DragDropEffects.None
        DropLocationLabel.Text = "None - no string data."
        Return
    End If

    ' Set the effect based upon the KeyState.
    If ((e.KeyState And (8 + 32)) = (8 + 32) And _
        (e.AllowedEffect And DragDropEffects.Link) = DragDropEffects.Link) Then
        ' KeyState 8 + 32 = CTL + ALT

        ' Link drag-and-drop effect.
        e.Effect = DragDropEffects.Link

    ElseIf ((e.KeyState And 32) = 32 And _
        (e.AllowedEffect And DragDropEffects.Link) = DragDropEffects.Link) Then

        ' ALT KeyState for link.
        e.Effect = DragDropEffects.Link

    ElseIf ((e.KeyState And 4) = 4 And _
        (e.AllowedEffect And DragDropEffects.Move) = DragDropEffects.Move) Then

        ' SHIFT KeyState for move.
        e.Effect = DragDropEffects.Move

    ElseIf ((e.KeyState And 8) = 8 And _
        (e.AllowedEffect And DragDropEffects.Copy) = DragDropEffects.Copy) Then

        ' CTL KeyState for copy.
        e.Effect = DragDropEffects.Copy

    ElseIf ((e.AllowedEffect And DragDropEffects.Move) = DragDropEffects.Move) Then

        ' By default, the drop action should be move, if allowed.
        e.Effect = DragDropEffects.Move

    Else
        e.Effect = DragDropEffects.None
    End If

    ' Gets the index of the item the mouse is below. 

    ' The mouse locations are relative to the screen, so they must be 
    ' converted to client coordinates.

    indexOfItemUnderMouseToDrop = _
        ListDragTarget.IndexFromPoint(ListDragTarget.PointToClient(New Point(e.X, e.Y)))

    ' Updates the label text.
    If (indexOfItemUnderMouseToDrop <> ListBox.NoMatches) Then

        DropLocationLabel.Text = "Drops before item #" & (indexOfItemUnderMouseToDrop + 1)
    Else
        DropLocationLabel.Text = "Drops at the end."
    End If

End Sub

Комментарии

По умолчанию применяемый результат определяет курсор мыши для целевого объекта операции перетаскивания.By default, the effect applied determines the mouse cursor for the target of a drag-and-drop operation. Это полезно для предоставления отзывов пользователю о выполняемой операции.This is useful to provide feedback to the user on the operation that will occur. Например, если нажать клавишу CTRL при перетаскивании файла из источника, укажите DragDropEffects.Copy, чтобы указать целевому объекту, что будет пытаться выполнить операцию копирования.For example, if you press the CTRL key when you drag a file from a source, specify DragDropEffects.Copy to indicate the target will try to perform a copy operation.

Сведения об использовании пользовательских курсоров для операции перетаскивания см. в разделе GiveFeedbackEventArgs.UseDefaultCursors.To use custom cursors for a drag operation, see GiveFeedbackEventArgs.UseDefaultCursors.

Применяется к

Дополнительно