Skip to content

Commit d3a5fcd

Browse files
author
github-actions
committed
Merge branch 'main' into live
2 parents a0bb973 + 5d2ea06 commit d3a5fcd

File tree

538 files changed

+128978
-68600
lines changed

Some content is hidden

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

538 files changed

+128978
-68600
lines changed

‎docs/docfx.json‎

Lines changed: 9 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,15 @@
1414
"**/obj/**",
1515
"**/includes/**",
1616
"**/_themes/**",
17-
"**/_themes.pdf/**",
18-
"README.md",
19-
"LICENSE",
20-
"LICENSE-CODE",
21-
"ThirdPartyNotices"
17+
"**/_themes.pdf/**"
2218
]
2319
},
2420
{
2521
"files": ["**/*.md"],
26-
"exclude": ["manifest.md"],
2722
"group": "all",
2823
"src": "manifest",
29-
"dest": "api/manifest"
24+
"dest": "api/manifest",
25+
"exclude": ["manifest.md"]
3026
},
3127
{
3228
"files": ["manifest.md"],
@@ -36,10 +32,10 @@
3632
},
3733
{
3834
"files": ["**/*.md"],
39-
"exclude": ["requirement-sets.md"],
4035
"group": "all",
4136
"src": "requirement-sets",
42-
"dest": "api/requirement-sets"
37+
"dest": "api/requirement-sets",
38+
"exclude": ["requirement-sets.md"]
4339
},
4440
{
4541
"files": ["requirement-sets.md"],
@@ -59,60 +55,30 @@
5955
"src": "breadcrumb",
6056
"dest": "office_js_breadcrumb"
6157
},
62-
{
63-
"files": ["**/toc.yml"],
64-
"group": "common-js-toc",
65-
"src": "docs-ref-autogen/common",
66-
"dest": "api/office-js-docs-reference"
67-
},
6858
{
6959
"files": ["**/*.md", "**/*.yml"],
7060
"group": "common-js-toc",
7161
"src": "docs-ref-autogen/common",
7262
"dest": "api"
7363
},
74-
{
75-
"files": ["**/toc.yml"],
76-
"group": "common-js-preview-toc",
77-
"src": "docs-ref-autogen/common_preview",
78-
"dest": "api/office-js-docs-reference"
79-
},
8064
{
8165
"files": ["**/*.md", "**/*.yml"],
8266
"group": "common-js-preview-toc",
8367
"src": "docs-ref-autogen/common_preview",
8468
"dest": "api"
8569
},
86-
{
87-
"files": ["**/toc.yml"],
88-
"group": "common-js",
89-
"src": "docs-ref-autogen/office_release",
90-
"dest": "api/office-js-docs-reference"
91-
},
9270
{
9371
"files": ["**/*.md", "**/*.yml"],
9472
"group": "common-js",
9573
"src": "docs-ref-autogen/office_release",
9674
"dest": "api"
9775
},
98-
{
99-
"files": ["**/toc.yml"],
100-
"group": "common-js-preview",
101-
"src": "docs-ref-autogen/office",
102-
"dest": "api/office-js-docs-reference"
103-
},
10476
{
10577
"files": ["**/*.md", "**/*.yml"],
10678
"group": "common-js-preview",
10779
"src": "docs-ref-autogen/office",
10880
"dest": "api"
10981
},
110-
{
111-
"files": ["**/toc.yml"],
112-
"group": "office-runtime",
113-
"src": "docs-ref-autogen/office-runtime",
114-
"dest": "api/office-js-docs-reference"
115-
},
11682
{
11783
"files": ["**/*.md", "**/*.yml"],
11884
"group": "office-runtime",
@@ -909,7 +875,6 @@
909875
},
910876
{
911877
"files": ["**/*.png", "**/*.jpg", "**/*.svg"],
912-
"exclude": ["**/obj/**", "**/includes/**"],
913878
"src": "manifest",
914879
"dest": "api/manifest"
915880
}
@@ -1228,72 +1193,13 @@
12281193
},
12291194
"fileMetadata": {
12301195
"ms.service": {
1231-
"docs-ref-autogen/excel/**": "excel",
1196+
"docs-ref-autogen/excel*/**": "excel",
12321197
"docs-ref-autogen/excel/office-runtime/**": "microsoft-365",
1233-
"docs-ref-autogen/excel_1_1/**": "excel",
1234-
"docs-ref-autogen/excel_1_2/**": "excel",
1235-
"docs-ref-autogen/excel_1_3/**": "excel",
1236-
"docs-ref-autogen/excel_1_4/**": "excel",
1237-
"docs-ref-autogen/excel_1_5/**": "excel",
1238-
"docs-ref-autogen/excel_1_6/**": "excel",
1239-
"docs-ref-autogen/excel_1_7/**": "excel",
1240-
"docs-ref-autogen/excel_1_8/**": "excel",
1241-
"docs-ref-autogen/excel_1_9/**": "excel",
1242-
"docs-ref-autogen/excel_1_10/**": "excel",
1243-
"docs-ref-autogen/excel_1_11/**": "excel",
1244-
"docs-ref-autogen/excel_1_12/**": "excel",
1245-
"docs-ref-autogen/excel_1_13/**": "excel",
1246-
"docs-ref-autogen/excel_1_14/**": "excel",
1247-
"docs-ref-autogen/excel_1_15/**": "excel",
1248-
"docs-ref-autogen/excel_1_16/**": "excel",
1249-
"docs-ref-autogen/excel_1_17/**": "excel",
1250-
"docs-ref-autogen/excel_1_18/**": "excel",
1251-
"docs-ref-autogen/excel_1_19/**": "excel",
1252-
"docs-ref-autogen/excel_online/**": "excel",
12531198
"docs-ref-autogen/onenote/**": "onenote",
1254-
"docs-ref-autogen/outlook/**": "outlook",
1255-
"docs-ref-autogen/outlook_1_1/**": "outlook",
1256-
"docs-ref-autogen/outlook_1_2/**": "outlook",
1257-
"docs-ref-autogen/outlook_1_3/**": "outlook",
1258-
"docs-ref-autogen/outlook_1_4/**": "outlook",
1259-
"docs-ref-autogen/outlook_1_5/**": "outlook",
1260-
"docs-ref-autogen/outlook_1_6/**": "outlook",
1261-
"docs-ref-autogen/outlook_1_7/**": "outlook",
1262-
"docs-ref-autogen/outlook_1_8/**": "outlook",
1263-
"docs-ref-autogen/outlook_1_9/**": "outlook",
1264-
"docs-ref-autogen/outlook_1_10/**": "outlook",
1265-
"docs-ref-autogen/outlook_1_11/**": "outlook",
1266-
"docs-ref-autogen/outlook_1_12/**": "outlook",
1267-
"docs-ref-autogen/outlook_1_13/**": "outlook",
1268-
"docs-ref-autogen/outlook_1_14/**": "outlook",
1269-
"docs-ref-autogen/outlook_1_15/**": "outlook",
1270-
"docs-ref-autogen/powerpoint/**": "powerpoint",
1271-
"docs-ref-autogen/powerpoint_1_1/**": "powerpoint",
1272-
"docs-ref-autogen/powerpoint_1_2/**": "powerpoint",
1273-
"docs-ref-autogen/powerpoint_1_3/**": "powerpoint",
1274-
"docs-ref-autogen/powerpoint_1_4/**": "powerpoint",
1275-
"docs-ref-autogen/powerpoint_1_5/**": "powerpoint",
1276-
"docs-ref-autogen/powerpoint_1_6/**": "powerpoint",
1277-
"docs-ref-autogen/powerpoint_1_7/**": "powerpoint",
1278-
"docs-ref-autogen/powerpoint_1_8/**": "powerpoint",
1279-
"docs-ref-autogen/powerpoint_1_9/**": "powerpoint",
1199+
"docs-ref-autogen/outlook*/**": "outlook",
1200+
"docs-ref-autogen/powerpoint*/**": "powerpoint",
12801201
"docs-ref-autogen/visio/**": "visio",
1281-
"docs-ref-autogen/word/**": "word",
1282-
"docs-ref-autogen/word_1_1/**": "word",
1283-
"docs-ref-autogen/word_1_2/**": "word",
1284-
"docs-ref-autogen/word_1_3/**": "word",
1285-
"docs-ref-autogen/word_1_4/**": "word",
1286-
"docs-ref-autogen/word_1_5/**": "word",
1287-
"docs-ref-autogen/word_1_6/**": "word",
1288-
"docs-ref-autogen/word_1_7/**": "word",
1289-
"docs-ref-autogen/word_1_8/**": "word",
1290-
"docs-ref-autogen/word_1_9/**": "word",
1291-
"docs-ref-autogen/word_online/**": "word",
1292-
"docs-ref-autogen/word_1_3_hidden_document/**": "word",
1293-
"docs-ref-autogen/word_1_4_hidden_document/**": "word",
1294-
"docs-ref-autogen/word_1_5_hidden_document/**": "word",
1295-
"docs-ref-autogen/word_desktop_1_1/**": "word",
1296-
"docs-ref-autogen/word_desktop_1_2/**": "word",
1202+
"docs-ref-autogen/word*/**": "word",
12971203
"requirement-sets/excel/**": "excel",
12981204
"requirement-sets/onenote/**": "onenote",
12991205
"requirement-sets/outlook/**": "outlook",

‎docs/docs-ref-autogen/common/toc.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ items:
211211
- name: VisibilityModeChangedMessage
212212
uid: office!Office.VisibilityModeChangedMessage:interface
213213
- name: OfficeExtension
214+
uid: ''
214215
items:
215216
- name: ClientObject
216217
uid: office!OfficeExtension.ClientObject:class

‎docs/docs-ref-autogen/common_preview/toc.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ items:
211211
- name: VisibilityModeChangedMessage
212212
uid: office!Office.VisibilityModeChangedMessage:interface
213213
- name: OfficeExtension
214+
uid: ''
214215
items:
215216
- name: ClientObject
216217
uid: office!OfficeExtension.ClientObject:class

‎docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@ uid: excel!Excel.CardLayout:type
44
package: excel!
55
fullName: Excel.CardLayout
66
summary: Represents the layout of a card in card view.
7-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
Learn more about the types in this type alias through the following links.
13+
14+
15+
[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout),
16+
[Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)
817
918
isPreview: false
1019
isDeprecated: false

‎docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type
44
package: excel!
55
fullName: Excel.CardLayoutSection
66
summary: Represents the layout of a section of a card in card view.
7-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
Learn more about the types in this type alias through the following links.
13+
14+
15+
[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection),
16+
[Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection),
17+
[Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)
818
919
isPreview: false
1020
isDeprecated: false

‎docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml‎

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type
44
package: excel!
55
fullName: Excel.CellControl
66
summary: Represents an interactable control inside of a cell.
7-
remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
13+
14+
Learn more about the types in this type alias through the following links.
15+
16+
17+
[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol),
18+
[Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol),
19+
[Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol),
20+
[Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)
21+
22+
23+
#### Examples
24+
25+
26+
```TypeScript
27+
28+
// Link to full sample:
29+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml
30+
31+
32+
// Add checkboxes to the table.
33+
34+
await Excel.run(async (context) => {
35+
const sheet = context.workbook.worksheets.getActiveWorksheet();
36+
37+
// Get the second column in the table, without the header.
38+
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();
39+
40+
// Change the boolean values to checkboxes.
41+
range.control = {
42+
type: Excel.CellControlType.checkbox
43+
};
44+
await context.sync();
45+
});
46+
47+
```
848
949
isPreview: false
1050
isDeprecated: false

‎docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,30 @@ uid: excel!Excel.CellValue:type
44
package: excel!
55
fullName: Excel.CellValue
66
summary: Represents the value in a cell.
7-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
Learn more about the types in this type alias through the following links.
13+
14+
15+
[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue),
16+
[Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue),
17+
[Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue),
18+
[Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue),
19+
[Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue),
20+
[Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue),
21+
[Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue),
22+
[Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue),
23+
[Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue),
24+
[Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue),
25+
[Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue),
26+
[Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue),
27+
[Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue),
28+
[Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue),
29+
[Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue),
30+
[Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)
831
932
isPreview: false
1033
isDeprecated: false

‎docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata
66
summary: >-
77
Represents the value and metadata of a property. The metadata applies to the
88
property (and not the value), but it is combined with the value in this type.
9-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)"
9+
remarks: >-
10+
\[ [API set: ExcelApi
11+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
12+
13+
14+
Learn more about the types in this type alias through the following links.
15+
16+
17+
[Excel.CellValue](/javascript/api/excel/excel.cellvalue),
18+
[Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)
1019
1120
isPreview: false
1221
isDeprecated: false

‎docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ fullName: Excel.CompactLayout
66
summary: >-
77
Represents the layout used when there is limited space to represent the
88
entity.
9-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)"
9+
remarks: >-
10+
\[ [API set: ExcelApi
11+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
12+
13+
14+
Learn more about the types in this type alias through the following links.
15+
16+
17+
[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)
1018
1119
isPreview: false
1220
isDeprecated: false

‎docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type
44
package: excel!
55
fullName: Excel.EntityPropertyType
66
summary: Represents the value of a property.
7-
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)"
7+
remarks: >-
8+
\[ [API set: ExcelApi
9+
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
10+
11+
12+
Learn more about the types in this type alias through the following links.
13+
14+
15+
[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata),
16+
[Excel.CellValue](/javascript/api/excel/excel.cellvalue)
817
918
isPreview: false
1019
isDeprecated: false

0 commit comments

Comments
 (0)