Skip to content

Commit 63878e9

Browse files
samantharamonsamantharamon
authored
[UI/UX] (context menu) Add code snippets to ContextMenu APIs (#2299)
1 parent 9d7768f commit 63878e9

File tree

8 files changed

+222
-0
lines changed

8 files changed

+222
-0
lines changed

‎docs/code-snippets/office-snippets.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1245,6 +1245,51 @@ Office.ContextInformation#version:member:
12451245
- |-
12461246
const contextInfo = Office.context.diagnostics;
12471247
console.log("Office version: " + contextInfo.version);
1248+
Office.ContextMenu#requestUpdate:member(1):
1249+
- |-
1250+
// Change the availability of custom buttons on the context menu.
1251+
await Office.contextMenu.requestUpdate({
1252+
controls: [
1253+
{
1254+
id: Addin.CtxMenu.Button1,
1255+
enabled: true
1256+
},
1257+
{
1258+
id: Addin.CtxMenu.Button2,
1259+
enabled: false
1260+
},
1261+
]
1262+
});
1263+
Office.ContextMenuControl:interface:
1264+
- |-
1265+
// Change the availability of custom buttons on the context menu.
1266+
await Office.contextMenu.requestUpdate({
1267+
controls: [
1268+
{
1269+
id: Addin.CtxMenu.Button1,
1270+
enabled: true
1271+
},
1272+
{
1273+
id: Addin.CtxMenu.Button2,
1274+
enabled: false
1275+
},
1276+
]
1277+
});
1278+
Office.ContextMenuUpdaterData#controls:member:
1279+
- |-
1280+
// Change the availability of custom buttons on the context menu.
1281+
await Office.contextMenu.requestUpdate({
1282+
controls: [
1283+
{
1284+
id: Addin.CtxMenu.Button1,
1285+
enabled: true
1286+
},
1287+
{
1288+
id: Addin.CtxMenu.Button2,
1289+
enabled: false
1290+
},
1291+
]
1292+
});
12481293
Office.CustomXmlNode#baseName:member:
12491294
- |-
12501295
function showXmlNodeBaseNames() {

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,29 @@ methods:
3333
the exact timing of the context menu update (or refresh) can't be
3434
determined by the completion of this API.
3535
36+
37+
#### Examples
38+
39+
40+
```TypeScript
41+
42+
// Change the availability of custom buttons on the context menu.
43+
44+
await Office.contextMenu.requestUpdate({
45+
controls: [
46+
{
47+
id: Addin.CtxMenu.Button1,
48+
enabled: true
49+
},
50+
{
51+
id: Addin.CtxMenu.Button2,
52+
enabled: false
53+
},
54+
]
55+
});
56+
57+
```
58+
3659
isPreview: false
3760
isDeprecated: false
3861
syntax:

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,29 @@ remarks: >-
1414
**Requirement set**: [ContextMenuAPI
1515
1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets)
1616
17+
18+
#### Examples
19+
20+
21+
```TypeScript
22+
23+
// Change the availability of custom buttons on the context menu.
24+
25+
await Office.contextMenu.requestUpdate({
26+
controls: [
27+
{
28+
id: Addin.CtxMenu.Button1,
29+
enabled: true
30+
},
31+
{
32+
id: Addin.CtxMenu.Button2,
33+
enabled: false
34+
},
35+
]
36+
});
37+
38+
```
39+
1740
isPreview: false
1841
isDeprecated: false
1942
type: interface

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,23 @@ properties:
3333
content: 'controls: ContextMenuControl[];'
3434
return:
3535
type: <xref uid="office!Office.ContextMenuControl:interface" />[]
36+
description: |-
37+
38+
39+
#### Examples
40+
41+
```TypeScript
42+
// Change the availability of custom buttons on the context menu.
43+
await Office.contextMenu.requestUpdate({
44+
controls: [
45+
{
46+
id: Addin.CtxMenu.Button1,
47+
enabled: true
48+
},
49+
{
50+
id: Addin.CtxMenu.Button2,
51+
enabled: false
52+
},
53+
]
54+
});
55+
```

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,29 @@ methods:
3333
the exact timing of the context menu update (or refresh) can't be
3434
determined by the completion of this API.
3535
36+
37+
#### Examples
38+
39+
40+
```TypeScript
41+
42+
// Change the availability of custom buttons on the context menu.
43+
44+
await Office.contextMenu.requestUpdate({
45+
controls: [
46+
{
47+
id: Addin.CtxMenu.Button1,
48+
enabled: true
49+
},
50+
{
51+
id: Addin.CtxMenu.Button2,
52+
enabled: false
53+
},
54+
]
55+
});
56+
57+
```
58+
3659
isPreview: false
3760
isDeprecated: false
3861
syntax:

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,29 @@ remarks: >-
1414
**Requirement set**: [ContextMenuAPI
1515
1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets)
1616
17+
18+
#### Examples
19+
20+
21+
```TypeScript
22+
23+
// Change the availability of custom buttons on the context menu.
24+
25+
await Office.contextMenu.requestUpdate({
26+
controls: [
27+
{
28+
id: Addin.CtxMenu.Button1,
29+
enabled: true
30+
},
31+
{
32+
id: Addin.CtxMenu.Button2,
33+
enabled: false
34+
},
35+
]
36+
});
37+
38+
```
39+
1740
isPreview: false
1841
isDeprecated: false
1942
type: interface

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,23 @@ properties:
3333
content: 'controls: ContextMenuControl[];'
3434
return:
3535
type: <xref uid="office!Office.ContextMenuControl:interface" />[]
36+
description: |-
37+
38+
39+
#### Examples
40+
41+
```TypeScript
42+
// Change the availability of custom buttons on the context menu.
43+
await Office.contextMenu.requestUpdate({
44+
controls: [
45+
{
46+
id: Addin.CtxMenu.Button1,
47+
enabled: true
48+
},
49+
{
50+
id: Addin.CtxMenu.Button2,
51+
enabled: false
52+
},
53+
]
54+
});
55+
```

‎generate-docs/script-inputs/local-repo-snippets.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2855,6 +2855,51 @@ Office.ContextInformation#version:member:
28552855
- |-
28562856
const contextInfo = Office.context.diagnostics;
28572857
console.log("Office version: " + contextInfo.version);
2858+
Office.ContextMenu#requestUpdate:member(1):
2859+
- |-
2860+
// Change the availability of custom buttons on the context menu.
2861+
await Office.contextMenu.requestUpdate({
2862+
controls: [
2863+
{
2864+
id: Addin.CtxMenu.Button1,
2865+
enabled: true
2866+
},
2867+
{
2868+
id: Addin.CtxMenu.Button2,
2869+
enabled: false
2870+
},
2871+
]
2872+
});
2873+
Office.ContextMenuControl:interface:
2874+
- |-
2875+
// Change the availability of custom buttons on the context menu.
2876+
await Office.contextMenu.requestUpdate({
2877+
controls: [
2878+
{
2879+
id: Addin.CtxMenu.Button1,
2880+
enabled: true
2881+
},
2882+
{
2883+
id: Addin.CtxMenu.Button2,
2884+
enabled: false
2885+
},
2886+
]
2887+
});
2888+
Office.ContextMenuUpdaterData#controls:member:
2889+
- |-
2890+
// Change the availability of custom buttons on the context menu.
2891+
await Office.contextMenu.requestUpdate({
2892+
controls: [
2893+
{
2894+
id: Addin.CtxMenu.Button1,
2895+
enabled: true
2896+
},
2897+
{
2898+
id: Addin.CtxMenu.Button2,
2899+
enabled: false
2900+
},
2901+
]
2902+
});
28582903
Office.CustomXmlNode#baseName:member:
28592904
- |-
28602905
function showXmlNodeBaseNames() {

0 commit comments

Comments
 (0)