Office.DragAndDropEventArgs interface

Remarks

API set: Mailbox 1.5

To learn more about the drag-and-drop feature and how to implement it across various Outlook clients, see Drag and drop messages and attachments into the task pane of an Outlook add-in.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/80-events/drag-drop-item.yaml

function dragAndDropEventHandler(event) {
 Office.context.mailbox.addHandlerAsync(Office.EventType.DragAndDropEvent, (event) => {
 console.log(`Event type: ${event.type}`);

 const eventData = event.dragAndDropEventData;
 console.log(`x-coordinate: ${eventData.pageX}, y-coordinate: ${eventData.pageY}`);
 console.log(`x-coordinate relative to task pane: ${eventData.taskPaneX}, y-coordinate relative to task pane: ${eventData.taskPaneY}`);

 if (eventData.type == "drop") {
 console.log("Items dropped into task pane.");
 const files = eventData.dataTransfer.files;
 files.forEach((file) => {
 const content = file.fileContent;
 const name = file.name;
 const fileType = file.type;
 console.log(`File name: ${name}`);
 console.log(`File type: ${fileType}`);
 console.log(`Contents: ${content.text().then((text) => { console.log(text); })}`);
 });
 }
 });
}

Properties

dragAndDropEventData

dragAndDropEventData: DragoverEventData | DropEventData;

type

type: "olkDragAndDropEvent";