Пошаговое руководство. Выполнение операции перетаскивания в Windows Forms Walkthrough: Performing a Drag-and-Drop Operation in Windows Forms

Для выполнения операций перетаскивания в приложениях на основе Windows необходимо выполнить обработку ряда событий, особенно DragEnter DragLeave событий, и DragDrop . To perform drag-and-drop operations within Windows-based applications you must handle a series of events, most notably the DragEnter, DragLeave, and DragDrop events. Работая со сведениями, доступными через аргументы этих событий, можно значительно упростить операции перетаскивания. By working with the information available in the event arguments of these events, you can easily facilitate drag-and-drop operations.

Перетаскивание данных Dragging Data

Все операции перетаскивания начинаются с переноса данных. All drag-and-drop operations begin with dragging. Функция, позволяющая собирать данные при начале перетаскивания, реализуется в DoDragDrop методе. The functionality to enable data to be collected when dragging begins is implemented in the DoDragDrop method.

В следующем примере MouseDown событие используется для запуска операции перетаскивания, поскольку она является наиболее интуитивно понятной (большинство действий по перетаскиванию начинается с нажатия кнопки мыши). In the following example, the MouseDown event is used to start the drag operation because it is the most intuitive (most drag-and-drop actions begin with the mouse button being depressed). Однако не забывайте, что любое событие может использоваться для инициализации процедуры перетаскивания. However, remember that any event could be used to initiate a drag-and-drop procedure.

Некоторые элементы управления имеют собственные события перетаскивания. Certain controls have custom drag-specific events. ListView TreeView Для элементов управления и, например, имеется ItemDrag событие. The ListView and TreeView controls, for example, have an ItemDrag event.

Начало операции перетаскивания To start a drag operation

В MouseDown событии для элемента управления, в котором начнется перетаскивание, используйте DoDragDrop метод, чтобы задать перетаскиваемые данные и разрешить перетаскивание разрешенных эффектов. In the MouseDown event for the control where the drag will begin, use the DoDragDrop method to set the data to be dragged and the allowed effect dragging will have. Дополнительные сведения см. в разделах Data и AllowedEffect. For more information, see Data and AllowedEffect.

В следующем примере показан запуск операции перетаскивания. The following example shows how to initiate a drag operation. Элемент управления, в котором начинается перетаскивание Button , является элементом управления, перетаскиваемые данные — это строка, представляющая Text свойство Button элемента управления, и разрешенные эффекты можно копировать или перемещать. The control where the drag begins is a Button control, the data being dragged is the string representing the Text property of the Button control, and the allowed effects are either copying or moving.

В качестве параметра в методе можно использовать любые данные DoDragDrop . в приведенном выше примере Text Button используется свойство элемента управления (вместо жесткого кодирования значения или извлечения данных из набора данных), поскольку свойство было связано с расположением, которое перетаскивается из ( Button элемент управления). Any data can be used as a parameter in the DoDragDrop method; in the example above, the Text property of the Button control was used (rather than hard-coding a value or retrieving data from a dataset) because the property was related to the location being dragged from (the Button control). Учитывайте это при реализации операций перетаскивания в приложениях Windows. Keep this in mind as you incorporate drag-and-drop operations into your Windows-based applications.

Пока действует операция перетаскивания, можно выполнить обработку QueryContinueDrag события, которое «запрашивает разрешение» системы, чтобы продолжить операцию перетаскивания. While a drag operation is in effect, you can handle the QueryContinueDrag event, which «asks permission» of the system to continue the drag operation. При обработке этого метода также является подходящая точка для вызова методов, которые влияют на операцию перетаскивания, например, расширение объекта TreeNode в TreeView элементе управления при наведении курсора мыши на него. When handling this method, it is also the appropriate point for you to call methods that will have an effect on the drag operation, such as expanding a TreeNode in a TreeView control when the cursor hovers over it.

Завершение перетаскивания данных Dropping Data

После начала перетаскивания данных из расположения в форме Windows Forms или элементе управления их требуется куда-то поместить. Once you have begun dragging data from a location on a Windows Form or control, you will naturally want to drop it somewhere. При попадании курсора в область формы или элемента управления, которые правильно настроены для размещения данных, вид курсора изменится. The cursor will change when it crosses an area of a form or control that is correctly configured for dropping data. Любая область внутри формы или элемента управления Windows может быть сделана для приема пропущенных данных путем установки AllowDrop Свойства и обработки DragEnter DragDrop событий и. Any area within a Windows Form or control can be made to accept dropped data by setting the AllowDrop property and handling the DragEnter and DragDrop events.

Завершение операции перетаскивания To perform a drop

Присвойте AllowDrop свойству значение true. Set the AllowDrop property to true.

В DragEnter событии для элемента управления, в котором будет выполняться перетаскивание, убедитесь, что перетаскиваемые данные имеют допустимый тип (в данном случае Text ). In the DragEnter event for the control where the drop will occur, ensure that the data being dragged is of an acceptable type (in this case, Text). Затем код задает результат, который будет выполняться при выполнении перетаскивания в значение в DragDropEffects перечислении. The code then sets the effect that will happen when the drop occurs to a value in the DragDropEffects enumeration. Для получения дополнительной информации см. Effect. For more information, see Effect.

Вы можете определить собственное DataFormats , указав собственный объект в качестве Object параметра SetData метода. You can define your own DataFormats by specifying your own object as the Object parameter of the SetData method. При этом необходимо убедиться, что указанный объект является сериализуемым. Be sure, when doing this, that the object specified is serializable. Для получения дополнительной информации см. ISerializable. For more information, see ISerializable.

В DragDrop событии для элемента управления, в котором будет выполняться удаление, используйте GetData метод для получения перетаскиваемых данных. In the DragDrop event for the control where the drop will occur, use the GetData method to retrieve the data being dragged. Для получения дополнительной информации см. Data. For more information, see Data.

В приведенном ниже примере элемент TextBox управления — это элемент управления, к которому выполняется перетаскивание (где произойдет удаление). In the example below, a TextBox control is the control being dragged to (where the drop will occur). Код задает Text свойство TextBox элемента управления, равное перетаскиваемых данным. The code sets the Text property of the TextBox control equal to the data being dragged.

Кроме того, можно работать со KeyState свойством, чтобы, в зависимости от нажатых клавиш во время операции перетаскивания, были выполнены определенные эффекты (например, для копирования перетаскиваемых данных при нажатии клавиши CTRL). Additionally, you can work with the KeyState property, so that, depending on keys depressed during the drag-and-drop operation, certain effects occur (for example, it is standard to copy the dragged data when the CTRL key is pressed).

Control. Drag Drop Событие

Определение

Вызывается при завершении операции перетаскивания. Occurs when a drag-and-drop operation is completed.

Тип события

Примеры

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

Комментарии

XСвойства и Y объекта DragEventArgs находятся в экранных координатах, а не на клиентских координатах. The X and Y properties of the DragEventArgs are in screen coordinates, not client coordinates. Следующая строка кода Visual C# преобразует свойства в клиент Point . The following line of Visual C# code converts the properties to a client Point.

В версиях более ранних, чем платформа .NET Framework 2,0, при UserControl помещении DragEnter с DragDrop событиями и в Windows Forms и перетаскивании чего-либо UserControl во время разработки создаются DropDrop DropEnter события и. In versions earlier than .NET Framework 2.0, if you put a UserControl with DragEnter and DragDrop events on a Windows Form and drag and drop something onto the UserControl at design time, the DropDrop and DropEnter events are raised. Однако при закрытии и повторном открытии решения DragEnter DragDrop события и не вызываются снова. However, when you close and reopen the solution, the DragEnter and DragDrop events are not raised again.

Дополнительные сведения об обработке событий см. в разделе обработка и вызов событий. For more information about handling events, see Handling and Raising Events.

Control. Do Drag Drop(Object, DragDropEffects) Метод

Определение

Начинает операцию перетаскивания. Begins a drag-and-drop operation.

Параметры

Перетаскиваемые данные. The data to drag.

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

Возвращаемое значение

Значение перечисления DragDropEffects, представляющее конечный результат выполнения операции перетаскивания. A value from the DragDropEffects enumeration that represents the final effect that was performed during the drag-and-drop operation.

Примеры

В следующем примере кода демонстрируется операция перетаскивания между двумя ListBox элементами управления. The following code 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 requires that two cursor files, 3dwarro.cur and 3dwno.cur , exist in the application directory, for the custom drag and no-drop cursors, respectively. Если флажок установлен, будут использоваться пользовательские курсоры UseCustomCursorsCheck CheckBox . The custom cursors will be used if the UseCustomCursorsCheck CheckBox 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 on 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 задается значение None в DragDropEffects . If the data to drop is not a String , then the DragEventArgs.Effect is set to None in DragDropEffects. Наконец, состояние удаления отображается в DropLocationLabel Label . Finally, the status of the drop is displayed in the DropLocationLabel Label.

Данные, которые нужно удалить справа, 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.

В следующем примере кода показано, как использовать DragDropEffects перечисление, чтобы указать способ передачи данных между элементами управления, вовлеченными в операцию перетаскивания. The following code example shows how to use the DragDropEffects enumeration to specify how data should be transferred between the controls involved in a drag-and-drop operation. В этом примере предполагается, что форма включает RichTextBox элемент управления и ListBox элемент управления, а ListBox элемент управления заполняется списком допустимых имен файлов. This example requires that your form includes a RichTextBox control and a ListBox control and that the ListBox control is populated with a list of valid file names. Когда пользователь перетаскивает имя файла на RichTextBox элемент управления, DragEnter возникает событие элемента управления. When the user drags a file name onto the RichTextBox control, the control’s DragEnter event is raised. В обработчике событий Effect свойство DragEventArgs инициализируется с DragDropEffects целью указания того, что данные, на которые ссылается путь к файлу, должны быть скопированы в RichTextBox элемент управления. Within the event handler, the Effect property of the DragEventArgs is initialized to DragDropEffects to indicate that the data referenced by the file path should be copied to the RichTextBox control.

Комментарии

allowedEffects Параметр определяет, какие операции перетаскивания могут быть выполнены. The allowedEffects parameter determines which drag operations can occur. Если операция перетаскивания должна взаимодействовать с приложениями в другом процессе, то данные должны быть базовым управляемым классом ( String , Bitmap или Metafile ) или объектом, реализующим ISerializable или IDataObject . If the drag operation needs to interoperate with applications in another process, data should either be a base managed class (String, Bitmap, or Metafile), or an object that implements ISerializable or IDataObject.

Далее описывается, как и когда возникают события, связанные с операциями перетаскивания. The following describes how and when events related to drag-and-drop operations are raised.

DoDragDropМетод определяет элемент управления под текущим местоположением курсора. The DoDragDrop method determines the control under the current cursor location. Затем он проверяет, является ли элемент управления допустимым целевым объектом перетаскивания. It then checks to see if the control is a valid drop target.

Если элемент управления является допустимым целевым объектом перетаскивания, GiveFeedback событие вызывается с указанным действием перетаскивания. If the control is a valid drop target, the GiveFeedback event is raised with the drag-and-drop effect specified. Список эффектов перетаскивания см. в перечислении DragDropEffects. For a list of drag-and-drop effects, see the DragDropEffects enumeration.

Отслеживаются изменения позиции указателя мыши, состояния клавиатуры и кнопки мыши. Changes in the mouse cursor position, keyboard state, and mouse button state are tracked.

Если пользователь перемещает указатель мыши за пределы окна, происходит событие DragLeave. If the user moves out of a window, the DragLeave event is raised.

Если указатель мыши перемещается на другой элемент управления, для этого элемента вызывается событие DragEnter. If the mouse enters another control, the DragEnter for that control is raised.

При перемещении мыши в пределах одного элемента управления возникает событие DragOver. If the mouse moves but stays within the same control, the DragOver event is raised.

При изменении состояния клавиатуры или кнопки мыши возникает событие, которое определяет, следует QueryContinueDrag ли продолжить перетаскивание, удалить данные или отменить операцию, исходя из значения Action Свойства события QueryContinueDragEventArgs . If there is a change in the keyboard or mouse button state, the QueryContinueDrag event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event’s QueryContinueDragEventArgs.

Если значение DragAction равно Continue , DragOver событие вызывается для продолжения операции, а GiveFeedback событие вызывается с новым действием, чтобы можно было установить соответствующую визуальную обратную связь. If the value of DragAction is Continue , the DragOver event is raised to continue the operation and the GiveFeedback event is raised with the new effect so appropriate visual feedback can be set. Список допустимых эффектов сброса см. в перечислении DragDropEffects. For a list of valid drop effects, see the DragDropEffects enumeration.

DragOverСобытия и GiveFeedback сопряжены, так что при перемещении мыши по направлению перетаскивания пользователь получает наиболее актуальную информацию о положении мыши. The DragOver and GiveFeedback events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse’s position.

Если значение DragAction равно Drop , значение результата перетаскивания возвращается в источник, поэтому исходное приложение может выполнить соответствующую операцию с исходными данными, например, вырезать данные, если операция была перемещена. If the value of DragAction is Drop , the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move.

Если значение DragAction равно Cancel , DragLeave возникает событие. If the value of DragAction is Cancel , the DragLeave event is raised.

DoDragDropМетод перехватывает все исключения и заново создает только следующие исключения безопасности или критические. The DoDragDrop method catches all exceptions and rethrows only the following security or critical exceptions: