DragEventArgs.Effect Propriété

Définition

Obtient ou définit l’effet provoqué sur la cible par l’opération de dépôt dans une opération de glisser-déposer.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

Valeur de propriété

Une des valeurs de DragDropEffects.One of the DragDropEffects values.

Exemples

L’exemple suivant illustre une opération de glisser-déplacer entre deux ListBox contrôles.The following example demonstrates a drag-and-drop operation between two ListBox controls. L’exemple appelle la DoDragDrop méthode au démarrage de l’action glisser.The example calls the DoDragDrop method when the drag action starts. L’action glisser démarre si la souris a été déplacée SystemInformation.DragSize au-delà de l’emplacement de la souris pendant l' MouseDown événement.The drag action starts if the mouse has moved more than SystemInformation.DragSize from the mouse location during the MouseDown event. La IndexFromPoint méthode est utilisée pour déterminer l’index de l’élément à faire glisser pendant MouseDown l’événement.The IndexFromPoint method is used to determine the index of the item to drag during the MouseDown event.

L’exemple illustre également l’utilisation de curseurs personnalisés pour l’opération de glisser-déplacer.The example also demonstrates using custom cursors for the drag-and-drop operation. L’exemple suppose que deux fichiers curseur, 3dwarro.cur et 3dwno.cur, existent dans le répertoire de l’application, respectivement pour les curseurs de glisser-déplacer personnalisés.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. Les curseurs personnalisés sont utilisés si le UseCustomCursorsCheck CheckBox est activé.The custom cursors will be used if the UseCustomCursorsCheckCheckBox is checked. Les curseurs personnalisés sont définis dans le GiveFeedback gestionnaire d’événements.The custom cursors are set in the GiveFeedback event handler.

L’état du clavier est évalué dans DragOver le gestionnaire d’événements pour ListBoxle droit, afin de déterminer l’opération de glissement basée sur l’état des touches Maj, CTRL, ALT ou 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. L’emplacement ListBox où la suppression se produit est également déterminé au cours de l' DragOver événement.The location in the ListBox where the drop would occur is also determined during the DragOver event. Si les données à supprimer ne sont pas Stringun, le DragEventArgs.Effect a la valeur DragDropEffects.None.If the data to drop is not a String, then the DragEventArgs.Effect is set to DragDropEffects.None. Enfin, l’état de l’instruction DROP est affiché dans DropLocationLabella Label.Finally, the status of the drop is displayed in the DropLocationLabelLabel.

Les données à supprimer pour le droit ListBox sont déterminées DragDrop dans le gestionnaire d' String événements et la valeur est ajoutée à l’emplacement ListBoxapproprié dans le.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. Si l’opération glisser est déplacée en dehors des limites du formulaire, l’opération de glisser-déplacer est annulée dans le QueryContinueDrag gestionnaire d’événements.If the drag operation moves outside the bounds of the form, then the drag-and-drop operation is canceled in the QueryContinueDrag event handler.

Cet extrait de code illustre l' DragEventArgs utilisation de la classe.This code excerpt demonstrates using the DragEventArgs class. Consultez la DoDragDrop méthode pour obtenir l’exemple de code complet.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

Remarques

Par défaut, l’effet appliqué détermine le curseur de la souris pour la cible d’une opération de glisser-déplacer.By default, the effect applied determines the mouse cursor for the target of a drag-and-drop operation. Cela est utile pour fournir des commentaires à l’utilisateur sur l’opération qui se produit.This is useful to provide feedback to the user on the operation that will occur. Par exemple, si vous appuyez sur la touche Ctrl lorsque vous faites glisser un fichier à partir d' DragDropEffects.Copy une source, spécifiez pour indiquer que la cible essaiera d’effectuer une opération de copie.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.

Pour utiliser des curseurs personnalisés pour une opération glisser, GiveFeedbackEventArgs.UseDefaultCursorsconsultez.To use custom cursors for a drag operation, see GiveFeedbackEventArgs.UseDefaultCursors.

S’applique à

Voir aussi