DragEventArgs.Effect Propiedad

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Source:

DragEventArgs.cs

Obtiene o establece el efecto de colocación de destino en una operación de arrastrar y colocar.

C#

public System.Windows.Forms.DragDropEffects Effect { get; set; }

Valor de propiedad

DragDropEffects

Uno de los valores de DragDropEffects.

Ejemplos

En el ejemplo siguiente se muestra una operación de arrastrar y colocar entre dos controles ListBox. En el ejemplo se llama al método DoDragDrop cuando se inicia la acción de arrastrar. La acción de arrastrar se inicia si el mouse se ha movido más de SystemInformation.DragSize desde la ubicación del mouse durante el evento MouseDown. El método IndexFromPoint se usa para determinar el índice del elemento que se va a arrastrar durante el evento MouseDown.

En el ejemplo también se muestra el uso de cursores personalizados para la operación de arrastrar y colocar. En el ejemplo se supone que existen dos archivos de cursor, 3dwarro.cur y 3dwno.cur, en el directorio de la aplicación, para los cursores de arrastrar y sin colocar personalizados, respectivamente. Los cursores personalizados se usarán si se comprueba el UseCustomCursorsCheckCheckBox. Los cursores personalizados se establecen en el controlador de eventos GiveFeedback.

El estado del teclado se evalúa en el controlador de eventos DragOver de la derecha ListBox, para determinar cuál será la operación de arrastre en función del estado de las teclas MAYÚS, CTRL, ALT o CTRL+ALT. La ubicación del ListBox donde se produciría la eliminación también se determina durante el evento DragOver. Si los datos que se van a quitar no son String, el DragEventArgs.Effect se establece en DragDropEffects.None. Por último, el estado de la colocación se muestra en el DropLocationLabelLabel.

Los datos que se van a quitar de la ListBox derecha se determinan en el controlador de eventos DragDrop y el valor de String se agrega en el lugar adecuado de la ListBox. Si la operación de arrastre se mueve fuera de los límites del formulario, la operación de arrastrar y colocar se cancela en el controlador de eventos QueryContinueDrag.

Este fragmento de código muestra el uso de la clase DragEventArgs. Consulte el método DoDragDrop para obtener el ejemplo de código completo.

C#

private void ListDragTarget_DragOver(object sender, 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 = CTRL + 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)
    {
        // CTRL 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.";
    }
}

Comentarios

De forma predeterminada, el efecto aplicado determina el cursor del mouse para el destino de una operación de arrastrar y colocar. Esto resulta útil para proporcionar comentarios al usuario sobre la operación que se producirá. Por ejemplo, si presiona la tecla CTRL al arrastrar un archivo desde un origen, especifique DragDropEffects.Copy para indicar que el destino intentará realizar una operación de copia.

Para usar cursores personalizados para una operación de arrastre, consulte GiveFeedbackEventArgs.UseDefaultCursors.

Se aplica a

Consulte también

• DragDropEffects