Skip to content

Commit 01c2640

Browse files
samantharamonsamantharamon
authored
[All hosts] Get latest (#2321)
1 parent 988ac81 commit 01c2640

File tree

108 files changed

+7067
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+7067
-0
lines changed

‎docs/docs-ref-autogen/office/office/office.eventtype.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,30 @@ fields:
245245
`addHandlerAsync` method of the `Mailbox` object.
246246
247247
248+
\[ [API set: Mailbox
249+
1.5](/office/dev/add-ins/reference/javascript-api-for-office) \]
250+
- name: ItemDraggedAndDropped
251+
uid: office!Office.EventType.ItemDraggedAndDropped:member
252+
package: office!
253+
summary: >-
254+
Occurs in Outlook on the web and the new Outlook on Windows when messages
255+
or file attachments in the Outlook client window are dragged then dropped
256+
into the task pane of an add-in.
257+
258+
259+
To add an event handler for the `ItemDraggedAndDropped` event, use the
260+
`addHandlerAsync` method of the `Mailbox` object. The event handler
261+
receives an argument of type
262+
[Office.DragAndDropEventArgs](https://learn.microsoft.com/javascript/api/outlook/office.draganddropeventargs)<!--
263+
-->.
264+
265+
266+
**Important**: The `ItemDraggedAndDropped` event isn't supported in
267+
Outlook on Windows (classic) and on Mac. If the `ItemDraggedAndDropped`
268+
handler runs on these clients, an error occurs ("This event isn't
269+
supported on this platform.").
270+
271+
248272
\[ [API set: Mailbox
249273
1.5](/office/dev/add-ins/reference/javascript-api-for-office) \]
250274
- name: NodeDeleted

‎docs/docs-ref-autogen/office_release/office/office.eventtype.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,30 @@ fields:
245245
`addHandlerAsync` method of the `Mailbox` object.
246246
247247
248+
\[ [API set: Mailbox
249+
1.5](/office/dev/add-ins/reference/javascript-api-for-office) \]
250+
- name: ItemDraggedAndDropped
251+
uid: office!Office.EventType.ItemDraggedAndDropped:member
252+
package: office!
253+
summary: >-
254+
Occurs in Outlook on the web and the new Outlook on Windows when messages
255+
or file attachments in the Outlook client window are dragged then dropped
256+
into the task pane of an add-in.
257+
258+
259+
To add an event handler for the `ItemDraggedAndDropped` event, use the
260+
`addHandlerAsync` method of the `Mailbox` object. The event handler
261+
receives an argument of type
262+
[Office.DragAndDropEventArgs](https://learn.microsoft.com/javascript/api/outlook/office.draganddropeventargs)<!--
263+
-->.
264+
265+
266+
**Important**: The `ItemDraggedAndDropped` event isn't supported in
267+
Outlook on Windows (classic) and on Mac. If the `ItemDraggedAndDropped`
268+
handler runs on these clients, an error occurs ("This event isn't
269+
supported on this platform.").
270+
271+
248272
\[ [API set: Mailbox
249273
1.5](/office/dev/add-ins/reference/javascript-api-for-office) \]
250274
- name: NodeDeleted

‎docs/docs-ref-autogen/outlook/outlook.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ interfaces:
2424
- outlook!Office.Display:interface
2525
- outlook!Office.DisplayedBody:interface
2626
- outlook!Office.DisplayedSubject:interface
27+
- outlook!Office.DragAndDropEventArgs:interface
28+
- outlook!Office.DragoverEventData:interface
29+
- outlook!Office.DropEventData:interface
30+
- outlook!Office.DroppedItemDetails:interface
31+
- outlook!Office.DroppedItems:interface
2732
- outlook!Office.EmailAddressDetails:interface
2833
- outlook!Office.EmailUser:interface
2934
- outlook!Office.EnhancedLocation:interface

‎docs/docs-ref-autogen/outlook/outlook/office.draganddropeventargs.yml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
### YamlMime:TSType
2+
name: Office.DragAndDropEventArgs
3+
uid: outlook!Office.DragAndDropEventArgs:interface
4+
package: outlook!
5+
fullName: Office.DragAndDropEventArgs
6+
summary: >-
7+
Provides details about the mouse pointer position and the messages or file
8+
attachments being dragged and dropped into an add-in's task pane when the
9+
`Office.EventType.ItemDraggedAndDropped` event is raised.
10+
remarks: >-
11+
\[ [API set: Mailbox
12+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
13+
14+
15+
To learn more about the drag-and-drop feature and how to implement it across
16+
various Outlook clients, see [Drag and drop messages and attachments into the
17+
task pane of an Outlook
18+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items)<!--
19+
-->.
20+
21+
isPreview: false
22+
isDeprecated: false
23+
type: interface
24+
properties:
25+
- name: dragAndDropEventData
26+
uid: outlook!Office.DragAndDropEventArgs#dragAndDropEventData:member
27+
package: outlook!
28+
fullName: dragAndDropEventData
29+
summary: >-
30+
Gets the details about the mouse pointer position within an add-in's task
31+
pane and the messages or file attachments being dragged and dropped into
32+
the task pane.
33+
remarks: >-
34+
\[ [API set: Mailbox
35+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
36+
\]
37+
38+
isPreview: false
39+
isDeprecated: false
40+
syntax:
41+
content: 'dragAndDropEventData: DragoverEventData | DropEventData;'
42+
return:
43+
type: >-
44+
<xref uid="outlook!Office.DragoverEventData:interface" /> | <xref
45+
uid="outlook!Office.DropEventData:interface" />
46+
- name: type
47+
uid: outlook!Office.DragAndDropEventArgs#type:member
48+
package: outlook!
49+
fullName: type
50+
summary: >-
51+
Gets the type of the event. For details, see
52+
[Office.EventType](https://learn.microsoft.com/javascript/api/office/office.eventtype)<!--
53+
-->.
54+
55+
56+
\[ [API set: Mailbox
57+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
58+
\]
59+
remarks: ''
60+
61+
isPreview: false
62+
isDeprecated: false
63+
syntax:
64+
content: 'type: "olkDragAndDropEvent";'
65+
return:
66+
type: '"olkDragAndDropEvent"'

‎docs/docs-ref-autogen/outlook/outlook/office.dragovereventdata.yml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
### YamlMime:TSType
2+
name: Office.DragoverEventData
3+
uid: outlook!Office.DragoverEventData:interface
4+
package: outlook!
5+
fullName: Office.DragoverEventData
6+
summary: >-
7+
Represents the `DragAndDropEventArgs.dragAndDropEventData` object when
8+
messages or file attachments are dragged over an add-in's task pane.
9+
remarks: >-
10+
\[ [API set: Mailbox
11+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
12+
13+
14+
To learn more about the drag-and-drop feature and how to implement it across
15+
various Outlook clients, see [Drag and drop messages and attachments into the
16+
task pane of an Outlook
17+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items)<!--
18+
-->.
19+
20+
isPreview: false
21+
isDeprecated: false
22+
type: interface
23+
properties:
24+
- name: pageX
25+
uid: outlook!Office.DragoverEventData#pageX:member
26+
package: outlook!
27+
fullName: pageX
28+
summary: >-
29+
Gets the x-coordinate of the mouse pointer that represents the horizontal
30+
position in pixels. The position is relative to the left edge of the
31+
Outlook on the web or the new Outlook on Windows client window.
32+
remarks: >-
33+
\[ [API set: Mailbox
34+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
35+
\]
36+
37+
isPreview: false
38+
isDeprecated: false
39+
syntax:
40+
content: 'pageX: number;'
41+
return:
42+
type: number
43+
- name: pageY
44+
uid: outlook!Office.DragoverEventData#pageY:member
45+
package: outlook!
46+
fullName: pageY
47+
summary: >-
48+
Gets the y-coordinate of the mouse pointer that represents the vertical
49+
position in pixels. The position is relative to the top edge of the
50+
Outlook on the web or the new Outlook on Windows client window.
51+
remarks: >-
52+
\[ [API set: Mailbox
53+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
54+
\]
55+
56+
isPreview: false
57+
isDeprecated: false
58+
syntax:
59+
content: 'pageY: number;'
60+
return:
61+
type: number
62+
- name: type
63+
uid: outlook!Office.DragoverEventData#type:member
64+
package: outlook!
65+
fullName: type
66+
summary: >-
67+
Gets the type of drag-and-drop event. The `dragover` event occurs when
68+
messages or file attachments are dragged over an add-in's task pane.
69+
remarks: >-
70+
\[ [API set: Mailbox
71+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
72+
\]
73+
74+
isPreview: false
75+
isDeprecated: false
76+
syntax:
77+
content: 'type: "dragover";'
78+
return:
79+
type: '"dragover"'

‎docs/docs-ref-autogen/outlook/outlook/office.dropeventdata.yml

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
### YamlMime:TSType
2+
name: Office.DropEventData
3+
uid: outlook!Office.DropEventData:interface
4+
package: outlook!
5+
fullName: Office.DropEventData
6+
summary: >-
7+
Represents the `DragAndDropEventArgs.dragAndDropEventData` object when
8+
messages or file attachments are dropped into an add-in's task pane.
9+
remarks: >-
10+
\[ [API set: Mailbox
11+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
12+
13+
14+
To learn more about the drag-and-drop feature and how to implement it across
15+
various Outlook clients, see [Drag and drop messages and attachments into the
16+
task pane of an Outlook
17+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items)<!--
18+
-->.
19+
20+
isPreview: false
21+
isDeprecated: false
22+
type: interface
23+
properties:
24+
- name: dataTransfer
25+
uid: outlook!Office.DropEventData#dataTransfer:member
26+
package: outlook!
27+
fullName: dataTransfer
28+
summary: >-
29+
Gets the messages or file attachments being dragged and dropped into an
30+
add-in's task pane.
31+
remarks: >-
32+
\[ [API set: Mailbox
33+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
34+
\]
35+
36+
isPreview: false
37+
isDeprecated: false
38+
syntax:
39+
content: 'dataTransfer: DroppedItems;'
40+
return:
41+
type: <xref uid="outlook!Office.DroppedItems:interface" />
42+
- name: pageX
43+
uid: outlook!Office.DropEventData#pageX:member
44+
package: outlook!
45+
fullName: pageX
46+
summary: >-
47+
Gets the x-coordinate of the mouse pointer that represents the horizontal
48+
position in pixels. The position is relative to the left edge of the
49+
Outlook on the web or the new Outlook on Windows client window.
50+
remarks: >-
51+
\[ [API set: Mailbox
52+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
53+
\]
54+
55+
isPreview: false
56+
isDeprecated: false
57+
syntax:
58+
content: 'pageX: number;'
59+
return:
60+
type: number
61+
- name: pageY
62+
uid: outlook!Office.DropEventData#pageY:member
63+
package: outlook!
64+
fullName: pageY
65+
summary: >-
66+
Gets the y-coordinate of the mouse pointer that represents the vertical
67+
position in pixels. The position is relative to the top edge of the
68+
Outlook on the web or the new Outlook on Windows client window.
69+
remarks: >-
70+
\[ [API set: Mailbox
71+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
72+
\]
73+
74+
isPreview: false
75+
isDeprecated: false
76+
syntax:
77+
content: 'pageY: number;'
78+
return:
79+
type: number
80+
- name: type
81+
uid: outlook!Office.DropEventData#type:member
82+
package: outlook!
83+
fullName: type
84+
summary: >-
85+
Gets the type of drag-and-drop event. The `drop` event occurs when
86+
messages or file attachments are dropped into an add-in's task pane.
87+
remarks: >-
88+
\[ [API set: Mailbox
89+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
90+
\]
91+
92+
isPreview: false
93+
isDeprecated: false
94+
syntax:
95+
content: 'type: "drop";'
96+
return:
97+
type: '"drop"'

‎docs/docs-ref-autogen/outlook/outlook/office.droppeditemdetails.yml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
### YamlMime:TSType
2+
name: Office.DroppedItemDetails
3+
uid: outlook!Office.DroppedItemDetails:interface
4+
package: outlook!
5+
fullName: Office.DroppedItemDetails
6+
summary: >-
7+
Provides the contents and details of the message or file attachment being
8+
dragged and dropped into an add-in's task pane.
9+
remarks: >-
10+
\[ [API set: Mailbox
11+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
12+
13+
14+
To learn more about the drag-and-drop feature and how to implement it across
15+
various Outlook clients, see [Drag and drop messages and attachments into the
16+
task pane of an Outlook
17+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/drag-drop-items)<!--
18+
-->.
19+
20+
isPreview: false
21+
isDeprecated: false
22+
type: interface
23+
properties:
24+
- name: fileContent
25+
uid: outlook!Office.DroppedItemDetails#fileContent:member
26+
package: outlook!
27+
fullName: fileContent
28+
summary: Gets the contents of the file being dragged and dropped.
29+
remarks: >-
30+
\[ [API set: Mailbox
31+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
32+
\]
33+
34+
35+
For guidance on how to retrieve data from a `Blob`<!-- -->, see the [File
36+
API documentation](https://developer.mozilla.org/docs/Web/API/Blob)<!--
37+
-->.
38+
39+
isPreview: false
40+
isDeprecated: false
41+
syntax:
42+
content: 'fileContent: Blob;'
43+
return:
44+
type: Blob
45+
- name: name
46+
uid: outlook!Office.DroppedItemDetails#name:member
47+
package: outlook!
48+
fullName: name
49+
summary: Gets the name of the file being dragged and dropped.
50+
remarks: >-
51+
\[ [API set: Mailbox
52+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
53+
\]
54+
55+
isPreview: false
56+
isDeprecated: false
57+
syntax:
58+
content: 'name: string;'
59+
return:
60+
type: string
61+
- name: type
62+
uid: outlook!Office.DroppedItemDetails#type:member
63+
package: outlook!
64+
fullName: type
65+
summary: Gets the type of the file being dragged and dropped.
66+
remarks: >-
67+
\[ [API set: Mailbox
68+
1.5](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets)
69+
\]
70+
71+
72+
**Important**: When a message is dragged into an add-in's task pane,
73+
it's dropped as a .eml file.
74+
75+
isPreview: false
76+
isDeprecated: false
77+
syntax:
78+
content: 'type: string;'
79+
return:
80+
type: string

0 commit comments

Comments
 (0)