diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index ce0f1a7f5..8191de304 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -48,6 +48,7 @@ "powerpoint-js-1.3", "powerpoint-js-1.4", "powerpoint-js-1.5", + "powerpoint-js-1.6", "visio-js-1.1", "word-js-preview", "word-js-1.1", @@ -288,6 +289,10 @@ "ReferenceTOC": "docs/docs-ref-autogen/powerpoint_1_5/toc.yml", "ConceptualTOCUrl": "/office/dev/add-ins/toc.json" }, + { + "ReferenceTOC": "docs/docs-ref-autogen/powerpoint_1_6/toc.yml", + "ConceptualTOCUrl": "/office/dev/add-ins/toc.json" + }, { "ReferenceTOC": "docs/docs-ref-autogen/visio/toc.yml", "ConceptualTOCUrl": "/office/dev/add-ins/toc.json" diff --git a/docs/docfx.json b/docs/docfx.json index 389e15b6f..40a097aa9 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -611,6 +611,18 @@ "src": "docs-ref-autogen/powerpoint_1_5", "dest": "api" }, + { + "files": ["**/toc.yml"], + "group": "powerpoint-js-1.6", + "src": "docs-ref-autogen/powerpoint_1_6", + "dest": "api/office-js-docs-reference" + }, + { + "files": ["**/*.md", "**/*.yml"], + "group": "powerpoint-js-1.6", + "src": "docs-ref-autogen/powerpoint_1_6", + "dest": "api" + }, { "files": ["**/toc.yml"], "group": "visio-js-1.1", @@ -971,6 +983,10 @@ "dest": "powerpoint-js-1.5", "moniker_range": "powerpoint-js-1.5" }, + "powerpoint-js-1.6": { + "dest": "powerpoint-js-1.6", + "moniker_range": "powerpoint-js-1.6" + }, "visio-js-1.1": { "dest": "visio-js-1.1", "moniker_range": "visio-js-1.1" @@ -1126,6 +1142,7 @@ "docs-ref-autogen/powerpoint_1_3/**": "powerpoint", "docs-ref-autogen/powerpoint_1_4/**": "powerpoint", "docs-ref-autogen/powerpoint_1_5/**": "powerpoint", + "docs-ref-autogen/powerpoint_1_6/**": "powerpoint", "docs-ref-autogen/visio/**": "visio", "docs-ref-autogen/word/**": "word", "docs-ref-autogen/word_1_1/**": "word", diff --git a/docs/docs-ref-autogen/common/toc.yml b/docs/docs-ref-autogen/common/toc.yml index d8532932b..aba4b5e61 100644 --- a/docs/docs-ref-autogen/common/toc.yml +++ b/docs/docs-ref-autogen/common/toc.yml @@ -806,6 +806,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/common_preview/toc.yml b/docs/docs-ref-autogen/common_preview/toc.yml index fa01db109..fe0bae65c 100644 --- a/docs/docs-ref-autogen/common_preview/toc.yml +++ b/docs/docs-ref-autogen/common_preview/toc.yml @@ -808,6 +808,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml index 7302291b8..ad4748ead 100644 --- a/docs/docs-ref-autogen/excel/toc.yml +++ b/docs/docs-ref-autogen/excel/toc.yml @@ -1952,6 +1952,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_1/toc.yml b/docs/docs-ref-autogen/excel_1_1/toc.yml index 1fea27fe9..1e67d5e6c 100644 --- a/docs/docs-ref-autogen/excel_1_1/toc.yml +++ b/docs/docs-ref-autogen/excel_1_1/toc.yml @@ -948,6 +948,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_10/toc.yml b/docs/docs-ref-autogen/excel_1_10/toc.yml index 4e27fe927..cafdd6d93 100644 --- a/docs/docs-ref-autogen/excel_1_10/toc.yml +++ b/docs/docs-ref-autogen/excel_1_10/toc.yml @@ -1632,6 +1632,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_11/toc.yml b/docs/docs-ref-autogen/excel_1_11/toc.yml index 967e0e365..b0169a6df 100644 --- a/docs/docs-ref-autogen/excel_1_11/toc.yml +++ b/docs/docs-ref-autogen/excel_1_11/toc.yml @@ -1644,6 +1644,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_12/toc.yml b/docs/docs-ref-autogen/excel_1_12/toc.yml index 4a55b112f..0c9c596f9 100644 --- a/docs/docs-ref-autogen/excel_1_12/toc.yml +++ b/docs/docs-ref-autogen/excel_1_12/toc.yml @@ -1690,6 +1690,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_13/toc.yml b/docs/docs-ref-autogen/excel_1_13/toc.yml index a54a5ecee..77712ac27 100644 --- a/docs/docs-ref-autogen/excel_1_13/toc.yml +++ b/docs/docs-ref-autogen/excel_1_13/toc.yml @@ -1700,6 +1700,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_14/toc.yml b/docs/docs-ref-autogen/excel_1_14/toc.yml index 78f83b119..a328b7c97 100644 --- a/docs/docs-ref-autogen/excel_1_14/toc.yml +++ b/docs/docs-ref-autogen/excel_1_14/toc.yml @@ -1718,6 +1718,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_15/toc.yml b/docs/docs-ref-autogen/excel_1_15/toc.yml index 034d49a49..b39466f66 100644 --- a/docs/docs-ref-autogen/excel_1_15/toc.yml +++ b/docs/docs-ref-autogen/excel_1_15/toc.yml @@ -1722,6 +1722,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_16/toc.yml b/docs/docs-ref-autogen/excel_1_16/toc.yml index 0f80cf8dc..2b78ea64c 100644 --- a/docs/docs-ref-autogen/excel_1_16/toc.yml +++ b/docs/docs-ref-autogen/excel_1_16/toc.yml @@ -1852,6 +1852,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_17/toc.yml b/docs/docs-ref-autogen/excel_1_17/toc.yml index 044a5efeb..defaae153 100644 --- a/docs/docs-ref-autogen/excel_1_17/toc.yml +++ b/docs/docs-ref-autogen/excel_1_17/toc.yml @@ -1858,6 +1858,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_2/toc.yml b/docs/docs-ref-autogen/excel_1_2/toc.yml index cfbc7126c..99c3b0840 100644 --- a/docs/docs-ref-autogen/excel_1_2/toc.yml +++ b/docs/docs-ref-autogen/excel_1_2/toc.yml @@ -1045,6 +1045,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_3/toc.yml b/docs/docs-ref-autogen/excel_1_3/toc.yml index 59237f1ee..48b5c51f2 100644 --- a/docs/docs-ref-autogen/excel_1_3/toc.yml +++ b/docs/docs-ref-autogen/excel_1_3/toc.yml @@ -1053,6 +1053,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_4/toc.yml b/docs/docs-ref-autogen/excel_1_4/toc.yml index 162687417..3d41798b4 100644 --- a/docs/docs-ref-autogen/excel_1_4/toc.yml +++ b/docs/docs-ref-autogen/excel_1_4/toc.yml @@ -1061,6 +1061,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_5/toc.yml b/docs/docs-ref-autogen/excel_1_5/toc.yml index 37e267b73..a557d00a8 100644 --- a/docs/docs-ref-autogen/excel_1_5/toc.yml +++ b/docs/docs-ref-autogen/excel_1_5/toc.yml @@ -1069,6 +1069,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_6/toc.yml b/docs/docs-ref-autogen/excel_1_6/toc.yml index 65760a27e..64dff5054 100644 --- a/docs/docs-ref-autogen/excel_1_6/toc.yml +++ b/docs/docs-ref-autogen/excel_1_6/toc.yml @@ -1151,6 +1151,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_7/toc.yml b/docs/docs-ref-autogen/excel_1_7/toc.yml index a74c73168..8d5a9a923 100644 --- a/docs/docs-ref-autogen/excel_1_7/toc.yml +++ b/docs/docs-ref-autogen/excel_1_7/toc.yml @@ -1253,6 +1253,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_8/toc.yml b/docs/docs-ref-autogen/excel_1_8/toc.yml index c929b3cf4..57c9290ae 100644 --- a/docs/docs-ref-autogen/excel_1_8/toc.yml +++ b/docs/docs-ref-autogen/excel_1_8/toc.yml @@ -1347,6 +1347,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_1_9/toc.yml b/docs/docs-ref-autogen/excel_1_9/toc.yml index 6fccf78ce..ee1521848 100644 --- a/docs/docs-ref-autogen/excel_1_9/toc.yml +++ b/docs/docs-ref-autogen/excel_1_9/toc.yml @@ -1588,6 +1588,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/excel_online/toc.yml b/docs/docs-ref-autogen/excel_online/toc.yml index e8ee37471..565a5875f 100644 --- a/docs/docs-ref-autogen/excel_online/toc.yml +++ b/docs/docs-ref-autogen/excel_online/toc.yml @@ -1874,6 +1874,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/onenote/toc.yml b/docs/docs-ref-autogen/onenote/toc.yml index 4d2f59d6d..f691b38ac 100644 --- a/docs/docs-ref-autogen/onenote/toc.yml +++ b/docs/docs-ref-autogen/onenote/toc.yml @@ -910,6 +910,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml index 2ae329523..98c20fa87 100644 --- a/docs/docs-ref-autogen/outlook/toc.yml +++ b/docs/docs-ref-autogen/outlook/toc.yml @@ -1006,6 +1006,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_1/toc.yml b/docs/docs-ref-autogen/outlook_1_1/toc.yml index 09e9a1e7d..9c62abb72 100644 --- a/docs/docs-ref-autogen/outlook_1_1/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml @@ -876,6 +876,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_10/toc.yml b/docs/docs-ref-autogen/outlook_1_10/toc.yml index 4c40507cb..a2c053ead 100644 --- a/docs/docs-ref-autogen/outlook_1_10/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml @@ -966,6 +966,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_11/toc.yml b/docs/docs-ref-autogen/outlook_1_11/toc.yml index 4c393d39d..e77536fd0 100644 --- a/docs/docs-ref-autogen/outlook_1_11/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml @@ -968,6 +968,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_12/toc.yml b/docs/docs-ref-autogen/outlook_1_12/toc.yml index 427c75b49..2c6f62692 100644 --- a/docs/docs-ref-autogen/outlook_1_12/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml @@ -970,6 +970,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_13/toc.yml b/docs/docs-ref-autogen/outlook_1_13/toc.yml index 23d076470..abdd70d0a 100644 --- a/docs/docs-ref-autogen/outlook_1_13/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml @@ -982,6 +982,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_14/toc.yml b/docs/docs-ref-autogen/outlook_1_14/toc.yml index 53a53557e..d58da13e8 100644 --- a/docs/docs-ref-autogen/outlook_1_14/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml @@ -996,6 +996,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_2/toc.yml b/docs/docs-ref-autogen/outlook_1_2/toc.yml index e7289c8fe..30ab91632 100644 --- a/docs/docs-ref-autogen/outlook_1_2/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml @@ -878,6 +878,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_3/toc.yml b/docs/docs-ref-autogen/outlook_1_3/toc.yml index 8520f6074..4b10c46ab 100644 --- a/docs/docs-ref-autogen/outlook_1_3/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml @@ -886,6 +886,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_4/toc.yml b/docs/docs-ref-autogen/outlook_1_4/toc.yml index 8520f6074..4b10c46ab 100644 --- a/docs/docs-ref-autogen/outlook_1_4/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml @@ -886,6 +886,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_5/toc.yml b/docs/docs-ref-autogen/outlook_1_5/toc.yml index 8520f6074..4b10c46ab 100644 --- a/docs/docs-ref-autogen/outlook_1_5/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml @@ -886,6 +886,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_6/toc.yml b/docs/docs-ref-autogen/outlook_1_6/toc.yml index 8520f6074..4b10c46ab 100644 --- a/docs/docs-ref-autogen/outlook_1_6/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml @@ -886,6 +886,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_7/toc.yml b/docs/docs-ref-autogen/outlook_1_7/toc.yml index 6fac0f703..9ce302792 100644 --- a/docs/docs-ref-autogen/outlook_1_7/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml @@ -916,6 +916,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_8/toc.yml b/docs/docs-ref-autogen/outlook_1_8/toc.yml index 0a4d3bd74..683bde495 100644 --- a/docs/docs-ref-autogen/outlook_1_8/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml @@ -950,6 +950,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/outlook_1_9/toc.yml b/docs/docs-ref-autogen/outlook_1_9/toc.yml index 0a4d3bd74..683bde495 100644 --- a/docs/docs-ref-autogen/outlook_1_9/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml @@ -950,6 +950,10 @@ items: - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: >- ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md diff --git a/docs/docs-ref-autogen/overview/overview.md b/docs/docs-ref-autogen/overview/overview.md index 02ba9b59f..8f2bbe6e0 100644 --- a/docs/docs-ref-autogen/overview/overview.md +++ b/docs/docs-ref-autogen/overview/overview.md @@ -3,7 +3,7 @@ ms.topic: landing-page title: Office JavaScript API reference description: The Office JavaScript APIs by host and version. ms.localizationpriority: high -ms.date: 08/29/2024 +ms.date: 10/07/2024 --- # Office Add-ins JavaScript API reference @@ -92,6 +92,7 @@ The following is a list of APIs for the [supported Office host applications](/of

PowerPoint APIs

|||| +|Office on the web|||| +|Office on Windows
  • Microsoft 365 subscription
  • retail perpetual Office 2016 and later
    • |||| |Office 2021 on Windows
    (volume-licensed perpetual)|||| |Office 2019 on Windows
    (volume-licensed perpetual)||Not available|| |Office 2016 on Windows
    (volume-licensed perpetual)||Not available|| -|Office on Mac|||| +|Office on Mac|||| +|Office on iPad|||| ** Added with post-release updates.* diff --git a/docs/requirement-sets/toc.yml b/docs/requirement-sets/toc.yml index d88474db7..ed747a315 100644 --- a/docs/requirement-sets/toc.yml +++ b/docs/requirement-sets/toc.yml @@ -268,6 +268,9 @@ - name: PowerPoint preview APIs href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint - name: PowerPointApi 1.5 requirement set href: ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md displayName: PowerPoint diff --git a/generate-docs/GenerateDocs.sh b/generate-docs/GenerateDocs.sh index 868a81f50..1eb200917 100644 --- a/generate-docs/GenerateDocs.sh +++ b/generate-docs/GenerateDocs.sh @@ -97,6 +97,7 @@ node version-remover ../api-extractor-inputs-outlook-release/outlook_1_2/outlook node ../scripts/versioned-dts-cleanup ../api-extractor-inputs-outlook-release/outlook_1_1/outlook.d.ts Outlook 1.1 node version-remover ../api-extractor-inputs-outlook-release/outlook_1_1/outlook.d.ts "Mailbox 1.1" ./tool-inputs/outlook-base.d.ts +node version-remover ../api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts "PowerPointApi 1.6" ../api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts node version-remover ../api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts "PowerPointApi 1.5" ../api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts node version-remover ../api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts "PowerPointApi 1.4" ../api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts node version-remover ../api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts "PowerPointApi 1.3" ../api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts @@ -163,7 +164,8 @@ node whats-new outlook ../api-extractor-inputs-outlook-release/outlook_1_3/outlo node whats-new outlook ../api-extractor-inputs-outlook-release/outlook_1_2/outlook.d.ts ../api-extractor-inputs-outlook-release/outlook_1_1/outlook.d.ts ../../docs/includes/outlook-1_2 node whats-new outlook ../api-extractor-inputs-outlook-release/outlook_1_1/outlook.d.ts ./tool-inputs/outlook-base.d.ts ../../docs/includes/outlook-1_1 -node whats-new powerpoint ../api-extractor-inputs-powerpoint/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts ../../docs/includes/powerpoint-preview +node whats-new powerpoint ../api-extractor-inputs-powerpoint/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts ../../docs/includes/powerpoint-preview +node whats-new powerpoint ../api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts ../../docs/includes/powerpoint-1_6 node whats-new powerpoint ../api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts ../../docs/includes/powerpoint-1_5 node whats-new powerpoint ../api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts ../../docs/includes/powerpoint-1_4 node whats-new powerpoint ../api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts ../../docs/includes/powerpoint-1_3 @@ -419,6 +421,12 @@ if [ ! -d "json/powerpoint" ]; then ../node_modules/.bin/api-extractor run popd fi +if [ ! -d "json/powerpoint_1_6" ]; then + echo Running API Extractor for PowerPoint 1.6. + pushd api-extractor-inputs-powerpoint-release/PowerPoint_1_6 + ../../node_modules/.bin/api-extractor run + popd +fi if [ ! -d "json/powerpoint_1_5" ]; then echo Running API Extractor for PowerPoint 1.5. pushd api-extractor-inputs-powerpoint-release/PowerPoint_1_5 @@ -691,6 +699,9 @@ fi if [ ! -d "yaml/powerpoint_1_5" ]; then ./node_modules/.bin/api-documenter yaml --input-folder ./json/powerpoint_1_5 --output-folder ./yaml/powerpoint_1_5 --office 2>/dev/null fi +if [ ! -d "yaml/powerpoint_1_6" ]; then + ./node_modules/.bin/api-documenter yaml --input-folder ./json/powerpoint_1_6 --output-folder ./yaml/powerpoint_1_6 --office 2>/dev/null +fi if [ ! -d "yaml/visio" ]; then ./node_modules/.bin/api-documenter yaml --input-folder ./json/visio --output-folder ./yaml/visio --office fi diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_1/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_1/powerpoint.d.ts index 43ae20cf9..593131b05 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_1/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_1/powerpoint.d.ts @@ -99,6 +99,8 @@ export declare namespace PowerPoint { + + @@ -119,6 +121,15 @@ export declare namespace PowerPoint { */ $skip?: number; } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { + + + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ export interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -211,6 +222,15 @@ export declare namespace PowerPoint { title?: string; } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { + + + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ export interface ShapeCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -347,6 +367,8 @@ export declare namespace PowerPoint { + + } } diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_2/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_2/powerpoint.d.ts index 6aafc20a0..8fb73e6a8 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_2/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_2/powerpoint.d.ts @@ -98,6 +98,8 @@ export declare namespace PowerPoint { + + /** * Represents a single slide of a presentation. * @@ -111,6 +113,7 @@ export declare namespace PowerPoint { + /** * Gets the unique ID of the slide. * @@ -317,6 +320,15 @@ export declare namespace PowerPoint { */ $skip?: number; } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { + + + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ export interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -409,6 +421,15 @@ export declare namespace PowerPoint { title?: string; } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { + + + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ export interface ShapeCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -539,6 +560,8 @@ export declare namespace PowerPoint { + + /** * Represents a single slide of a presentation. * diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_3/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_3/powerpoint.d.ts index c7770f4fa..b0a92988a 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_3/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_3/powerpoint.d.ts @@ -130,6 +130,8 @@ export declare namespace PowerPoint { + + /** * Represents the collection of shapes. * @@ -554,6 +556,7 @@ export declare namespace PowerPoint { export class Slide extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** * Gets the layout of the slide. * @@ -940,6 +943,15 @@ export declare namespace PowerPoint { */ $skip?: number; } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { + + + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ export interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -1038,6 +1050,15 @@ export declare namespace PowerPoint { title?: string; } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { + + + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ export interface ShapeCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -1204,6 +1225,8 @@ export declare namespace PowerPoint { title?: boolean; } + + /** * Represents the collection of shapes. * diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts index 07bc3226b..0ff952ad8 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_4/powerpoint.d.ts @@ -123,6 +123,8 @@ export declare namespace PowerPoint { */ slideMasterId?: string; } + + /** * Specifies the connector type for line shapes. * @@ -2021,6 +2023,7 @@ export declare namespace PowerPoint { export class Slide extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** * Gets the layout of the slide. * @@ -3108,6 +3111,15 @@ export declare namespace PowerPoint { */ $skip?: number; } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { + + + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ export interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -3380,6 +3392,15 @@ export declare namespace PowerPoint { title?: string; } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { + + + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ export interface ShapeCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -3738,6 +3759,8 @@ export declare namespace PowerPoint { title?: boolean; } + + /** * Represents the collection of shapes. * diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts index 33f9d6ca2..ea660e9a5 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts @@ -166,6 +166,8 @@ export declare namespace PowerPoint { */ slideMasterId?: string; } + + /** * Specifies the connector type for line shapes. * @@ -2064,6 +2066,7 @@ export declare namespace PowerPoint { export class Slide extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** * Gets the layout of the slide. * @@ -3373,6 +3376,15 @@ export declare namespace PowerPoint { */ $skip?: number; } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { + + + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ export interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -3665,6 +3677,15 @@ export declare namespace PowerPoint { id?: string; title?: string; } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { + + + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ export interface ShapeCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -4043,6 +4064,8 @@ export declare namespace PowerPoint { id?: boolean; title?: boolean; } + + /** * Represents the collection of shapes. * diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/api-extractor.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/api-extractor.json new file mode 100644 index 000000000..d78c58cd0 --- /dev/null +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/api-extractor.json @@ -0,0 +1,41 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "powerpoint.d.ts", + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "../../json/powerpoint_1_6/.api.json" + }, + "dtsRollup": { + "enabled": false + }, + "messages": { + "extractorMessageReporting": { + "ae-missing-release-tag": { + "logLevel": "none" + }, + "ae-forgotten-export": { + "logLevel": "none" + }, + "ae-unresolved-link": { + "logLevel": "none" + } + }, + "tsdocMessageReporting": { + "tsdoc-escape-right-brace": { + "logLevel": "none" + }, + "tsdoc-escape-greater-than": { + "logLevel": "none" + }, + "tsdoc-malformed-inline-tag": { + "logLevel": "none" + }, + "tsdoc-unnecessary-backslash": { + "logLevel": "none" + } + } + } +} \ No newline at end of file diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/package.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/package.json new file mode 100644 index 000000000..abc3da567 --- /dev/null +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/package.json @@ -0,0 +1,4 @@ +{ + "name": "powerpoint", + "version": "1.6.0" +} \ No newline at end of file diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts new file mode 100644 index 000000000..7d62be95b --- /dev/null +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts @@ -0,0 +1,5104 @@ +import { OfficeExtension } from "../../api-extractor-inputs-office/office" +import { Office as Outlook} from "../../api-extractor-inputs-outlook/outlook" +//////////////////////////////////////////////////////////////// +//////////////////// Begin PowerPoint APIs ///////////////////// +//////////////////////////////////////////////////////////////// + +export declare namespace PowerPoint { + /** + * @remarks + * [Api set: PowerPointApi 1.0] + */ + export class Application extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Create a new instance of the `PowerPoint.Application` object. + */ + static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.Application; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * @remarks + * [Api set: PowerPointApi 1.0] + */ + export class Presentation extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the collection of `SlideMaster` objects that are in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly slideMasters: PowerPoint.SlideMasterCollection; + /** + * Returns an ordered collection of slides in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + readonly slides: PowerPoint.SlideCollection; + /** + * Returns a collection of tags attached to the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly tags: PowerPoint.TagCollection; + /** + * Gets the ID of the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + readonly id: string; + readonly title: string; + /** + * Returns the selected shapes in the current slide of the presentation. + If no shapes are selected, an empty collection is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getSelectedShapes(): PowerPoint.ShapeScopedCollection; + /** + * Returns the selected slides in the current view of the presentation. + The first item in the collection is the active slide that is visible in the editing area. + If no slides are selected, an empty collection is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getSelectedSlides(): PowerPoint.SlideScopedCollection; + /** + * Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation. + Throws an exception if no text is selected. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getSelectedTextRange(): PowerPoint.TextRange; + /** + * Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation. + If no text is selected, an object with an `isNullObject` property set to `true` is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getSelectedTextRangeOrNullObject(): PowerPoint.TextRange; + /** + * Inserts the specified slides from a presentation into the current presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + * + * @param base64File - The Base64-encoded string representing the source presentation file. + * @param options - The options that define which slides will be inserted, where the new slides will go, and which presentation's formatting will be used. + */ + insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions): void; + /** + * Selects the slides in the current view of the presentation. Existing slide selection is replaced with the new selection. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param slideIds - List of slide IDs to select in the presentation. If the list is empty, selection is cleared. + */ + setSelectedSlides(slideIds: string[]): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.PresentationLoadOptions): PowerPoint.Presentation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Presentation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Presentation; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.Presentation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.PresentationData; + } + /** + * Represents the available options when adding a new slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface AddSlideOptions { + /** + * Specifies the ID of a Slide Layout to be used for the new slide. + If no `layoutId` is provided, but a `slideMasterId` is provided, then the ID of the first layout from the specified Slide Master will be used. + If no `slideMasterId` is provided, but a `layoutId` is provided, then the specified layout needs to be available for the default Slide Master (as specified + in the `slideMasterId` description). Otherwise, an error will be thrown. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + layoutId?: string; + /** + * Specifies the ID of a Slide Master to be used for the new slide. + If no `slideMasterId` is provided, then the previous slide's Slide Master will be used. + If there is no previous slide, then the presentation's first Slide Master will be used. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + slideMasterId?: string; + } + /** + * Represents a single hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + export class Hyperlink extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address: string; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Hyperlink; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Hyperlink; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.HyperlinkData; + } + /** + * Represents a collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + export class HyperlinkCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Hyperlink[]; + /** + * Gets the number of hyperlinks in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.6] + * @returns The number of hyperlinks in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.6] + * + * @param index - The index of the hyperlink in the collection. + * @returns The hyperlink at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Hyperlink; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData; + } + /** + * Specifies the connector type for line shapes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ConnectorType { + /** + * Straight connector type + * @remarks + * [Api set: PowerPointApi 1.4] + */ + straight = "Straight", + /** + * Elbow connector type + * @remarks + * [Api set: PowerPointApi 1.4] + */ + elbow = "Elbow", + /** + * Curve connector type + * @remarks + * [Api set: PowerPointApi 1.4] + */ + curve = "Curve", + } + /** + * Specifies the shape type for a `GeometricShape` object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum GeometricShapeType { + /** + * Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape + * @remarks + * [Api set: PowerPointApi 1.4] + */ + lineInverse = "LineInverse", + /** + * Isosceles Triangle + * @remarks + * [Api set: PowerPointApi 1.4] + */ + triangle = "Triangle", + /** + * Right Triangle + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightTriangle = "RightTriangle", + /** + * Rectangle + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rectangle = "Rectangle", + /** + * Diamond + * @remarks + * [Api set: PowerPointApi 1.4] + */ + diamond = "Diamond", + /** + * Parallelogram + * @remarks + * [Api set: PowerPointApi 1.4] + */ + parallelogram = "Parallelogram", + /** + * Trapezoid + * @remarks + * [Api set: PowerPointApi 1.4] + */ + trapezoid = "Trapezoid", + /** + * Trapezoid which may have Non-Equal Sides + * @remarks + * [Api set: PowerPointApi 1.4] + */ + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + /** + * Pentagon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + pentagon = "Pentagon", + /** + * Hexagon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + hexagon = "Hexagon", + /** + * Heptagon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + heptagon = "Heptagon", + /** + * Octagon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + octagon = "Octagon", + /** + * Decagon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + decagon = "Decagon", + /** + * Dodecagon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dodecagon = "Dodecagon", + /** + * Star: 4 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star4 = "Star4", + /** + * Star: 5 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star5 = "Star5", + /** + * Star: 6 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star6 = "Star6", + /** + * Star: 7 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star7 = "Star7", + /** + * Star: 8 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star8 = "Star8", + /** + * Star: 10 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star10 = "Star10", + /** + * Star: 12 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star12 = "Star12", + /** + * Star: 16 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star16 = "Star16", + /** + * Star: 24 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star24 = "Star24", + /** + * Star: 32 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + star32 = "Star32", + /** + * Rectangle: Rounded Corners + * @remarks + * [Api set: PowerPointApi 1.4] + */ + roundRectangle = "RoundRectangle", + /** + * Rectangle: Single Corner Rounded + * @remarks + * [Api set: PowerPointApi 1.4] + */ + round1Rectangle = "Round1Rectangle", + /** + * Rectangle: Top Corners Rounded + * @remarks + * [Api set: PowerPointApi 1.4] + */ + round2SameRectangle = "Round2SameRectangle", + /** + * Rectangle: Diagonal Corners Rounded + * @remarks + * [Api set: PowerPointApi 1.4] + */ + round2DiagonalRectangle = "Round2DiagonalRectangle", + /** + * Rectangle: Top Corners One Rounded and One Snipped + * @remarks + * [Api set: PowerPointApi 1.4] + */ + snipRoundRectangle = "SnipRoundRectangle", + /** + * Rectangle: Single Corner Snipped + * @remarks + * [Api set: PowerPointApi 1.4] + */ + snip1Rectangle = "Snip1Rectangle", + /** + * Rectangle: Top Corners Snipped + * @remarks + * [Api set: PowerPointApi 1.4] + */ + snip2SameRectangle = "Snip2SameRectangle", + /** + * Rectangle: Diagonal Corners Snipped + * @remarks + * [Api set: PowerPointApi 1.4] + */ + snip2DiagonalRectangle = "Snip2DiagonalRectangle", + /** + * Plaque + * @remarks + * [Api set: PowerPointApi 1.4] + */ + plaque = "Plaque", + /** + * Oval + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ellipse = "Ellipse", + /** + * Teardrop + * @remarks + * [Api set: PowerPointApi 1.4] + */ + teardrop = "Teardrop", + /** + * Arrow: Pentagon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + homePlate = "HomePlate", + /** + * Arrow: Chevron + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chevron = "Chevron", + /** + * Partial Circle + * @remarks + * [Api set: PowerPointApi 1.4] + */ + pieWedge = "PieWedge", + /** + * Partial Circle with Adjustable Spanning Area + * @remarks + * [Api set: PowerPointApi 1.4] + */ + pie = "Pie", + /** + * Block Arc + * @remarks + * [Api set: PowerPointApi 1.4] + */ + blockArc = "BlockArc", + /** + * Circle: Hollow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + donut = "Donut", + /** + * "Not Allowed" Symbol + * @remarks + * [Api set: PowerPointApi 1.4] + */ + noSmoking = "NoSmoking", + /** + * Arrow: Right + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightArrow = "RightArrow", + /** + * Arrow: Left + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftArrow = "LeftArrow", + /** + * Arrow: Up + * @remarks + * [Api set: PowerPointApi 1.4] + */ + upArrow = "UpArrow", + /** + * Arrow: Down + * @remarks + * [Api set: PowerPointApi 1.4] + */ + downArrow = "DownArrow", + /** + * Arrow: Striped Right + * @remarks + * [Api set: PowerPointApi 1.4] + */ + stripedRightArrow = "StripedRightArrow", + /** + * Arrow: Notched Right + * @remarks + * [Api set: PowerPointApi 1.4] + */ + notchedRightArrow = "NotchedRightArrow", + /** + * Arrow: Bent-Up + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bentUpArrow = "BentUpArrow", + /** + * Arrow: Left-Right + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftRightArrow = "LeftRightArrow", + /** + * Arrow: Up-Down + * @remarks + * [Api set: PowerPointApi 1.4] + */ + upDownArrow = "UpDownArrow", + /** + * Arrow: Left-Up + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftUpArrow = "LeftUpArrow", + /** + * Arrow: Left-Right-Up + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftRightUpArrow = "LeftRightUpArrow", + /** + * Arrow: Quad + * @remarks + * [Api set: PowerPointApi 1.4] + */ + quadArrow = "QuadArrow", + /** + * Callout: Left Arrow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftArrowCallout = "LeftArrowCallout", + /** + * Callout: Right Arrow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightArrowCallout = "RightArrowCallout", + /** + * Callout: Up Arrow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + upArrowCallout = "UpArrowCallout", + /** + * Callout: Down Arrow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + downArrowCallout = "DownArrowCallout", + /** + * Callout: Left-Right Arrow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftRightArrowCallout = "LeftRightArrowCallout", + /** + * Callout: Up-Down Arrow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + upDownArrowCallout = "UpDownArrowCallout", + /** + * Callout: Quad Arrow + * @remarks + * [Api set: PowerPointApi 1.4] + */ + quadArrowCallout = "QuadArrowCallout", + /** + * Arrow: Bent + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bentArrow = "BentArrow", + /** + * Arrow: U-Turn + * @remarks + * [Api set: PowerPointApi 1.4] + */ + uturnArrow = "UturnArrow", + /** + * Arrow: Circular + * @remarks + * [Api set: PowerPointApi 1.4] + */ + circularArrow = "CircularArrow", + /** + * Arrow: Circular with Opposite Arrow Direction + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftCircularArrow = "LeftCircularArrow", + /** + * Arrow: Circular with Two Arrows in Both Directions + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftRightCircularArrow = "LeftRightCircularArrow", + /** + * Arrow: Curved Right + * @remarks + * [Api set: PowerPointApi 1.4] + */ + curvedRightArrow = "CurvedRightArrow", + /** + * Arrow: Curved Left + * @remarks + * [Api set: PowerPointApi 1.4] + */ + curvedLeftArrow = "CurvedLeftArrow", + /** + * Arrow: Curved Up + * @remarks + * [Api set: PowerPointApi 1.4] + */ + curvedUpArrow = "CurvedUpArrow", + /** + * Arrow: Curved Down + * @remarks + * [Api set: PowerPointApi 1.4] + */ + curvedDownArrow = "CurvedDownArrow", + /** + * Arrow: Curved Right Arrow with Varying Width + * @remarks + * [Api set: PowerPointApi 1.4] + */ + swooshArrow = "SwooshArrow", + /** + * Cube + * @remarks + * [Api set: PowerPointApi 1.4] + */ + cube = "Cube", + /** + * Cylinder + * @remarks + * [Api set: PowerPointApi 1.4] + */ + can = "Can", + /** + * Lightning Bolt + * @remarks + * [Api set: PowerPointApi 1.4] + */ + lightningBolt = "LightningBolt", + /** + * Heart + * @remarks + * [Api set: PowerPointApi 1.4] + */ + heart = "Heart", + /** + * Sun + * @remarks + * [Api set: PowerPointApi 1.4] + */ + sun = "Sun", + /** + * Moon + * @remarks + * [Api set: PowerPointApi 1.4] + */ + moon = "Moon", + /** + * Smiley Face + * @remarks + * [Api set: PowerPointApi 1.4] + */ + smileyFace = "SmileyFace", + /** + * Explosion: 8 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + irregularSeal1 = "IrregularSeal1", + /** + * Explosion: 14 Points + * @remarks + * [Api set: PowerPointApi 1.4] + */ + irregularSeal2 = "IrregularSeal2", + /** + * Rectangle: Folded Corner + * @remarks + * [Api set: PowerPointApi 1.4] + */ + foldedCorner = "FoldedCorner", + /** + * Rectangle: Beveled + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bevel = "Bevel", + /** + * Frame + * @remarks + * [Api set: PowerPointApi 1.4] + */ + frame = "Frame", + /** + * Half Frame + * @remarks + * [Api set: PowerPointApi 1.4] + */ + halfFrame = "HalfFrame", + /** + * L-Shape + * @remarks + * [Api set: PowerPointApi 1.4] + */ + corner = "Corner", + /** + * Diagonal Stripe + * @remarks + * [Api set: PowerPointApi 1.4] + */ + diagonalStripe = "DiagonalStripe", + /** + * Chord + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chord = "Chord", + /** + * Arc + * @remarks + * [Api set: PowerPointApi 1.4] + */ + arc = "Arc", + /** + * Left Bracket + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftBracket = "LeftBracket", + /** + * Right Bracket + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightBracket = "RightBracket", + /** + * Left Brace + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftBrace = "LeftBrace", + /** + * Right Brace + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightBrace = "RightBrace", + /** + * Double Bracket + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bracketPair = "BracketPair", + /** + * Double Brace + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bracePair = "BracePair", + /** + * Callout: Line with No Border + * @remarks + * [Api set: PowerPointApi 1.4] + */ + callout1 = "Callout1", + /** + * Callout: Bent Line with No Border + * @remarks + * [Api set: PowerPointApi 1.4] + */ + callout2 = "Callout2", + /** + * Callout: Double Bent Line with No Border + * @remarks + * [Api set: PowerPointApi 1.4] + */ + callout3 = "Callout3", + /** + * Callout: Line with Accent Bar + * @remarks + * [Api set: PowerPointApi 1.4] + */ + accentCallout1 = "AccentCallout1", + /** + * Callout: Bent Line with Accent Bar + * @remarks + * [Api set: PowerPointApi 1.4] + */ + accentCallout2 = "AccentCallout2", + /** + * Callout: Double Bent Line with Accent Bar + * @remarks + * [Api set: PowerPointApi 1.4] + */ + accentCallout3 = "AccentCallout3", + /** + * Callout: Line + * @remarks + * [Api set: PowerPointApi 1.4] + */ + borderCallout1 = "BorderCallout1", + /** + * Callout: Bent Line + * @remarks + * [Api set: PowerPointApi 1.4] + */ + borderCallout2 = "BorderCallout2", + /** + * Callout: Double Bent Line + * @remarks + * [Api set: PowerPointApi 1.4] + */ + borderCallout3 = "BorderCallout3", + /** + * Callout: Line with Border and Accent Bar + * @remarks + * [Api set: PowerPointApi 1.4] + */ + accentBorderCallout1 = "AccentBorderCallout1", + /** + * Callout: Bent Line with Border and Accent Bar + * @remarks + * [Api set: PowerPointApi 1.4] + */ + accentBorderCallout2 = "AccentBorderCallout2", + /** + * Callout: Double Bent Line with Border and Accent Bar + * @remarks + * [Api set: PowerPointApi 1.4] + */ + accentBorderCallout3 = "AccentBorderCallout3", + /** + * Speech Bubble: Rectangle + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wedgeRectCallout = "WedgeRectCallout", + /** + * Speech Bubble: Rectangle with Corners Rounded + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wedgeRRectCallout = "WedgeRRectCallout", + /** + * Speech Bubble: Oval + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wedgeEllipseCallout = "WedgeEllipseCallout", + /** + * Thought Bubble: Cloud + * @remarks + * [Api set: PowerPointApi 1.4] + */ + cloudCallout = "CloudCallout", + /** + * Cloud + * @remarks + * [Api set: PowerPointApi 1.4] + */ + cloud = "Cloud", + /** + * Ribbon: Tilted Down + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ribbon = "Ribbon", + /** + * Ribbon: Tilted Up + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ribbon2 = "Ribbon2", + /** + * Ribbon: Curved and Tilted Down + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ellipseRibbon = "EllipseRibbon", + /** + * Ribbon: Curved and Tilted Up + * @remarks + * [Api set: PowerPointApi 1.4] + */ + ellipseRibbon2 = "EllipseRibbon2", + /** + * Ribbon: Straight with Both Left and Right Arrows + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftRightRibbon = "LeftRightRibbon", + /** + * Scroll: Vertical + * @remarks + * [Api set: PowerPointApi 1.4] + */ + verticalScroll = "VerticalScroll", + /** + * Scroll: Horizontal + * @remarks + * [Api set: PowerPointApi 1.4] + */ + horizontalScroll = "HorizontalScroll", + /** + * Wave + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wave = "Wave", + /** + * Double Wave + * @remarks + * [Api set: PowerPointApi 1.4] + */ + doubleWave = "DoubleWave", + /** + * Cross + * @remarks + * [Api set: PowerPointApi 1.4] + */ + plus = "Plus", + /** + * Flowchart: Process + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartProcess = "FlowChartProcess", + /** + * Flowchart: Decision + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartDecision = "FlowChartDecision", + /** + * Flowchart: Data + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartInputOutput = "FlowChartInputOutput", + /** + * Flowchart: Predefined Process + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartPredefinedProcess = "FlowChartPredefinedProcess", + /** + * Flowchart: Internal Storage + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartInternalStorage = "FlowChartInternalStorage", + /** + * Flowchart: Document + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartDocument = "FlowChartDocument", + /** + * Flowchart: Multidocument + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartMultidocument = "FlowChartMultidocument", + /** + * Flowchart: Terminator + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartTerminator = "FlowChartTerminator", + /** + * Flowchart: Preparation + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartPreparation = "FlowChartPreparation", + /** + * Flowchart: Manual Input + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartManualInput = "FlowChartManualInput", + /** + * Flowchart: Manual Operation + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartManualOperation = "FlowChartManualOperation", + /** + * Flowchart: Connector + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartConnector = "FlowChartConnector", + /** + * Flowchart: Card + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartPunchedCard = "FlowChartPunchedCard", + /** + * Flowchart: Punched Tape + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartPunchedTape = "FlowChartPunchedTape", + /** + * Flowchart: Summing Junction + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartSummingJunction = "FlowChartSummingJunction", + /** + * Flowchart: Or + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartOr = "FlowChartOr", + /** + * Flowchart: Collate + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartCollate = "FlowChartCollate", + /** + * Flowchart: Sort + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartSort = "FlowChartSort", + /** + * Flowchart: Extract + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartExtract = "FlowChartExtract", + /** + * Flowchart: Merge + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartMerge = "FlowChartMerge", + /** + * FlowChart: Offline Storage + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartOfflineStorage = "FlowChartOfflineStorage", + /** + * Flowchart: Stored Data + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartOnlineStorage = "FlowChartOnlineStorage", + /** + * Flowchart: Sequential Access Storage + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartMagneticTape = "FlowChartMagneticTape", + /** + * Flowchart: Magnetic Disk + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartMagneticDisk = "FlowChartMagneticDisk", + /** + * Flowchart: Direct Access Storage + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartMagneticDrum = "FlowChartMagneticDrum", + /** + * Flowchart: Display + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartDisplay = "FlowChartDisplay", + /** + * Flowchart: Delay + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartDelay = "FlowChartDelay", + /** + * Flowchart: Alternate Process + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartAlternateProcess = "FlowChartAlternateProcess", + /** + * Flowchart: Off-page Connector + * @remarks + * [Api set: PowerPointApi 1.4] + */ + flowChartOffpageConnector = "FlowChartOffpageConnector", + /** + * Action Button: Blank + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonBlank = "ActionButtonBlank", + /** + * Action Button: Go Home + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonHome = "ActionButtonHome", + /** + * Action Button: Help + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonHelp = "ActionButtonHelp", + /** + * Action Button: Get Information + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonInformation = "ActionButtonInformation", + /** + * Action Button: Go Forward or Next + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonForwardNext = "ActionButtonForwardNext", + /** + * Action Button: Go Back or Previous + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonBackPrevious = "ActionButtonBackPrevious", + /** + * Action Button: Go to End + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonEnd = "ActionButtonEnd", + /** + * Action Button: Go to Beginning + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonBeginning = "ActionButtonBeginning", + /** + * Action Button: Return + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonReturn = "ActionButtonReturn", + /** + * Action Button: Document + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonDocument = "ActionButtonDocument", + /** + * Action Button: Sound + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonSound = "ActionButtonSound", + /** + * Action Button: Video + * @remarks + * [Api set: PowerPointApi 1.4] + */ + actionButtonMovie = "ActionButtonMovie", + /** + * Gear: A Gear with Six Teeth + * @remarks + * [Api set: PowerPointApi 1.4] + */ + gear6 = "Gear6", + /** + * Gear: A Gear with Nine Teeth + * @remarks + * [Api set: PowerPointApi 1.4] + */ + gear9 = "Gear9", + /** + * Funnel + * @remarks + * [Api set: PowerPointApi 1.4] + */ + funnel = "Funnel", + /** + * Plus Sign + * @remarks + * [Api set: PowerPointApi 1.4] + */ + mathPlus = "MathPlus", + /** + * Minus Sign + * @remarks + * [Api set: PowerPointApi 1.4] + */ + mathMinus = "MathMinus", + /** + * Multiplication Sign + * @remarks + * [Api set: PowerPointApi 1.4] + */ + mathMultiply = "MathMultiply", + /** + * Division Sign + * @remarks + * [Api set: PowerPointApi 1.4] + */ + mathDivide = "MathDivide", + /** + * Equals + * @remarks + * [Api set: PowerPointApi 1.4] + */ + mathEqual = "MathEqual", + /** + * Not Equal + * @remarks + * [Api set: PowerPointApi 1.4] + */ + mathNotEqual = "MathNotEqual", + /** + * Four Right Triangles that Define a Rectangular Shape + * @remarks + * [Api set: PowerPointApi 1.4] + */ + cornerTabs = "CornerTabs", + /** + * Four Small Squares that Define a Rectangular Shape. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + squareTabs = "SquareTabs", + /** + * Four Quarter Circles that Define a Rectangular Shape. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + plaqueTabs = "PlaqueTabs", + /** + * A Rectangle Divided into Four Parts Along Diagonal Lines. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chartX = "ChartX", + /** + * A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal Lines. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chartStar = "ChartStar", + /** + * A Rectangle Divided Vertically and Horizontally into Four Quarters. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + chartPlus = "ChartPlus", + } + /** + * Represents the available options when adding shapes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface ShapeAddOptions { + /** + * Specifies the height, in points, of the shape. + When not provided, a default value will be used. + Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height?: number; + /** + * Specifies the distance, in points, from the left side of the shape to the left side of the slide. + When not provided, a default value will be used. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left?: number; + /** + * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide. + When not provided, a default value will be used. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top?: number; + /** + * Specifies the width, in points, of the shape. + When not provided, a default value will be used. + Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: number; + } + /** + * The type of underline applied to a font. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeFontUnderlineStyle { + /** + * No underlining. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + none = "None", + /** + * Regular single line underlining. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + single = "Single", + /** + * Underlining of text with double lines. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + double = "Double", + /** + * Underlining of text with a thick line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + heavy = "Heavy", + /** + * Underlining of text with a dotted line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dotted = "Dotted", + /** + * Underlining of text with a thick, dotted line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dottedHeavy = "DottedHeavy", + /** + * Underlining of text with a line containing dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dash = "Dash", + /** + * Underlining of text with a thick line containing dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashHeavy = "DashHeavy", + /** + * Underlining of text with a line containing long dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashLong = "DashLong", + /** + * Underlining of text with a thick line containing long dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashLongHeavy = "DashLongHeavy", + /** + * Underlining of text with a line containing dots and dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dotDash = "DotDash", + /** + * Underlining of text with a thick line containing dots and dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dotDashHeavy = "DotDashHeavy", + /** + * Underlining of text with a line containing double dots and dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dotDotDash = "DotDotDash", + /** + * Underlining of text with a thick line containing double dots and dashes. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dotDotDashHeavy = "DotDotDashHeavy", + /** + * Underlining of text with a wavy line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wavy = "Wavy", + /** + * Underlining of text with a thick, wavy line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wavyHeavy = "WavyHeavy", + /** + * Underlining of text with double wavy lines. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wavyDouble = "WavyDouble", + } + /** + * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ParagraphHorizontalAlignment { + /** + * Align text to the left margin. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left = "Left", + /** + * Align text in the center. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + center = "Center", + /** + * Align text to the right margin. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + right = "Right", + /** + * Align text so that it is justified across the whole line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + justify = "Justify", + /** + * Specifies the alignment or adjustment of kashida length in Arabic text. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + justifyLow = "JustifyLow", + /** + * Distributes the text words across an entire text line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + distributed = "Distributed", + /** + * Distributes Thai text specially, because each character is treated as a word. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + thaiDistributed = "ThaiDistributed", + } + /** + * Specifies the dash style for a line. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeLineDashStyle { + /** + * The dash line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dash = "Dash", + /** + * The dash-dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashDot = "DashDot", + /** + * The dash-dot-dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashDotDot = "DashDotDot", + /** + * The long dash line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + longDash = "LongDash", + /** + * The long dash-dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + longDashDot = "LongDashDot", + /** + * The round dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + roundDot = "RoundDot", + /** + * The solid line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + solid = "Solid", + /** + * The square dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + squareDot = "SquareDot", + /** + * The long dash-dot-dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + longDashDotDot = "LongDashDotDot", + /** + * The system dash line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + systemDash = "SystemDash", + /** + * The system dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + systemDot = "SystemDot", + /** + * The system dash-dot line pattern. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + systemDashDot = "SystemDashDot", + } + /** + * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}. + If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group. + To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum TextVerticalAlignment { + /** + * Specifies that the `TextFrame` should be top aligned to the `Shape`. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top = "Top", + /** + * Specifies that the `TextFrame` should be center aligned to the `Shape`. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + middle = "Middle", + /** + * Specifies that the `TextFrame` should be bottom aligned to the `Shape`. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bottom = "Bottom", + /** + * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + topCentered = "TopCentered", + /** + * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + middleCentered = "MiddleCentered", + /** + * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bottomCentered = "BottomCentered", + } + /** + * Represents the collection of shapes. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Shape[]; + /** + * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param geometricShapeType - Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. + * @param options - An optional parameter to specify the additional options such as the position of the shape. + * @returns The newly inserted shape. + */ + addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param geometricShapeTypeString - Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. + * @param options - An optional parameter to specify the additional options such as the position of the shape. + * @returns The newly inserted shape. + */ + addGeometricShape(geometricShapeTypeString: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Adds a line to the slide. Returns a `Shape` object that represents the new line. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param connectorType - Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details. + * @param options - An optional parameter to specify the additional options such as the position of the shape object that contains the line. + * @returns The newly inserted shape. + */ + addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Adds a line to the slide. Returns a `Shape` object that represents the new line. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param connectorTypeString - Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details. + * @param options - An optional parameter to specify the additional options such as the position of the shape object that contains the line. + * @returns The newly inserted shape. + */ + addLine(connectorTypeString?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param text - Specifies the text that will be shown in the created text box. + * @param options - An optional parameter to specify the additional options such as the position of the text box. + * @returns The newly inserted shape. + */ + addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Gets the number of shapes in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * @returns The number of shapes in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a shape using its unique ID. An error is thrown if the shape does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key - The ID of the shape. + * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown. + */ + getItem(key: string): PowerPoint.Shape; + /** + * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param index - The index of the shape in the collection. + * @returns The shape at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Shape; + /** + * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param id - The ID of the shape. + * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned. + */ + getItemOrNullObject(id: string): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.ShapeCollectionData; + } + /** + * Represents the layout of a slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class SlideLayout extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a collection of shapes in the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly shapes: PowerPoint.ShapeCollection; + /** + * Gets the unique ID of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly id: string; + /** + * Gets the name of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly name: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideLayout; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.SlideLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideLayoutData; + } + /** + * Represents the collection of layouts provided by the Slide Master for slides. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class SlideLayoutCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.SlideLayout[]; + /** + * Gets the number of layouts in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * @returns The number of layouts in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a layout using its unique ID. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key - The ID of the layout. + * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown. + */ + getItem(key: string): PowerPoint.SlideLayout; + /** + * Gets a layout using its zero-based index in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param index - The index of the layout in the collection. + * @returns The layout at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.SlideLayout; + /** + * Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information, + see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param id - The ID of the layout. + * @returns The layout with the unique ID. + */ + getItemOrNullObject(id: string): PowerPoint.SlideLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData; + } + /** + * Represents the Slide Master of a slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class SlideMaster extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the collection of layouts provided by the Slide Master for slides. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly layouts: PowerPoint.SlideLayoutCollection; + /** + * Returns a collection of shapes in the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly shapes: PowerPoint.ShapeCollection; + /** + * Gets the unique ID of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly id: string; + /** + * Gets the unique name of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly name: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideMaster; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideMaster; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.SlideMaster` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideMasterData; + } + /** + * Represents a single tag in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class Tag extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly key: string; + /** + * Gets the value of the tag. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + value: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TagLoadOptions): PowerPoint.Tag; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Tag; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Tag; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.Tag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TagData; + } + /** + * Represents the collection of tags. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class TagCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Tag[]; + /** + * Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key - The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document. + * @param value - The value of the tag. + */ + add(key: string, value: string): void; + /** + * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key - The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive. + */ + delete(key: string): void; + /** + * Gets the number of tags in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * @returns The number of tags in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a tag using its unique ID. An error is thrown if the tag does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key - The ID of the tag. + * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown. + */ + getItem(key: string): PowerPoint.Tag; + /** + * Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param index - The index of the tag in the collection. + * @returns The tag at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Tag; + /** + * Gets a tag using its unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key - The ID of the tag. + * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned. + */ + getItemOrNullObject(key: string): PowerPoint.Tag; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.TagCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.TagCollectionData; + } + /** + * Represents a single slide of a presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + export class Slide extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a collection of hyperlinks in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + readonly hyperlinks: PowerPoint.HyperlinkCollection; + /** + * Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly layout: PowerPoint.SlideLayout; + /** + * Returns a collection of shapes in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly shapes: PowerPoint.ShapeCollection; + /** + * Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly slideMaster: PowerPoint.SlideMaster; + /** + * Returns a collection of tags in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly tags: PowerPoint.TagCollection; + /** + * Gets the unique ID of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + readonly id: string; + /** + * Deletes the slide from the presentation. Does nothing if the slide does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + delete(): void; + /** + * Selects the specified shapes. Existing shape selection is replaced with the new selection. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param shapeIds - List of shape IDs to select in the slide. If the list is empty, the selection is cleared. + */ + setSelectedShapes(shapeIds: string[]): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Slide; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Slide; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.Slide` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideData; + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeFillType { + /** + * Specifies that the shape should have no fill. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + noFill = "NoFill", + /** + * Specifies that the shape should have regular solid fill. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + solid = "Solid", + /** + * Specifies that the shape should have gradient fill. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + gradient = "Gradient", + /** + * Specifies that the shape should have pattern fill. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + pattern = "Pattern", + /** + * Specifies that the shape should have picture or texture fill. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + pictureAndTexture = "PictureAndTexture", + /** + * Specifies that the shape should have slide background fill. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + slideBackground = "SlideBackground", + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export class ShapeFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + foregroundColor: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency: number; + /** + * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground"; + /** + * Clears the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + clear(): void; + /** + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param color - A string that specifies the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + */ + setSolidColor(color: string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ShapeFill; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeFillData; + } + /** + * Specifies the style for a line. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeLineStyle { + /** + * Single line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + single = "Single", + /** + * Thick line with a thin line on each side. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + thickBetweenThin = "ThickBetweenThin", + /** + * Thick line next to thin line. For horizontal lines, the thick line is above the thin line. For vertical lines, the thick line is to the left of the thin line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + thickThin = "ThickThin", + /** + * Thick line next to thin line. For horizontal lines, the thick line is below the thin line. For vertical lines, the thick line is to the right of the thin line. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + thinThick = "ThinThick", + /** + * Two thin lines. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + thinThin = "ThinThin", + } + /** + * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export class ShapeLineFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color: string; + /** + * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + /** + * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"; + /** + * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency: number; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + weight: number; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ShapeLineFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeLineFormatData; + } + /** + * Specifies the type of a shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeType { + /** + * The given shape's type is unsupported. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + unsupported = "Unsupported", + /** + * The shape is an image + * @remarks + * [Api set: PowerPointApi 1.4] + */ + image = "Image", + /** + * The shape is a geometric shape such as rectangle + * @remarks + * [Api set: PowerPointApi 1.4] + */ + geometricShape = "GeometricShape", + /** + * The shape is a group shape which contains sub-shapes + * @remarks + * [Api set: PowerPointApi 1.4] + */ + group = "Group", + /** + * The shape is a line + * @remarks + * [Api set: PowerPointApi 1.4] + */ + line = "Line", + /** + * The shape is a table + * @remarks + * [Api set: PowerPointApi 1.4] + */ + table = "Table", + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeAutoSize { + /** + * No autosizing. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeNone = "AutoSizeNone", + /** + * The text is adjusted to fit the shape. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeTextToFitShape = "AutoSizeTextToFitShape", + /** + * The shape is adjusted to fit the text. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeShapeToFitText = "AutoSizeShapeToFitText", + /** + * A combination of automatic sizing schemes are used. + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeMixed = "AutoSizeMixed", + } + /** + * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export class BulletFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible: boolean; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.BulletFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.BulletFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.BulletFormatData; + } + /** + * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export class ParagraphFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly bulletFormat: PowerPoint.BulletFormat; + /** + * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ParagraphFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ParagraphFormatData; + } + /** + * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export class ShapeFont extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bold: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color: string; + /** + * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + italic: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name: string; + /** + * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + size: number; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ShapeFont; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeFontData; + } + /** + * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export class TextRange extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `ShapeFont` object that represents the font attributes for the text range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly font: PowerPoint.ShapeFont; + /** + * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly paragraphFormat: PowerPoint.ParagraphFormat; + /** + * Gets or sets the length of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + length: number; + /** + * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + start: number; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + text: string; + /** + * Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentTextFrame(): PowerPoint.TextFrame; + /** + * Returns a `TextRange` object for the substring in the given range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param start - The zero-based index of the first character to get from the text range. + * @param length - Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned. + */ + getSubstring(start: number, length?: number): PowerPoint.TextRange; + /** + * Selects this `TextRange` in the current view. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + setSelected(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TextRange; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TextRangeData; + } + /** + * Represents the text frame of a shape object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export class TextFrame extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly textRange: PowerPoint.TextRange; + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bottomMargin: number; + /** + * Specifies if the text frame contains text. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly hasText: boolean; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftMargin: number; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightMargin: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + topMargin: number; + /** + * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wordWrap: boolean; + /** + * Deletes all the text in the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + deleteText(): void; + /** + * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentShape(): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TextFrame; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TextFrameData; + } + /** + * Represents a single shape in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class Shape extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly fill: PowerPoint.ShapeFill; + /** + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly lineFormat: PowerPoint.ShapeLineFormat; + /** + * Returns a collection of tags in the shape. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly tags: PowerPoint.TagCollection; + /** + * Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly textFrame: PowerPoint.TextFrame; + /** + * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height: number; + /** + * Gets the unique ID of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + readonly id: string; + /** + * The distance, in points, from the left side of the shape to the left side of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left: number; + /** + * Specifies the name of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name: string; + /** + * The distance, in points, from the top edge of the shape to the top edge of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top: number; + /** + * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table"; + /** + * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width: number; + /** + * Deletes the shape from the shape collection. Does nothing if the shape does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + delete(): void; + /** + * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlide(): PowerPoint.Slide; + /** + * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideLayout(): PowerPoint.SlideLayout; + /** + * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout; + /** + * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideMaster(): PowerPoint.SlideMaster; + /** + * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster; + /** + * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentSlideOrNullObject(): PowerPoint.Slide; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Shape; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeData; + } + /** + * Specifies the formatting options for when slides are inserted. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + enum InsertSlideFormatting { + /** + * Copy the source theme into the target presentation and use that theme. + * @remarks + * [Api set: PowerPointApi 1.2] + */ + keepSourceFormatting = "KeepSourceFormatting", + /** + * Use the existing theme in the target presentation. + * @remarks + * [Api set: PowerPointApi 1.2] + */ + useDestinationTheme = "UseDestinationTheme", + } + /** + * Represents the available options when inserting slides. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + export interface InsertSlideOptions { + /** + * Specifies which formatting to use during slide insertion. + The default option is to use "KeepSourceFormatting". + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme"; + /** + * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object. + The order of these slides is preserved during the insertion. + If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted. + All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior). + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + sourceSlideIds?: string[]; + /** + * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID. + If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation. + If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + targetSlideId?: string; + } + /** + * Represents a collection of shapes. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + export class ShapeScopedCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Shape[]; + /** + * Gets the number of shapes in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * @returns The number of shapes in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a shape using its unique ID. An error is thrown if the shape does not exist. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param key - The ID of the shape. + * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown. + */ + getItem(key: string): PowerPoint.Shape; + /** + * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param index - The index of the shape in the collection. + * @returns The shape at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Shape; + /** + * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param id - The ID of the shape. + * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned. + */ + getItemOrNullObject(id: string): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ShapeScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData; + } + /** + * Represents the collection of slides in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + export class SlideCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Slide[]; + /** + * Adds a new slide at the end of the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param options - The options that define the theme of the new slide. + */ + add(options?: PowerPoint.AddSlideOptions): void; + /** + * Gets the number of slides in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.2] + * @returns The number of slides in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a slide using its unique ID. + * + * @remarks + * [Api set: PowerPointApi 1.2] + * + * @param key - The ID of the slide. + * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown. + */ + getItem(key: string): PowerPoint.Slide; + /** + * Gets a slide using its zero-based index in the collection. Slides are stored in the same order as they + are shown in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + * + * @param index - The index of the slide in the collection. + * @returns The slide at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Slide; + /** + * Gets a slide using its unique ID. If such a slide does not exist, an object with an `isNullObject` property set to true is returned. For further information, + see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods + and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.2] + * + * @param id - The ID of the slide. + * @returns The slide with the unique ID. + */ + getItemOrNullObject(id: string): PowerPoint.Slide; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.SlideCollectionData; + } + /** + * Represents a collection of slides in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + export class SlideScopedCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Slide[]; + /** + * Gets the number of slides in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * @returns The number of slides in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a slide using its unique ID. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param key - The ID of the slide. + * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown. + */ + getItem(key: string): PowerPoint.Slide; + /** + * Gets a slide using its zero-based index in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param index - The index of the slide in the collection. + * @returns The slide at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Slide; + /** + * Gets a slide using its unique ID. If such a slide does not exist, an object with an `isNullObject` property set to true is returned. For further information, + see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods + and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.5] + * + * @param id - The ID of the slide. + * @returns The slide with the unique ID. + */ + getItemOrNullObject(id: string): PowerPoint.Slide; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData; + } + /** + * Represents the collection of Slide Masters in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export class SlideMasterCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.SlideMaster[]; + /** + * Gets the number of Slide Masters in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * @returns The number of Slide Masters in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a Slide Master using its unique ID. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key - The ID of the Slide Master. + * @returns The Slide Master with the unique ID. If such a Slide Master does not exist, an error is thrown. + */ + getItem(key: string): PowerPoint.SlideMaster; + /** + * Gets a Slide Master using its zero-based index in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param index - The index of the Slide Master in the collection. + * @returns The Slide Master at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.SlideMaster; + /** + * Gets a Slide Master using its unique ID. If such a Slide Master does not exist, an object with an `isNullObject` property set to true is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}." + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param id - The ID of the Slide Master. + * @returns The Slide Master with the unique ID. + */ + getItemOrNullObject(id: string): PowerPoint.SlideMaster; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideMasterCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideMasterCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideMasterCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideMasterCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.SlideMasterCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData; + } + enum ErrorCodes { + generalException = "GeneralException", + } + export namespace Interfaces { + /** + * Provides ways to load properties of only a subset of members of a collection. + */ + export interface CollectionLoadOptions { + /** + * Specify the number of items in the queried collection to be included in the result. + */ + $top?: number; + /** + * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items. + */ + $skip?: number; + } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: string; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: string; + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + export interface ShapeCollectionUpdateData { + items?: PowerPoint.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */ + export interface SlideLayoutCollectionUpdateData { + items?: PowerPoint.Interfaces.SlideLayoutData[]; + } + /** An interface for updating data on the `Tag` object, for use in `tag.set({ ... })`. */ + export interface TagUpdateData { + /** + * Gets the value of the tag. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + value?: string; + } + /** An interface for updating data on the `TagCollection` object, for use in `tagCollection.set({ ... })`. */ + export interface TagCollectionUpdateData { + items?: PowerPoint.Interfaces.TagData[]; + } + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + export interface ShapeFillUpdateData { + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + foregroundColor?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency?: number; + } + /** An interface for updating data on the `ShapeLineFormat` object, for use in `shapeLineFormat.set({ ... })`. */ + export interface ShapeLineFormatUpdateData { + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color?: string; + /** + * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + /** + * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"; + /** + * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency?: number; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible?: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + weight?: number; + } + /** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */ + export interface BulletFormatUpdateData { + /** + * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible?: boolean; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + export interface ParagraphFormatUpdateData { + /** + * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"; + } + /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */ + export interface ShapeFontUpdateData { + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color?: string; + /** + * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + italic?: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: string; + /** + * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + size?: number; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + } + /** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */ + export interface TextRangeUpdateData { + /** + * Gets or sets the length of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + length?: number; + /** + * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + start?: number; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + text?: string; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + export interface TextFrameUpdateData { + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bottomMargin?: number; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftMargin?: number; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightMargin?: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wordWrap?: boolean; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + export interface ShapeUpdateData { + /** + * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height?: number; + /** + * The distance, in points, from the left side of the shape to the left side of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left?: number; + /** + * Specifies the name of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: string; + /** + * The distance, in points, from the top edge of the shape to the top edge of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top?: number; + /** + * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: number; + } + /** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */ + export interface ShapeScopedCollectionUpdateData { + items?: PowerPoint.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */ + export interface SlideCollectionUpdateData { + items?: PowerPoint.Interfaces.SlideData[]; + } + /** An interface for updating data on the `SlideScopedCollection` object, for use in `slideScopedCollection.set({ ... })`. */ + export interface SlideScopedCollectionUpdateData { + items?: PowerPoint.Interfaces.SlideData[]; + } + /** An interface for updating data on the `SlideMasterCollection` object, for use in `slideMasterCollection.set({ ... })`. */ + export interface SlideMasterCollectionUpdateData { + items?: PowerPoint.Interfaces.SlideMasterData[]; + } + /** An interface describing the data returned by calling `presentation.toJSON()`. */ + export interface PresentationData { + /** + * Gets the ID of the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + id?: string; + title?: string; + } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: string; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: string; + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + export interface ShapeCollectionData { + items?: PowerPoint.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `slideLayout.toJSON()`. */ + export interface SlideLayoutData { + /** + * Gets the unique ID of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: string; + /** + * Gets the name of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + name?: string; + } + /** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */ + export interface SlideLayoutCollectionData { + items?: PowerPoint.Interfaces.SlideLayoutData[]; + } + /** An interface describing the data returned by calling `slideMaster.toJSON()`. */ + export interface SlideMasterData { + /** + * Gets the unique ID of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: string; + /** + * Gets the unique name of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + name?: string; + } + /** An interface describing the data returned by calling `tag.toJSON()`. */ + export interface TagData { + /** + * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + key?: string; + /** + * Gets the value of the tag. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + value?: string; + } + /** An interface describing the data returned by calling `tagCollection.toJSON()`. */ + export interface TagCollectionData { + items?: PowerPoint.Interfaces.TagData[]; + } + /** An interface describing the data returned by calling `slide.toJSON()`. */ + export interface SlideData { + /** + * Gets the unique ID of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + id?: string; + } + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + export interface ShapeFillData { + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + foregroundColor?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency?: number; + /** + * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground"; + } + /** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */ + export interface ShapeLineFormatData { + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color?: string; + /** + * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + /** + * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"; + /** + * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency?: number; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible?: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + weight?: number; + } + /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */ + export interface BulletFormatData { + /** + * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible?: boolean; + } + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + export interface ParagraphFormatData { + /** + * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"; + } + /** An interface describing the data returned by calling `shapeFont.toJSON()`. */ + export interface ShapeFontData { + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color?: string; + /** + * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + italic?: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: string; + /** + * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + size?: number; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + } + /** An interface describing the data returned by calling `textRange.toJSON()`. */ + export interface TextRangeData { + /** + * Gets or sets the length of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + length?: number; + /** + * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + start?: number; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + text?: string; + } + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + export interface TextFrameData { + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bottomMargin?: number; + /** + * Specifies if the text frame contains text. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + hasText?: boolean; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftMargin?: number; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightMargin?: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wordWrap?: boolean; + } + /** An interface describing the data returned by calling `shape.toJSON()`. */ + export interface ShapeData { + /** + * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height?: number; + /** + * Gets the unique ID of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: string; + /** + * The distance, in points, from the left side of the shape to the left side of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left?: number; + /** + * Specifies the name of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: string; + /** + * The distance, in points, from the top edge of the shape to the top edge of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top?: number; + /** + * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table"; + /** + * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: number; + } + /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */ + export interface ShapeScopedCollectionData { + items?: PowerPoint.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `slideCollection.toJSON()`. */ + export interface SlideCollectionData { + items?: PowerPoint.Interfaces.SlideData[]; + } + /** An interface describing the data returned by calling `slideScopedCollection.toJSON()`. */ + export interface SlideScopedCollectionData { + items?: PowerPoint.Interfaces.SlideData[]; + } + /** An interface describing the data returned by calling `slideMasterCollection.toJSON()`. */ + export interface SlideMasterCollectionData { + items?: PowerPoint.Interfaces.SlideMasterData[]; + } + /** + * @remarks + * [Api set: PowerPointApi 1.0] + */ + export interface PresentationLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the ID of the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + id?: boolean; + title?: boolean; + } + /** + * Represents a single hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + export interface HyperlinkLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: boolean; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: boolean; + } + /** + * Represents a collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + export interface HyperlinkCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: boolean; + /** + * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: boolean; + } + /** + * Represents the collection of shapes. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface ShapeCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; + /** + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique ID of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of this shape. See {@link PowerPoint.ShapeType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: boolean; + } + /** + * Represents the layout of a slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface SlideLayoutLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the unique ID of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: boolean; + /** + * Gets the name of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + name?: boolean; + } + /** + * Represents the collection of layouts provided by the Slide Master for slides. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface SlideLayoutCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique ID of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + name?: boolean; + } + /** + * Represents the Slide Master of a slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface SlideMasterLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the unique ID of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: boolean; + /** + * Gets the unique name of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + name?: boolean; + } + /** + * Represents a single tag in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface TagLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + key?: boolean; + /** + * Gets the value of the tag. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + value?: boolean; + } + /** + * Represents the collection of tags. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface TagCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: Gets the value of the tag. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + value?: boolean; + } + /** + * Represents a single slide of a presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + export interface SlideLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; + /** + * Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions; + /** + * Gets the unique ID of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + id?: boolean; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface ShapeFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + foregroundColor?: boolean; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency?: boolean; + /** + * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + type?: boolean; + } + /** + * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface ShapeLineFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color?: boolean; + /** + * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + dashStyle?: boolean; + /** + * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + style?: boolean; + /** + * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + transparency?: boolean; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible?: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + weight?: boolean; + } + /** + * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface BulletFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + visible?: boolean; + } + /** + * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface ParagraphFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions; + /** + * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + horizontalAlignment?: boolean; + } + /** + * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface ShapeFontLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + color?: boolean; + /** + * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + italic?: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: boolean; + /** + * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + size?: boolean; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + underline?: boolean; + } + /** + * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface TextRangeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a `ShapeFont` object that represents the font attributes for the text range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + font?: PowerPoint.Interfaces.ShapeFontLoadOptions; + /** + * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + paragraphFormat?: PowerPoint.Interfaces.ParagraphFormatLoadOptions; + /** + * Gets or sets the length of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + length?: boolean; + /** + * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + start?: boolean; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + text?: boolean; + } + /** + * Represents the text frame of a shape object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + export interface TextFrameLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textRange?: PowerPoint.Interfaces.TextRangeLoadOptions; + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + autoSizeSetting?: boolean; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + bottomMargin?: boolean; + /** + * Specifies if the text frame contains text. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + hasText?: boolean; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + leftMargin?: boolean; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + rightMargin?: boolean; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + topMargin?: boolean; + /** + * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + verticalAlignment?: boolean; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + wordWrap?: boolean; + } + /** + * Represents a single shape in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface ShapeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; + /** + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; + /** + * Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + /** + * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height?: boolean; + /** + * Gets the unique ID of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: boolean; + /** + * The distance, in points, from the left side of the shape to the left side of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left?: boolean; + /** + * Specifies the name of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: boolean; + /** + * The distance, in points, from the top edge of the shape to the top edge of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top?: boolean; + /** + * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + type?: boolean; + /** + * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: boolean; + } + /** + * Represents a collection of shapes. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + export interface ShapeScopedCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; + /** + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the text frame object of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique ID of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of this shape. See {@link PowerPoint.ShapeType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: boolean; + } + /** + * Represents the collection of slides in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + export interface SlideCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; + /** + * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions; + /** + * For EACH ITEM in the collection: Gets the unique ID of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + id?: boolean; + } + /** + * Represents a collection of slides in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + export interface SlideScopedCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; + /** + * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions; + /** + * For EACH ITEM in the collection: Gets the unique ID of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + id?: boolean; + } + /** + * Represents the collection of Slide Masters in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + export interface SlideMasterCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique ID of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets the unique name of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + name?: boolean; + } + } +} +export declare namespace PowerPoint { + /** + * The RequestContext object facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the request context is required to get access to the PowerPoint object model from the add-in. + */ + export class RequestContext extends OfficeExtension.ClientRequestContext { + constructor(url?: string); + readonly presentation: Presentation; + readonly application: Application; + } + /** + * Executes a batch script that performs actions on the PowerPoint object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the RequestContext is required to get access to the PowerPoint object model from the add-in. + */ + export function run(batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise): OfficeExtension.IPromise; + /** + * Executes a batch script that performs actions on the PowerPoint object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param object - A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the RequestContext is required to get access to the PowerPoint object model from the add-in. + */ + export function run(object: OfficeExtension.ClientObject, batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise): OfficeExtension.IPromise; + /** + * Executes a batch script that performs actions on the PowerPoint object model, using the RequestContext of previously-created API objects. + * @param objects - An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()". + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the RequestContext is required to get access to the PowerPoint object model from the add-in. + */ + export function run(objects: OfficeExtension.ClientObject[], batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise): OfficeExtension.IPromise; +} +export declare namespace PowerPoint { + /** + * Creates and opens a new presentation. Optionally, the presentation can be pre-populated with a Base64-encoded .pptx file. + * + * [Api set: PowerPointApi 1.1] + * + * @param base64File - Optional. The Base64-encoded .pptx file. The default value is null. + */ + export function createPresentation(base64File?: string): Promise; +} + + +//////////////////////////////////////////////////////////////// +///////////////////// End PowerPoint APIs ////////////////////// +//////////////////////////////////////////////////////////////// \ No newline at end of file diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/tsconfig.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/tsconfig.json new file mode 100644 index 000000000..c8d2a749f --- /dev/null +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "target": "es6", + "forceConsistentCasingInFileNames": true, + "module": "commonjs", + "declaration": true, + "sourceMap": true, + "experimentalDecorators": true, + "types": [ + "node" + ], + "lib": [ + "es5", + "scripthost", + "es2015.collection", + "es2015.promise", + "es2015.iterable", + "dom" + ] + }, + "include": [ "powerpoint.d.ts" ] +} diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/tsdoc-metadata.json new file mode 100644 index 000000000..03ce23190 --- /dev/null +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_6/tsdoc-metadata.json @@ -0,0 +1,11 @@ +// This file is read by tools that parse documentation comments conforming to the TSDoc standard. +// It should be published with your NPM package. It should not be tracked by Git. +{ + "tsdocVersion": "0.12", + "toolPackages": [ + { + "packageName": "@microsoft/api-extractor", + "packageVersion": "7.43.0" + } + ] +} diff --git a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts index 7ada9e300..fe572c5ee 100644 --- a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts @@ -439,8 +439,7 @@ export declare namespace PowerPoint { * Represents a single hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ export class Hyperlink extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -449,16 +448,14 @@ export declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address: string; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip: string; /** @@ -492,8 +489,7 @@ export declare namespace PowerPoint { * Represents a collection of hyperlinks. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ export class HyperlinkCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -504,8 +500,7 @@ export declare namespace PowerPoint { * Gets the number of hyperlinks in the collection. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] * @returns The number of hyperlinks in the collection. */ getCount(): OfficeExtension.ClientResult; @@ -513,8 +508,7 @@ export declare namespace PowerPoint { * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] * * @param index - The index of the hyperlink in the collection. * @returns The hyperlink at the given index. An error is thrown if index is out of range. @@ -2495,8 +2489,7 @@ export declare namespace PowerPoint { * Returns a collection of hyperlinks in the slide. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ readonly hyperlinks: PowerPoint.HyperlinkCollection; /** @@ -4181,16 +4174,14 @@ export declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: string; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: string; } @@ -4614,16 +4605,14 @@ export declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: string; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: string; } @@ -5233,8 +5222,7 @@ export declare namespace PowerPoint { * Represents a single hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ export interface HyperlinkLoadOptions { /** @@ -5245,16 +5233,14 @@ export declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: boolean; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: boolean; } @@ -5262,8 +5248,7 @@ export declare namespace PowerPoint { * Represents a collection of hyperlinks. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ export interface HyperlinkCollectionLoadOptions { /** @@ -5274,16 +5259,14 @@ export declare namespace PowerPoint { * For EACH ITEM in the collection: Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: boolean; /** * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: boolean; } diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index 20f0ab91a..09097233f 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -116890,6 +116890,109 @@ declare namespace PowerPoint { */ slideMasterId?: string; } + /** + * Represents a single hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + class Hyperlink extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address: string; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Hyperlink; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Hyperlink; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.HyperlinkData; + } + /** + * Represents a collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + class HyperlinkCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Hyperlink[]; + /** + * Gets the number of hyperlinks in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.6] + * @returns The number of hyperlinks in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.6] + * + * @param index The index of the hyperlink in the collection. + * @returns The hyperlink at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Hyperlink; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData; + } /** * Specifies the connector type for line shapes. * @@ -118788,6 +118891,13 @@ declare namespace PowerPoint { class Slide extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * Returns a collection of hyperlinks in the slide. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + readonly hyperlinks: PowerPoint.HyperlinkCollection; /** * Gets the layout of the slide. * @@ -120097,6 +120207,27 @@ declare namespace PowerPoint { */ $skip?: number; } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + interface HyperlinkUpdateData { + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: string; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: string; + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + interface HyperlinkCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -120389,6 +120520,27 @@ declare namespace PowerPoint { id?: string; title?: string; } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + interface HyperlinkData { + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: string; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: string; + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + interface HyperlinkCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ interface ShapeCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; @@ -120767,6 +120919,58 @@ declare namespace PowerPoint { id?: boolean; title?: boolean; } + /** + * Represents a single hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + interface HyperlinkLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: boolean; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: boolean; + } + /** + * Represents a collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + interface HyperlinkCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the URL target of the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: boolean; + /** + * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: boolean; + } /** * Represents the collection of shapes. * diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 961582b49..eb797215f 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -122863,8 +122863,7 @@ declare namespace PowerPoint { * Represents a single hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ class Hyperlink extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -122873,16 +122872,14 @@ declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address: string; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip: string; /** @@ -122916,8 +122913,7 @@ declare namespace PowerPoint { * Represents a collection of hyperlinks. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ class HyperlinkCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -122928,8 +122924,7 @@ declare namespace PowerPoint { * Gets the number of hyperlinks in the collection. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] * @returns The number of hyperlinks in the collection. */ getCount(): OfficeExtension.ClientResult; @@ -122937,8 +122932,7 @@ declare namespace PowerPoint { * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] * * @param index The index of the hyperlink in the collection. * @returns The hyperlink at the given index. An error is thrown if index is out of range. @@ -124919,8 +124913,7 @@ declare namespace PowerPoint { * Returns a collection of hyperlinks in the slide. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ readonly hyperlinks: PowerPoint.HyperlinkCollection; /** @@ -126605,16 +126598,14 @@ declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: string; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: string; } @@ -127038,16 +127029,14 @@ declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: string; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: string; } @@ -127657,8 +127646,7 @@ declare namespace PowerPoint { * Represents a single hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ interface HyperlinkLoadOptions { /** @@ -127669,16 +127657,14 @@ declare namespace PowerPoint { * Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: boolean; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: boolean; } @@ -127686,8 +127672,7 @@ declare namespace PowerPoint { * Represents a collection of hyperlinks. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ interface HyperlinkCollectionLoadOptions { /** @@ -127698,16 +127683,14 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Specifies the URL target of the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ address?: boolean; /** * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.6] */ screenTip?: boolean; } diff --git a/generate-docs/script-inputs/script-lab-snippets.yaml b/generate-docs/script-inputs/script-lab-snippets.yaml index 110a66664..a06d783df 100644 --- a/generate-docs/script-inputs/script-lab-snippets.yaml +++ b/generate-docs/script-inputs/script-lab-snippets.yaml @@ -13929,7 +13929,7 @@ 'PowerPoint.Hyperlink:class': - >- // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/preview-apis/manage-hyperlinks.yaml + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml // Gets the hyperlinks found in the first selected slide. @@ -13948,7 +13948,7 @@ 'PowerPoint.HyperlinkCollection:class': - >- // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/preview-apis/manage-hyperlinks.yaml + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml // Gets the hyperlinks found in the first selected slide. diff --git a/generate-docs/scripts/midprocessor.ts b/generate-docs/scripts/midprocessor.ts index a1ae0e5fd..83cedc05c 100644 --- a/generate-docs/scripts/midprocessor.ts +++ b/generate-docs/scripts/midprocessor.ts @@ -8,7 +8,7 @@ const CURRENT_EXCEL_RELEASE = 17; const OLDEST_EXCEL_RELEASE_WITH_CUSTOM_FUNCTIONS = 9; const CURRENT_OUTLOOK_RELEASE = 14; const CURRENT_WORD_RELEASE = 8; -const CURRENT_POWERPOINT_RELEASE = 5; +const CURRENT_POWERPOINT_RELEASE = 6; tryCatch(async () => { // ---- @@ -49,8 +49,8 @@ tryCatch(async () => { console.log("\nCreating snippets file..."); - console.log("\nReading from: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/snippet-extractor-output/snippets.yaml"); - fsx.writeFileSync("../script-inputs/script-lab-snippets.yaml", await fetchAndThrowOnError("https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/snippet-extractor-output/snippets.yaml", "text")); + console.log("\nReading from: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/84b51d1463bb71186d9bde739207d6aca0c4b078/snippet-extractor-output/snippets.yaml"); + fsx.writeFileSync("../script-inputs/script-lab-snippets.yaml", await fetchAndThrowOnError("https://raw.githubusercontent.com/OfficeDev/office-js-snippets/84b51d1463bb71186d9bde739207d6aca0c4b078/snippet-extractor-output/snippets.yaml", "text")); console.log("\nReading from files: " + path.resolve("../../docs/code-snippets")); diff --git a/generate-docs/scripts/postprocessor.ts b/generate-docs/scripts/postprocessor.ts index 108feb60a..bba3c760f 100644 --- a/generate-docs/scripts/postprocessor.ts +++ b/generate-docs/scripts/postprocessor.ts @@ -96,7 +96,7 @@ tryCatch(async () => { const hostVersionMap = [{host: "excel", versions: 18}, /*not including online*/ {host: "onenote", versions: 1}, {host: "outlook", versions: 15}, - {host: "powerpoint", versions: 6}, + {host: "powerpoint", versions: 7}, {host: "visio", versions: 1}, {host: "word", versions: 9}]; /* not including online or desktop*/ diff --git a/generate-docs/scripts/preprocessor.ts b/generate-docs/scripts/preprocessor.ts index 1812281d3..3651d381e 100644 --- a/generate-docs/scripts/preprocessor.ts +++ b/generate-docs/scripts/preprocessor.ts @@ -42,8 +42,8 @@ tryCatch(async () => { case "DT": forceRebuild = false; case "DT+": - urlToCopyOfficeJsFrom = "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/master/types/office-js/index.d.ts"; - urlToCopyPreviewOfficeJsFrom = "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/master/types/office-js-preview/index.d.ts"; + urlToCopyOfficeJsFrom = "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/fdf07dcc56f8e213329e90e2a5d57f269ef71b57/types/office-js/index.d.ts"; + urlToCopyPreviewOfficeJsFrom = "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/fdf07dcc56f8e213329e90e2a5d57f269ef71b57/types/office-js-preview/index.d.ts"; urlToCopyCustomFunctionsRuntimeFrom = "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/master/types/custom-functions-runtime/index.d.ts"; urlToCopyOfficeRuntimeFrom = "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/master/types/office-runtime/index.d.ts"; break; @@ -159,7 +159,7 @@ tryCatch(async () => { console.log("create file: powerpoint.d.ts (release)"); makeDtsAndClearJsonIfNew( - '../api-extractor-inputs-powerpoint-release/PowerPoint_1_5/powerpoint.d.ts', + '../api-extractor-inputs-powerpoint-release/PowerPoint_1_6/powerpoint.d.ts', handleCommonImports(handleLiteralParameterOverloads(dtsBuilder.extractDtsSection(releaseDefinitions, "Begin PowerPoint APIs", "End PowerPoint APIs")), "Other", true), "powerpoint", forceRebuild