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/excel/custom-functions-custom-enums.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
@@ -16,7 +16,7 @@ Custom enums give users Excel AutoComplete options for your custom functions. Th
16
16
Define your enum with the JSDoc tag `@customenum`. The corresponding JSON properties are then autogenerated in your custom function metadata. For more information about JSDoc tags and custom functions, see [Basics of JSDoc tags](custom-functions-json-autogeneration.md#basics-of-jsdoc-tags).
17
17
18
18
> [!NOTE]
19
-
> Custom enums created with the `@customenum` JSDoc tag are only supported in TypeScript. They are not supported in JavaScript. To use custom enums with JavaScript functions, you must manually create your own JSON metadata. To learn more, see [Manually create JSON metadata](custom-functions-json.md).
19
+
> Custom enums created with the `@customenum` JSDoc tag are only supported in TypeScript. They are not supported in JavaScript. To use custom enums with JavaScript functions, you must manually create your own JSON metadata. To learn more, see [Manually create JSON metadata: enums](custom-functions-json.md#enums).
20
20
21
21
The following code snippet shows how to define and use a simple custom enum as a parameter.
@@ -114,6 +118,20 @@ If the last function parameter is of type `CustomFunctions.CancelableInvocation`
114
118
115
119
A function can't have both `@cancelable` and `@streaming` tags.
116
120
121
+
<aid="capturesCallingObject"></a>
122
+
123
+
### @capturesCallingObject
124
+
125
+
This tag works with Excel [data types](excel-data-types-overview.md). It specifies that the data type being referenced by the custom function is passed as the first argument to the custom function. For more information, see [Reference the entity value as a calling object](excel-add-ins-dot-functions.md#reference-the-entity-value-as-a-calling-object).
126
+
127
+
<aid="customenum"></a>
128
+
129
+
### @customenum
130
+
131
+
Syntax: @customenum*{type}*
132
+
133
+
This tag indicates that a set of values is a custom enum. For more information, see [Create custom enums for your custom functions](custom-functions-custom-enums.md).
134
+
117
135
<aid="customfunction"></a>
118
136
119
137
### @customfunction
@@ -183,6 +201,14 @@ In the following example, the phrase "A function that adds two numbers" is the d
183
201
*/
184
202
```
185
203
204
+
<aid="excludeFromAutoComplete"></a>
205
+
206
+
### @excludeFromAutoComplete
207
+
208
+
The `@excludeFromAutoComplete` tag ensures that the custom function doesn't appear in the formula AutoComplete menu in Excel. For more information, see [Exclude custom functions from the Excel UI](excel-add-ins-dot-functions.md#exclude-custom-functions-from-the-excel-ui).
209
+
210
+
A function can’t have both `@excludeFromAutoComplete` and `@linkedEntityLoadService` tags.
211
+
186
212
<aid="helpurl"></a>
187
213
188
214
### @helpurl
@@ -202,6 +228,14 @@ In the following example, the `helpurl` is `http://www.contoso.com/weatherhelp`.
202
228
*/
203
229
```
204
230
231
+
<aid="linkedEntityLoadService"></a>
232
+
233
+
### @linkedEntityLoadService
234
+
235
+
The `@linkedEntityLoadService` tag designates that the function is a linked entity load service that returns [linked entity cell values](excel-data-types-linked-entity-cell-values.md) for linked entity IDs requested by Excel.
236
+
237
+
A function can’t have both `@excludeFromAutoComplete` and `@linkedEntityLoadService` tags.
0 commit comments