You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/design/add-in-design-language.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Office Add-in design language
3
3
description: Learn how to make your Office Add-in visually compatible with Office.
4
-
ms.date: 08/18/2023
4
+
ms.date: 02/11/2025
5
5
ms.topic: overview
6
6
ms.localizationpriority: medium
7
7
---
@@ -23,3 +23,23 @@ The Office design language is a clean and simple visual system that ensures cons
23
23
Many Office Add-ins are associated with a preexisting brand. You can retain a strong brand and its visual or component language in your add-in. Look for opportunities to retain your own visual language while integrating with Office. Consider ways to swap out Office colors, typography, icons, or other stylistic elements with elements of your own brand. Consider ways to follow common add-in layouts or UX design patterns while inserting controls and components that are familiar to your customers.
24
24
25
25
Inserting a heavily branded HTML-based UI inside of Office can create dissonance for customers. Find a balance that fits seamlessly in Office but also clearly aligns with your service or parent brand. When an add-in doesn't fit with Office, it's often because stylistic elements conflict. For example, typography is too large and off grid, colors are contrasting or particularly loud, or animations are superfluous and behave differently than Office. The appearance and behavior of controls or components veer too far from Office standards.
26
+
27
+
## Review guidelines for visual elements
28
+
29
+
Learn about each visual element that makes up an Office Add-in, including guidelines and recommended practices.
30
+
31
+
-[Color guidelines for Office Add-ins](add-in-color.md)
32
+
-[Icon guidelines for Office Add-ins](add-in-icons.md)
33
+
-[Layout guidelines for Office Add-ins](add-in-layout.md)
34
+
-[Using motion in Office Add-ins](using-motion-office-addins.md)
35
+
-[Typography guidelines for Office Add-ins](add-in-typography.md)
36
+
37
+
## Design toolkits for download
38
+
39
+
To help you get started, we've created toolkits for use with either the [Sketch](https://www.sketch.com/) application for Mac or the [Adobe XD](https://www.adobe.com/products/xd/features.html) application for Windows or Mac. The following downloads include all of our available patterns, along with brief descriptions and layout recommendations.
Copy file name to clipboardExpand all lines: docs/outlook/delegate-access.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -248,7 +248,7 @@ If an admin hid a user or shared mailbox address from an address list, such as t
248
248
249
249
### Sync across shared folder clients
250
250
251
-
A delegate's updates to the owner's mailbox are usually synced across mailboxes immediately. However, if Microsoft Graph operations were used to set an extended property on an item, such changes could take some time to sync. To avoid a delay, we recommend you instead use the [CustomProperties](/javascript/api/outlook/office.customproperties) object and related APIs. To learn more, see the "Custom data per item in a mailbox: custom properties" section of [Get and set metadata in an Outlook add-in](metadata-for-an-outlook-add-in.md#custom-data-per-item-in-a-mailbox-custom-properties).
251
+
A delegate's updates to the owner's mailbox are usually synced across mailboxes immediately. However, if Microsoft Graph operations were used to set an extended property on an item, such changes could take some time to sync. To avoid a delay, we recommend you instead use the [CustomProperties](/javascript/api/outlook/office.customproperties) object and related APIs. To learn more, see the "Custom properties" tab of [Get and set metadata in an Outlook add-in](metadata-for-an-outlook-add-in.md?tabs=custom-properties).
Copy file name to clipboardExpand all lines: docs/outlook/internet-headers.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Get and set internet headers
3
3
description: How to get and set internet headers on a message in an Outlook add-in.
4
-
ms.date: 10/17/2024
4
+
ms.date: 02/11/2025
5
5
ms.topic: how-to
6
6
ms.localizationpriority: medium
7
7
---
@@ -12,10 +12,10 @@ ms.localizationpriority: medium
12
12
13
13
A common requirement in Outlook add-ins development is to store custom properties associated with an add-in at different levels. At present, custom properties are stored at the item or mailbox level.
14
14
15
-
- Item level - For properties that apply to a specific item, use the [CustomProperties](/javascript/api/outlook/office.customproperties) object. For example, store a customer code associated with the person who sent the email.
15
+
- Item level - For properties that apply to a specific item that need to be accessed during subsequent Outlook sessions, use the [CustomProperties](/javascript/api/outlook/office.customproperties) object. For example, store a customer code associated with the person who sent the email. If properties for a specific item are only needed during the current compose session, use the [SessionData](/javascript/api/outlook/office.sessiondata) object.
16
16
- Mailbox level - For properties that apply to all the mail items in the user's mailbox, use the [RoamingSettings](/javascript/api/outlook/office.roamingsettings) object. For example, store a user's preference to show the temperature in a particular scale.
17
17
18
-
Both types of properties aren't preserved after the item leaves the Exchange server, so the email recipients can't get any properties set on the item. Therefore, developers can't access those settings or other Multipurpose Internet Mail Extensions (MIME) properties to enable better read scenarios.
18
+
These types of properties aren't preserved after the item leaves the Exchange server, so the email recipients can't get any properties set on the item. Therefore, developers can't access those settings or other Multipurpose Internet Mail Extensions (MIME) properties to enable better read scenarios.
19
19
20
20
In Exchange on-premises environments, while there's a way for you to set the internet headers through Exchange Web Services (EWS) requests, in some scenarios, making an EWS request won't work. For example, in Compose mode on Outlook desktop, the item ID isn't synced on `saveAsync` in cached mode.
Copy file name to clipboardExpand all lines: docs/outlook/limits-for-activation-and-javascript-api-for-outlook-add-ins.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Limits for activation and API usage in Outlook add-ins
3
3
description: Be aware of certain activation and API usage guidelines, and implement your add-ins to stay within these limits.
4
-
ms.date: 07/18/2024
4
+
ms.date: 02/11/2025
5
5
ms.topic: best-practice
6
6
ms.localizationpriority: medium
7
7
---
@@ -25,6 +25,7 @@ Each Outlook client enforces certain limits in the JavaScript object model, as d
25
25
|:-----|:-----|:-----|:-----|
26
26
|Custom properties|2,500 characters|[CustomProperties](/javascript/api/outlook/office.customproperties) object<br/><br/>[Item.loadCustomPropertiesAsync](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods) method|Limit for all custom properties for an appointment or message item. All the Outlook clients return an error if the total size of all custom properties of an add-in exceeds this limit.|
27
27
|Roaming settings|32 KB number of characters|[RoamingSettings](/javascript/api/outlook/office.roamingsettings) object<br/><br/>[Context.roamingSettings](/javascript/api/office/office.context#office-office-context-roamingsettings-member) property|Limit for all roaming settings for the add-in. All the Outlook clients return an error if your settings exceed this limit.|
28
+
|Session data|50,000 characters|[Office.SessionData](/javascript/api/outlook/office.sessiondata)<br/><br/>[Item.sessionData](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods) method|For a specific mail item, the limit of an entire SessionData object per add-in.|
28
29
|Internet headers|256 KB per message in Exchange Online<br/><br/>Header size limit determined by the organization's administrators in Exchange on-premises|[InternetHeaders.setAsync](/javascript/api/outlook/office.internetheaders) method|The total size limit of headers that can be applied to a message.|
29
30
|Exchange Web Services|5 MB number of characters in Outlook on the web, on Windows (starting in Version 2303 (Build 16225.10000)), on Mac (starting in Version 16.73 (23042601)), and in [new Outlook on Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<br><br>1 MB of characters in earlier versions of Outlook on Windows (classic) and on Mac|[Mailbox.makeEwsRequestAsync](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-makeewsrequestasync-member(1)) method|Limit for a request or response to a `Mailbox.makeEwsRequestAsync` call.|
30
31
|Item multi-select|100 messages|[Mailbox.getSelectedItemsAsync](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getselecteditemsasync-member(1)) method|The maximum number of selected messages on which an Outlook add-in can activate.|
0 commit comments