Skip to content

Commit 3a30ee5

Browse files
committed
Adjust phrasing
1 parent b069857 commit 3a30ee5

1 file changed

Lines changed: 18 additions & 17 deletions

File tree

docs/excel/custom-functions-synchronous.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,48 +7,49 @@ ms.localizationpriority: medium
77

88
# Synchronous custom functions
99

10-
Synchronous custom functions allow evaluate and conditional format processes to run in Excel simultaneously with the custom function. Enable synchronous support when your custom function needs to run in tandem with any the Excel processes listed in this article. If a custom function doesn't support synchronous operations, it returns an error such as `#CALC!` or `#VALUE!` when it runs at the same time as these Excel processes.
10+
Synchronous custom functions allow evaluate and conditional format processes to run in Excel simultaneously with the custom function. Enable synchronous support when your custom function needs to run in tandem with any the Excel processes listed in this article. Custom functions that don't support synchronous operations return an error such as `#CALC!` or `#VALUE!` when they run at the same time as these Excel processes.
1111

1212
> [!WARNING]
13-
> Synchronous custom functions don't support write operations with Office JavaScript APIs, such as using `Range.values` to set a cell value. Calling a write operation in a synchronous custom function may cause Excel to freeze.
13+
> Synchronous custom functions don't support write operations with Office JavaScript APIs, such as using `Range.values` to set a cell value. Calling a write operation in a synchronous custom function may cause Excel to freeze. Do not use write operations in synchronous custom functions.
1414
1515
## Excel processes supported by synchronous custom functions
1616

17-
The following Excel actions and processes work with synchronous custom functions.
17+
The following actions and processes work with synchronous custom functions.
1818

19-
### Evaluate actions
19+
### Supported evaluate actions
2020

21-
- UI action: Formulas > Evaluate Formula.
22-
- UI action: Formulas > Insert Function.
23-
- UI action: In cell edit mode, selecting part of a formula and using F9 to see partial calculation results.
24-
- VBA API: Application.Calculate.
21+
- Selecting Formulas and then Evaluate Formula in Excel.
22+
- Selecting Formulas and then Insert Function in Excel.
23+
- In cell edit mode, selecting part of a formula and using F9 to see partial calculation results.
24+
- The `Application.Calculate` method in VBA.
2525

26-
### Conditional format actions
26+
### Supported conditional format actions
2727

28-
The following list applies to conditional format actions triggered by both the Excel UI and Office JavaScript APIs.
28+
The following list applies to conditional formatting actions triggered by both the Excel UI and Office JavaScript APIs.
2929

30-
- Create new rule.
30+
- Create a new rule.
3131
- Edit rules.
3232
- Delete rules.
3333
- Reorder rules.
34-
- Change “Applies to” range.
35-
- Toggle “Stop if True”.
34+
- Change the “Applies to” range.
35+
- Toggle “Stop if true” on or off.
3636
- Clear all rules.
37-
- Copy/Cut and Paste cells containing conditional formatting.
37+
- Cut and paste cells that contain conditional formatting.
38+
- Copy and paste cells that contain conditional formatting.
3839

3940
> [!NOTE]
40-
> When a synchronous custom function takes a significant amount of time to complete, Excel might temporarily block the user interface while waiting for the result. To avoid prolonged interruptions, users can cancel the execution at any time by using <kbd>Esc</kbd> or by selecting anywhere outside the cell or dialog.
41+
> When a synchronous custom function takes a significant amount of time to complete, Excel might temporarily block the user interface while waiting for the result. To avoid prolonged interruptions, users can cancel the function execution at any time by using the <kbd>Esc</kbd> key or selecting anywhere outside the cell or dialog.
4142
4243
## Enable synchronous support in your add-in
4344

44-
To support synchronous scenarios in your add-in:
45+
To support synchronous scenarios in your add-in, take the following steps.
4546

4647
- If you [autogenerate JSON metadata](custom-functions-json-autogeneration.md), use the `@supportSync` JSDoc tag.
4748
- If you [manually create JSON metadata](custom-functions-json.md), use the `"supportSync": true` setting in the `"options"` object of your **functions.json** file.
4849
- If the function uses `Excel.RequestContext`, call the `setInvocation` method of `Excel.RequestContext` and pass in the `CustomFunctions.Invocation` object. For an example, see the [code sample](#code-sample).
4950

5051
> [!IMPORTANT]
51-
> Synchronous custom functions can't be **streaming** or **volatile** functions. If you use the `@supportSync` tag with `@volatile` or `@streaming` tags, Excel ignores the synchronous support. Volatile or streaming support takes precedence, and the custom function can't run at the same time as evaluate or conditional format processes.
52+
> Synchronous custom functions can't be **streaming** or **volatile** functions. If you use the `@supportSync` tag with `@volatile` or `@streaming` tags, Excel ignores the synchronous support. Volatile or streaming support takes precedence.
5253
5354
### Code sample
5455

0 commit comments

Comments
 (0)