Skip to content

Commit fa3a57a

Browse files
committed
[All Hosts] (runtimes) mainly adding links to new runtimes article
1 parent 2924f6b commit fa3a57a

File tree

99 files changed

+510
-477
lines changed

Some content is hidden

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

99 files changed

+510
-477
lines changed

docs/concepts/browsers-used-by-office-web-add-ins.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ To determine whether Office 2016 or Office 2019 is consumer or commercial, use t
6565

6666
<sup>1</sup> When you use Microsoft Edge, the Windows Narrator (sometimes called a "screen reader") reads the `<title>` tag in the page that opens in the task pane. In Internet Explorer 11, the Narrator reads the title bar of the task pane, which comes from the **\<DisplayName\>** value in the add-in's manifest.
6767

68-
<sup>2</sup> If your add-in includes the **\<Runtimes\>** element in the manifest, then it will not use Microsoft Edge with the original WebView (EdgeHTML). If the conditions for using Microsoft Edge with WebView2 (Chromium-based) are met, then the add-in uses that browser. Otherwise, it uses Internet Explorer 11. For more information, see [Runtimes](/javascript/api/manifest/runtimes).
68+
<sup>2</sup> If your add-in includes the **\<Configure your Office Add-in to use a shared runtimes\>** element in the manifest, then it will not use Microsoft Edge with the original WebView (EdgeHTML). If the conditions for using Microsoft Edge with WebView2 (Chromium-based) are met, then the add-in uses that browser. Otherwise, it uses Internet Explorer 11. For more information, see [Configure your Office Add-in to use a shared runtimes](/javascript/api/manifest/Configure your Office Add-in to use a shared runtimes).
6969

7070
<sup>3</sup> On Windows versions prior to Windows 11, the WebView2 control must be installed so that Office can embed it. It's installed with perpetual Office 2021 or later; but it isn't automatically installed with Microsoft Edge. If you have an earlier version of perpetual Office, use the instructions for installing the control at [Microsoft Edge WebView2 / Embed web content ... with Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2/).
7171

@@ -86,7 +86,7 @@ For subscription Office on Windows, the browser that is used is determined by th
8686

8787
<sup>2</sup> See the [update history page](/officeupdates/update-history-office365-proplus-by-date) and how to [find your Office client version and update channel](https://support.microsoft.com/office/932788b8-a3ce-44bf-bb09-e334518b8b19) for more details.
8888

89-
<sup>3</sup> If your add-in includes the **\<Runtimes\>** element in the manifest, then it will not use Microsoft Edge with the original WebView (EdgeHTML). If the conditions for using Microsoft Edge with WebView2 (Chromium-based) are met, then the add-in uses that browser. Otherwise, it uses Internet Explorer 11 regardless of the Windows or Microsoft 365 version. For more information, see [Runtimes](/javascript/api/manifest/runtimes).
89+
<sup>3</sup> If your add-in includes the **\<Configure your Office Add-in to use a shared runtimes\>** element in the manifest, then it will not use Microsoft Edge with the original WebView (EdgeHTML). If the conditions for using Microsoft Edge with WebView2 (Chromium-based) are met, then the add-in uses that browser. Otherwise, it uses Internet Explorer 11 regardless of the Windows or Microsoft 365 version. For more information, see [Configure your Office Add-in to use a shared runtimes](/javascript/api/manifest/Configure your Office Add-in to use a shared runtimes).
9090

9191
<sup>4</sup> On Windows versions prior to Windows 11, the WebView2 control must be installed so that Office can embed it. It's installed with Microsoft 365, version 2101 or later, but it isn't automatically installed with Microsoft Edge. If you have an earlier version of Microsoft 365, use the instructions for installing the control at [Microsoft Edge WebView2 / Embed web content ... with Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2/). On Microsoft 365 builds before 16.0.14326.xxxxx, you must also create the registry key **HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Win32WebView2** and set its value to `dword:00000001`.
9292

@@ -99,7 +99,7 @@ Internet Explorer 11 does not support JavaScript versions later than ES5. If any
9999

100100
For more information about these options, see [Support Internet Explorer 11](../develop/support-ie-11.md).
101101

102-
Also, Internet Explorer 11 does not support some HTML5 features such as media, recording, and location. To learn more, see [Determine at runtime if the add-in is running in Internet Explorer](../develop/support-ie-11.md#determine-at-runtime-if-the-add-in-is-running-in-internet-explorer).
102+
Also, Internet Explorer 11 does not support some HTML5 features such as media, recording, and location. To learn more, see [Determine at Configure your Office Add-in to use a shared runtime if the add-in is running in Internet Explorer](../develop/support-ie-11.md#determine-at-Configure your Office Add-in to use a shared runtime-if-the-add-in-is-running-in-internet-explorer).
103103

104104
## Troubleshoot Microsoft Edge issues
105105

@@ -137,3 +137,4 @@ To determine if a document is WIP-protected, follow these steps:
137137
## See also
138138

139139
- [Requirements for Running Office Add-ins](requirements-for-running-office-add-ins.md)
140+
- [Configure your Office Add-in to use a shared runtimes in Office Add-ins](../testing/Configure your Office Add-in to use a shared runtimes.md)

docs/concepts/correlated-objects-pattern.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ await Word.run(async function (context) {
7070
The preceding code took 1 full second to complete in a document with 200 instances of "the" in Word on Windows. But when the `await context.sync();` line inside the loop is commented out and the same line just after the loop is uncommented, the operation took only a 1/10th of a second. In Word on the web (with Edge as the browser), it took 3 full seconds with the synchronization inside the loop and only 6/10ths of a second with the synchronization after the loop, about five times faster. In a document with 2000 instances of "the", it took (in Word on the web) 80 seconds with the synchronization inside the loop and only 4 seconds with the synchronization after the loop, about 20 times faster.
7171

7272
> [!NOTE]
73-
> It's worth asking whether the synchronize-inside-the-loop version would execute faster if the synchronizations ran concurrently, which could be done by simply removing the `await` keyword from the front of the `context.sync()`. This would cause the runtime to initiate the synchronization and then immediately start the next iteration of the loop without waiting for the synchronization to complete. However, this is not as good a solution as moving the `context.sync` out of the loop entirely for these reasons.
73+
> It's worth asking whether the synchronize-inside-the-loop version would execute faster if the synchronizations ran concurrently, which could be done by simply removing the `await` keyword from the front of the `context.sync()`. This would cause the Configure your Office Add-in to use a shared runtime to initiate the synchronization and then immediately start the next iteration of the loop without waiting for the synchronization to complete. However, this is not as good a solution as moving the `context.sync` out of the loop entirely for these reasons.
7474
>
7575
> - Just as the commands in a synchronization batch job are queued, the batch jobs themselves are queued in Office, but Office supports no more than 50 batch jobs in the queue. Any more triggers errors. So, if there are more than 50 iterations in a loop, there is a chance that the queue size is exceeded. The greater the number of iterations, the greater the chance of this happening.
7676
> - "Concurrently" does not mean simultaneously. It would still take longer to execute multiple synchronization operations than to execute one.

docs/concepts/privacy-and-security.md

+16-13
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
22
title: Privacy and security for Office Add-ins
33
description: Learn about the privacy and security aspects of the Office Add-ins platform.
4-
ms.date: 07/18/2022
4+
ms.date: 08/19/2022
55
ms.localizationpriority: medium
66
---
77

88
# Privacy and security for Office Add-ins
99

10-
## Understanding the add-in runtime
10+
## Process security
1111

12-
Office Add-ins are secured by an add-in runtime environment, a multiple-tier permissions model, and performance governors. This framework protects the user's experience in the following ways.
12+
Office Add-ins are secured by an add-in Configure your Office Add-in to use a shared runtime environment, a multiple-tier permissions model, and performance governors. This framework protects the user's experience in the following ways.
1313

1414
- Access to the Office client application's UI frame is managed.
1515

1616
- Only indirect access to the Office client application's UI thread is allowed.
1717

1818
- Modal interactions aren't allowed - for example, calls to JavaScript `alert`, `confirm`, and `prompt` methods aren't allowed because they're modal.
1919

20-
Further, the runtime framework provides the following benefits to ensure that an Office Add-in can't damage the user's environment.
20+
Further, the Configure your Office Add-in to use a shared runtime framework provides the following benefits to ensure that an Office Add-in can't damage the user's environment.
2121

2222
- Isolates the process the add-in runs in.
2323

@@ -27,29 +27,32 @@ Further, the runtime framework provides the following benefits to ensure that an
2727

2828
Also, the use of memory, CPU, and network resources by Office Add-ins is governable to ensure that good performance and reliability are maintained.
2929

30-
The following sections briefly describe how the runtime architecture supports running add-ins in Office clients on Windows-based devices, on Mac OS X devices, and in web browsers.
30+
> [!NOTE]
31+
> In some scenarios, different features of an add-in run in separate Configure your Office Add-in to use a shared runtimes. For simplicity, this article uses the singular "Configure your Office Add-in to use a shared runtime." For more information, see [Configure your Office Add-in to use a shared runtimes in Office Add-ins](../testing/Configure your Office Add-in to use a shared runtimes.md).
32+
33+
The following sections briefly describe how the Configure your Office Add-in to use a shared runtime architecture supports running add-ins in Office clients on Windows-based devices, on Mac OS X devices, and in web browsers.
3134

3235
### Clients on Windows and OS X devices
3336

34-
In supported clients for desktop and tablet devices, such as Excel on Windows, and Outlook on Windows and Mac, Office Add-ins are supported by integrating an in-process component, the Office Add-ins runtime, which manages the add-in lifecycle and enables interoperability between the add-in and the client application. The add-in webpage itself is hosted out-of-process. As shown in figure 1, on a Windows desktop or tablet device, [the add-in webpage is hosted inside an Internet Explorer or Microsoft Edge control](browsers-used-by-office-web-add-ins.md) which, in turn, is hosted inside an add-in runtime process that provides security and performance isolation.
37+
In supported clients for desktop and tablet devices, such as Excel on Windows, and Outlook on Windows and Mac, Office Add-ins are supported by integrating an in-process component, the Office Add-ins Configure your Office Add-in to use a shared runtime, which manages the add-in lifecycle and enables interoperability between the add-in and the client application. The add-in webpage itself is hosted out-of-process. As shown in figure 1, on a Windows desktop or tablet device, [the add-in webpage is hosted inside an Internet Explorer or Microsoft Edge control](browsers-used-by-office-web-add-ins.md) which, in turn, is hosted inside an add-in Configure your Office Add-in to use a shared runtime process that provides security and performance isolation.
3538

3639
On Windows desktops, Protected Mode in Internet Explorer must be enabled for the Restricted Site Zone. This is typically enabled by default. If it is disabled, an [error will occur](/office/troubleshoot/office-suite-issues/apps-for-office-not-start) when you try to launch an add-in.
3740

38-
*Figure 1. Office Add-ins runtime environment in Windows-based desktop and tablet clients*
41+
*Figure 1. Office Add-ins Configure your Office Add-in to use a shared runtime environment in Windows-based desktop and tablet clients*
3942

4043
![Diagram showing rich-client infrastructure.](../images/dk2-agave-overview-02.png)
4144

42-
As shown in the following figure, on a Mac OS X desktop, the add-in web page is hosted inside a sandboxed WebKit runtime host process which helps provide similar level of security and performance protection.
45+
As shown in the following figure, on a Mac OS X desktop, the add-in web page is hosted inside a sandboxed WebKit Configure your Office Add-in to use a shared runtime host process which helps provide similar level of security and performance protection.
4346

44-
*Figure 2. Office Add-ins runtime environment in Mac OS X clients*
47+
*Figure 2. Office Add-ins Configure your Office Add-in to use a shared runtime environment in Mac OS X clients*
4548

46-
![Diagram showing apps for Office runtime environment on Mac OS X.](../images/dk2-agave-overview-mac-02.png)
49+
![Diagram showing apps for Office Configure your Office Add-in to use a shared runtime environment on Mac OS X.](../images/dk2-agave-overview-mac-02.png)
4750

48-
The Office Add-ins runtime manages interprocess communication, the translation of JavaScript API calls and events into native ones, as well as UI remoting support to enable the add-in to be rendered inside the document, in a task pane, or adjacent to an email message, meeting request, or appointment.
51+
The Office Add-ins Configure your Office Add-in to use a shared runtime manages interprocess communication, the translation of JavaScript API calls and events into native ones, as well as UI remoting support to enable the add-in to be rendered inside the document, in a task pane, or adjacent to an email message, meeting request, or appointment.
4952

5053
### Web clients
5154

52-
In supported web clients, Office Add-ins are hosted in an **iframe** that runs using the HTML5 **sandbox** attribute. ActiveX components or navigating the main page of the web client are not allowed. Office Add-ins support is enabled in the web clients by the integration of the JavaScript API for Office. In a similar way to the desktop client applications, the JavaScript API manages the add-in lifecycle and interoperability between the add-in and the web client. This interoperability is implemented by using a special cross-frame post message communication infrastructure. The same JavaScript library (Office.js) that is used on desktop clients is available to interact with the web client. The following figure shows the infrastructure that supports add-ins in Office running in the browser, and the relevant components (the web client, **iframe**, Office Add-ins runtime, and JavaScript API for Office) that are required to support them.
55+
In supported web clients, Office Add-ins are hosted in an **iframe** that runs using the HTML5 **sandbox** attribute. ActiveX components or navigating the main page of the web client are not allowed. Office Add-ins support is enabled in the web clients by the integration of the JavaScript API for Office. In a similar way to the desktop client applications, the JavaScript API manages the add-in lifecycle and interoperability between the add-in and the web client. This interoperability is implemented by using a special cross-frame post message communication infrastructure. The same JavaScript library (Office.js) that is used on desktop clients is available to interact with the web client. The following figure shows the infrastructure that supports add-ins in Office running in the browser, and the relevant components (the web client, **iframe**, Office Add-ins Configure your Office Add-in to use a shared runtime, and JavaScript API for Office) that are required to support them.
5356

5457
*Figure 3. Infrastructure that supports Office Add-ins in Office web clients*
5558

@@ -102,7 +105,7 @@ The add-in platform addresses end users' privacy concerns in the following ways.
102105

103106
- The design of the add-in platform provides security and performance for end users in the following ways.
104107

105-
- An Office Add-in runs in a web browser control that is hosted in an add-in runtime environment separate from the Office client application. This design provides both security and performance isolation from the client application.
108+
- An Office Add-in runs in a web browser control that is hosted in an add-in Configure your Office Add-in to use a shared runtime environment separate from the Office client application. This design provides both security and performance isolation from the client application.
106109

107110
- Running in a web browser control allows the add-in to do almost anything a regular web page running in a browser can do but, at the same time, restricts the add-in to observe the same-origin policy for domain isolation and security zones.
108111

docs/concepts/resource-limits-and-performance-optimization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The following table lists the events that the Telemetry Log tracks for Office Ad
8989
|10|Add-in used too much CPU|Critical|The Office Add-in used more than 90% of the CPU resources over a finite period of time.|
9090
|15|Add-in disabled due to string search time-out||Outlook add-ins search the subject line and message of an e-mail to determine whether they should be displayed by using a regular expression. The Outlook add-in listed in the **File** column was disabled by Outlook because it timed out repeatedly while trying to match a regular expression.|
9191
|18|Add-in closed successfully||The Office application was able to close the Office Add-in successfully.|
92-
|19|Add-in encountered runtime error|Critical|The Office Add-in had a problem that caused it to fail. For more details, look at the **Microsoft Office Alerts** log using the Windows Event Viewer on the computer that encountered the error.|
92+
|19|Add-in encountered Configure your Office Add-in to use a shared runtime error|Critical|The Office Add-in had a problem that caused it to fail. For more details, look at the **Microsoft Office Alerts** log using the Windows Event Viewer on the computer that encountered the error.|
9393
|20|Add-in failed to verify licensing|Critical|The licensing information for the Office Add-in could not be verified and may have expired. For more details, look at the **Microsoft Office Alerts** log using the Windows Event Viewer on the computer that encountered the error.|
9494

9595
For more information, see [Deploying Telemetry Dashboard](/previous-versions/office/office-2013-resource-kit/jj219431(v=office.15)) and [Troubleshooting Office files and custom solutions with the telemetry log](/office/client-developer/shared/troubleshooting-office-files-and-custom-solutions-with-the-telemetry-log).

0 commit comments

Comments
 (0)