diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json
index 56f2d83a65..9d3a1865a3 100644
--- a/.openpublishing.publish.config.json
+++ b/.openpublishing.publish.config.json
@@ -51,6 +51,7 @@
"powerpoint-js-1.5",
"powerpoint-js-1.6",
"powerpoint-js-1.7",
+ "powerpoint-js-1.8",
"visio-js-1.1",
"word-js-preview",
"word-js-1.1",
@@ -309,6 +310,10 @@
"ReferenceTOC": "docs/docs-ref-autogen/powerpoint_1_7/toc.yml",
"ConceptualTOCUrl": "/office/dev/add-ins/toc.json"
},
+ {
+ "ReferenceTOC": "docs/docs-ref-autogen/powerpoint_1_8/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 e37aa6aead..a1ea473a42 100644
--- a/docs/docfx.json
+++ b/docs/docfx.json
@@ -659,6 +659,18 @@
"src": "docs-ref-autogen/powerpoint_1_7",
"dest": "api"
},
+ {
+ "files": ["**/toc.yml"],
+ "group": "powerpoint-js-1.8",
+ "src": "docs-ref-autogen/powerpoint_1_8",
+ "dest": "api/office-js-docs-reference"
+ },
+ {
+ "files": ["**/*.md", "**/*.yml"],
+ "group": "powerpoint-js-1.8",
+ "src": "docs-ref-autogen/powerpoint_1_8",
+ "dest": "api"
+ },
{
"files": ["**/toc.yml"],
"group": "visio-js-1.1",
@@ -1059,6 +1071,10 @@
"dest": "powerpoint-js-1.7",
"moniker_range": "powerpoint-js-1.7"
},
+ "powerpoint-js-1.8": {
+ "dest": "powerpoint-js-1.8",
+ "moniker_range": "powerpoint-js-1.8"
+ },
"visio-js-1.1": {
"dest": "visio-js-1.1",
"moniker_range": "visio-js-1.1"
@@ -1226,6 +1242,7 @@
"docs-ref-autogen/powerpoint_1_5/**": "powerpoint",
"docs-ref-autogen/powerpoint_1_6/**": "powerpoint",
"docs-ref-autogen/powerpoint_1_7/**": "powerpoint",
+ "docs-ref-autogen/powerpoint_1_8/**": "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 b8d544898c..da864d989c 100644
--- a/docs/docs-ref-autogen/common/toc.yml
+++ b/docs/docs-ref-autogen/common/toc.yml
@@ -829,6 +829,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/common_preview/toc.yml b/docs/docs-ref-autogen/common_preview/toc.yml
index bd87c00748..1b4c9f78cb 100644
--- a/docs/docs-ref-autogen/common_preview/toc.yml
+++ b/docs/docs-ref-autogen/common_preview/toc.yml
@@ -831,6 +831,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml
index 720ac2fbc1..f9ee7d4a24 100644
--- a/docs/docs-ref-autogen/excel/toc.yml
+++ b/docs/docs-ref-autogen/excel/toc.yml
@@ -2027,6 +2027,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 4989260833..7583fbc6c0 100644
--- a/docs/docs-ref-autogen/excel_1_1/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_1/toc.yml
@@ -971,6 +971,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 7728706c76..10fba01450 100644
--- a/docs/docs-ref-autogen/excel_1_10/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_10/toc.yml
@@ -1655,6 +1655,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 822cbf25f2..00c218fdd7 100644
--- a/docs/docs-ref-autogen/excel_1_11/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_11/toc.yml
@@ -1667,6 +1667,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 2ef35c8910..a8f92ad421 100644
--- a/docs/docs-ref-autogen/excel_1_12/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_12/toc.yml
@@ -1713,6 +1713,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 61bdf949dd..863dcbe86b 100644
--- a/docs/docs-ref-autogen/excel_1_13/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_13/toc.yml
@@ -1723,6 +1723,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 55fb1f8f04..d2969fa210 100644
--- a/docs/docs-ref-autogen/excel_1_14/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_14/toc.yml
@@ -1741,6 +1741,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 649e16e2fe..ea36c2eb1e 100644
--- a/docs/docs-ref-autogen/excel_1_15/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_15/toc.yml
@@ -1745,6 +1745,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 2677bed031..37cdc9813b 100644
--- a/docs/docs-ref-autogen/excel_1_16/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_16/toc.yml
@@ -1875,6 +1875,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 a5404e13a3..4696eb987a 100644
--- a/docs/docs-ref-autogen/excel_1_17/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_17/toc.yml
@@ -1881,6 +1881,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel_1_18/toc.yml b/docs/docs-ref-autogen/excel_1_18/toc.yml
index e89337ab7d..885d9d0ca6 100644
--- a/docs/docs-ref-autogen/excel_1_18/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_18/toc.yml
@@ -1899,6 +1899,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 195d719780..2cbe0a0adb 100644
--- a/docs/docs-ref-autogen/excel_1_2/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_2/toc.yml
@@ -1068,6 +1068,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 2a0c734731..6c307e06ae 100644
--- a/docs/docs-ref-autogen/excel_1_3/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_3/toc.yml
@@ -1076,6 +1076,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 bcfb5ebde5..8cde393834 100644
--- a/docs/docs-ref-autogen/excel_1_4/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_4/toc.yml
@@ -1084,6 +1084,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 4a286569e7..7117ace011 100644
--- a/docs/docs-ref-autogen/excel_1_5/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_5/toc.yml
@@ -1092,6 +1092,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 1e876eeaa9..d6d70a4f95 100644
--- a/docs/docs-ref-autogen/excel_1_6/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_6/toc.yml
@@ -1174,6 +1174,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 1bf38ea455..de30fbd982 100644
--- a/docs/docs-ref-autogen/excel_1_7/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_7/toc.yml
@@ -1276,6 +1276,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 f127f5fff3..10b2de7aa1 100644
--- a/docs/docs-ref-autogen/excel_1_8/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_8/toc.yml
@@ -1370,6 +1370,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 2091653899..aa7493dd9b 100644
--- a/docs/docs-ref-autogen/excel_1_9/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_9/toc.yml
@@ -1611,6 +1611,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel_online/toc.yml b/docs/docs-ref-autogen/excel_online/toc.yml
index 7af251c92b..60b3f3e0ff 100644
--- a/docs/docs-ref-autogen/excel_online/toc.yml
+++ b/docs/docs-ref-autogen/excel_online/toc.yml
@@ -1915,6 +1915,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/onenote/toc.yml b/docs/docs-ref-autogen/onenote/toc.yml
index 508806c292..12dc16ce00 100644
--- a/docs/docs-ref-autogen/onenote/toc.yml
+++ b/docs/docs-ref-autogen/onenote/toc.yml
@@ -933,6 +933,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml
index 444704474d..a14e4a9809 100644
--- a/docs/docs-ref-autogen/outlook/toc.yml
+++ b/docs/docs-ref-autogen/outlook/toc.yml
@@ -1039,6 +1039,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 4bb9c08499..f7d15c54a4 100644
--- a/docs/docs-ref-autogen/outlook_1_1/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml
@@ -903,6 +903,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 c9f5f481e2..8128df88c7 100644
--- a/docs/docs-ref-autogen/outlook_1_10/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml
@@ -993,6 +993,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 2e8033fcd4..456a067526 100644
--- a/docs/docs-ref-autogen/outlook_1_11/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml
@@ -995,6 +995,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 7859d9341c..4994911c4d 100644
--- a/docs/docs-ref-autogen/outlook_1_12/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml
@@ -997,6 +997,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 d947e0da16..ae9b4b1257 100644
--- a/docs/docs-ref-autogen/outlook_1_13/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml
@@ -1009,6 +1009,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 786293ada2..a8b3b42e28 100644
--- a/docs/docs-ref-autogen/outlook_1_14/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml
@@ -1023,6 +1023,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/outlook_1_15/toc.yml b/docs/docs-ref-autogen/outlook_1_15/toc.yml
index 0fa24017ed..76caf565fb 100644
--- a/docs/docs-ref-autogen/outlook_1_15/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_15/toc.yml
@@ -1029,6 +1029,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 a10da0838a..8c7f3c8154 100644
--- a/docs/docs-ref-autogen/outlook_1_2/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml
@@ -905,6 +905,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 b218df019e..8502d3bbf2 100644
--- a/docs/docs-ref-autogen/outlook_1_3/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml
@@ -913,6 +913,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 b218df019e..8502d3bbf2 100644
--- a/docs/docs-ref-autogen/outlook_1_4/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml
@@ -913,6 +913,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 b218df019e..8502d3bbf2 100644
--- a/docs/docs-ref-autogen/outlook_1_5/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml
@@ -913,6 +913,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 b218df019e..8502d3bbf2 100644
--- a/docs/docs-ref-autogen/outlook_1_6/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml
@@ -913,6 +913,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 d1a295b1e6..5d3adbb199 100644
--- a/docs/docs-ref-autogen/outlook_1_7/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml
@@ -943,6 +943,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 3ffff9bc3c..fd7819b845 100644
--- a/docs/docs-ref-autogen/outlook_1_8/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml
@@ -977,6 +977,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-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 3ffff9bc3c..fd7819b845 100644
--- a/docs/docs-ref-autogen/outlook_1_9/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml
@@ -977,6 +977,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/overview/overview.md b/docs/docs-ref-autogen/overview/overview.md
index 474c7b1cd3..0f41ba2a13 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: 03/11/2025
+ms.date: 04/22/2025
---
# Office Add-ins JavaScript API reference
@@ -96,6 +96,7 @@ The following is a list of APIs for the [supported Office host applications](/of
PowerPoint APIs
- PowerPointApi Preview
+ - PowerPointApi 1.8
- PowerPointApi 1.7
- PowerPointApi 1.6
- PowerPointApi 1.5
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml
index 38dedea374..22a59258f0 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Binding
summary: Represents an Office.js binding that is defined in the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -22,7 +22,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -34,11 +34,11 @@ properties:
fullName: id
summary: Represents the binding identifier.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: string;'
@@ -50,11 +50,11 @@ properties:
fullName: type
summary: Returns the type of the binding. See `BindingType` for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly type: PowerPoint.BindingType | "Shape";'
@@ -67,11 +67,11 @@ methods:
fullName: delete()
summary: Deletes the binding.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'delete(): void;'
@@ -86,11 +86,11 @@ methods:
Returns the shape represented by the binding. Will throw an error if the
binding is not of the correct type.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getShape(): PowerPoint.Shape;'
@@ -106,7 +106,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -131,7 +131,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.Binding;'
@@ -153,7 +153,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -191,7 +191,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.BindingData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingcollection.yml
index 8cc3a2da1b..318921f5ae 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingcollection.yml
@@ -7,11 +7,11 @@ summary: >-
Represents the collection of all the binding objects that are part of the
presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -24,7 +24,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -37,7 +37,7 @@ properties:
summary: Gets the loaded child items in this collection.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly items: PowerPoint.Binding[];'
@@ -52,11 +52,11 @@ methods:
Adds a new binding to a particular Shape. If the provided ID is already
being used by a binding, the existing binding will be overwritten.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -83,11 +83,11 @@ methods:
Adds a new binding to a particular Shape. If the provided ID is already
being used by a binding, the existing binding will be overwritten.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -114,11 +114,11 @@ methods:
Adds a new binding based on the current selection. If the selection has
multiple areas, the `InvalidReference` error will be returned.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -142,11 +142,11 @@ methods:
Adds a new binding based on the current selection. If the selection has
multiple areas, the `InvalidReference` error will be returned.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -168,11 +168,11 @@ methods:
fullName: getCount()
summary: Gets the number of bindings in the collection.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getCount(): OfficeExtension.ClientResult;'
@@ -187,11 +187,11 @@ methods:
Gets a binding object by ID. Throws an ItemNotFoundException if there's no
binding with that ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getItem(key: string): PowerPoint.Binding;'
@@ -211,11 +211,11 @@ methods:
InvalidArgumentException if the index less than 0, or greater than or
equal to the count of items in the collection.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getItemAt(index: number): PowerPoint.Binding;'
@@ -237,11 +237,11 @@ methods:
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getItemOrNullObject(id: string): PowerPoint.Binding;'
@@ -261,7 +261,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -289,7 +289,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.BindingCollection;'
@@ -311,7 +311,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -344,7 +344,7 @@ methods:
collection's items.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.BindingCollectionData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingtype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingtype.yml
index b8b9871c1c..339cf901af 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingtype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bindingtype.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.BindingType
summary: Represents the possible binding types.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: shape
@@ -19,7 +19,7 @@ fields:
Represents a shape binding.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Shape"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.borderproperties.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.borderproperties.yml
index c5736e18bb..1609dcdc68 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.borderproperties.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.borderproperties.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.BorderProperties
summary: Represents the properties for a table cell border.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -21,11 +21,11 @@ properties:
Represents the line color in the hexadecimal format \#RRGGBB (e.g.,
"FFA500") or as a named HTML color value (e.g., "orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color?: string | undefined;'
@@ -37,11 +37,11 @@ properties:
fullName: dashStyle
summary: Represents the dash style of the line.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -63,11 +63,11 @@ properties:
Specifies the transparency percentage of the line as a value from 0.0
(opaque) through 1.0 (clear).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: number | undefined;'
@@ -79,11 +79,11 @@ properties:
fullName: weight
summary: Represents the weight of the line, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'weight?: number | undefined;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fillproperties.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fillproperties.yml
index f3af00570b..1d29fbfc8b 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fillproperties.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fillproperties.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.FillProperties
summary: Represents the fill formatting of a table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -21,11 +21,11 @@ properties:
Represents the shape fill color in the hexadecimal format \#RRGGBB (e.g.,
"FFA500") or as a named HTML color value (e.g., "orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color?: string | undefined;'
@@ -39,11 +39,11 @@ properties:
Specifies the transparency percentage of the fill as a value from 0.0
(opaque) through 1.0 (clear).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: number | undefined;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fontproperties.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fontproperties.yml
index 2f27441344..fcd80ca95e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fontproperties.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.fontproperties.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.FontProperties
summary: Represents the font attributes, such as font name, size, and color.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -21,11 +21,11 @@ properties:
Represents whether the font uses all caps, where lowercase letters are
shown as capital letters.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'allCaps?: boolean | undefined;'
@@ -37,11 +37,11 @@ properties:
fullName: bold
summary: Represents the bold status of font.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'bold?: boolean | undefined;'
@@ -55,11 +55,11 @@ properties:
Represents the HTML color in the hexadecimal format (e.g., "\#FF0000"
represents red) or as a named HTML color value (e.g., "red").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color?: string | undefined;'
@@ -71,11 +71,11 @@ properties:
fullName: doubleStrikethrough
summary: Represents the double-strikethrough status of the font.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'doubleStrikethrough?: boolean | undefined;'
@@ -87,11 +87,11 @@ properties:
fullName: italic
summary: Represents the italic status of font.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'italic?: boolean | undefined;'
@@ -106,11 +106,11 @@ properties:
Script or East Asian language, this is the corresponding font name;
otherwise it's the Latin font name.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'name?: string | undefined;'
@@ -122,11 +122,11 @@ properties:
fullName: size
summary: Represents the font size in points (e.g., 11).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'size?: number | undefined;'
@@ -140,11 +140,11 @@ properties:
Represents whether the text uses small caps, where lowercase letters are
shown as small capital letters.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'smallCaps?: boolean | undefined;'
@@ -156,11 +156,11 @@ properties:
fullName: strikethrough
summary: Represents the strikethrough status of the font.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'strikethrough?: boolean | undefined;'
@@ -172,11 +172,11 @@ properties:
fullName: subscript
summary: Represents the subscript status of the font.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'subscript?: boolean | undefined;'
@@ -188,11 +188,11 @@ properties:
fullName: superscript
summary: Represents the superscript status of the font.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'superscript?: boolean | undefined;'
@@ -207,11 +207,11 @@ properties:
[PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml
index 8302bab706..9fab8d724f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml
@@ -7,11 +7,11 @@ summary: >-
Represents the collection of all the binding objects that are part of the
presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -25,7 +25,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -37,11 +37,11 @@ properties:
fullName: id
summary: 'For EACH ITEM in the collection: Represents the binding identifier.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
@@ -55,11 +55,11 @@ properties:
For EACH ITEM in the collection: Returns the type of the binding. See
`BindingType` for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'type?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingdata.yml
index a60db0c8de..29ff917fca 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -18,11 +18,11 @@ properties:
fullName: id
summary: Represents the binding identifier.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'id?: string;'
@@ -34,11 +34,11 @@ properties:
fullName: type
summary: Returns the type of the binding. See `BindingType` for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'type?: PowerPoint.BindingType | "Shape";'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingloadoptions.yml
index a674b62441..c46636dbe7 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bindingloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.BindingLoadOptions
summary: Represents an Office.js binding that is defined in the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -23,7 +23,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -35,11 +35,11 @@ properties:
fullName: id
summary: Represents the binding identifier.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
@@ -51,11 +51,11 @@ properties:
fullName: type
summary: Returns the type of the binding. See `BindingType` for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'type?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
index 0fe8d178cc..7b7cd7970e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -22,11 +22,11 @@ properties:
[PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
details. Returns `null` if the placeholder is empty.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -50,11 +50,11 @@ properties:
[PowerPoint.PlaceholderType](xref:powerpoint!PowerPoint.PlaceholderType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml
index e95981fc8d..85885ac813 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.PlaceholderFormatLoadOptions
summary: Represents the properties of a `placeholder` shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -23,7 +23,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -39,11 +39,11 @@ properties:
[PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
details. Returns `null` if the placeholder is empty.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'containedType?: boolean;'
@@ -58,11 +58,11 @@ properties:
[PowerPoint.PlaceholderType](xref:powerpoint!PowerPoint.PlaceholderType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'type?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
index 036f843235..f4bb5cc68f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
@@ -59,11 +59,11 @@ properties:
the shape. If the shape type isn't `group`, then this method
returns the `GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;'
@@ -138,11 +138,11 @@ properties:
- A level greater than 1 indicates the shape is a nested group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'level?: boolean;'
@@ -196,11 +196,11 @@ properties:
If the shape isn't part of a group, then this method returns the
`GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;'
@@ -219,11 +219,11 @@ properties:
`placeholder`, then this method returns the `GeneralException`
error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;'
@@ -322,11 +322,11 @@ properties:
stack, so two shapes on separate slides could have the same z-order
number.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'zOrderPosition?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapedata.yml
index 3a94fb9d26..c85fcd0e57 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapedata.yml
@@ -75,11 +75,11 @@ properties:
- A level greater than 1 indicates the shape is a nested group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'level?: number;'
@@ -174,11 +174,11 @@ properties:
slide also has a unique z-order stack, so two shapes on separate slides
could have the same z-order number.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'zOrderPosition?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontdata.yml
index 1e7364c35e..283806cbf0 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontdata.yml
@@ -31,11 +31,11 @@ properties:
- `null`: Some, but not all, of the text has the **All Caps**
attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'allCaps?: boolean | null;'
@@ -107,11 +107,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Double strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'doubleStrikethrough?: boolean | null;'
@@ -202,11 +202,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Small Caps** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'smallCaps?: boolean | null;'
@@ -231,11 +231,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'strikethrough?: boolean | null;'
@@ -259,11 +259,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Subscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'subscript?: boolean | null;'
@@ -287,11 +287,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Superscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'superscript?: boolean | null;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml
index 0d80c24a6d..620f108623 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml
@@ -50,11 +50,11 @@ properties:
- `null`: Some, but not all, of the text has the **All Caps**
attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'allCaps?: boolean;'
@@ -127,11 +127,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Double strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'doubleStrikethrough?: boolean;'
@@ -222,11 +222,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Small Caps** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'smallCaps?: boolean;'
@@ -251,11 +251,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'strikethrough?: boolean;'
@@ -279,11 +279,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Subscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'subscript?: boolean;'
@@ -307,11 +307,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Superscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'superscript?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml
index 093998204a..bf51c6fd2b 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml
@@ -31,11 +31,11 @@ properties:
- `null`: Some, but not all, of the text has the **All Caps**
attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'allCaps?: boolean | null;'
@@ -108,11 +108,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Double strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'doubleStrikethrough?: boolean | null;'
@@ -203,11 +203,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Small Caps** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'smallCaps?: boolean | null;'
@@ -232,11 +232,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'strikethrough?: boolean | null;'
@@ -260,11 +260,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Subscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'subscript?: boolean | null;'
@@ -288,11 +288,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Superscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'superscript?: boolean | null;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegroupdata.yml
index fcaa0c7d85..9e9a91cdd9 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegroupdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -18,11 +18,11 @@ properties:
fullName: id
summary: Gets the unique ID of the shape group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'id?: string;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
index b28139bdfb..d3e4b4957f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
@@ -7,11 +7,11 @@ summary: >-
Represents a shape group inside a presentation. To get the corresponding Shape
object, use `ShapeGroup.shape`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -25,7 +25,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -37,11 +37,11 @@ properties:
fullName: id
summary: Gets the unique ID of the shape group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'id?: boolean;'
@@ -53,11 +53,11 @@ properties:
fullName: shape
summary: Returns the `Shape` object associated with the group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'shape?: PowerPoint.Interfaces.ShapeLoadOptions;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
index 565a464e4d..ba9d963b14 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
@@ -57,11 +57,11 @@ properties:
isn't `group`, then this method returns the `GeneralException`
error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;'
@@ -135,11 +135,11 @@ properties:
- A level greater than 1 indicates the shape is a nested group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'level?: boolean;'
@@ -188,11 +188,11 @@ properties:
Returns the parent group of this shape. If the shape isn't part of a
group, then this method returns the `GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;'
@@ -209,11 +209,11 @@ properties:
shape type isn't `placeholder`, then this method returns the
`GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;'
@@ -306,11 +306,11 @@ properties:
slide also has a unique z-order stack, so two shapes on separate slides
could have the same z-order number.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'zOrderPosition?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
index 3708d489a6..a7d0a0e970 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
@@ -62,11 +62,11 @@ properties:
the shape. If the shape type isn't `group`, then this method
returns the `GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;'
@@ -145,11 +145,11 @@ properties:
- A level greater than 1 indicates the shape is a nested group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'level?: boolean;'
@@ -204,11 +204,11 @@ properties:
If the shape isn't part of a group, then this method returns the
`GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;'
@@ -227,11 +227,11 @@ properties:
`placeholder`, then this method returns the `GeneralException`
error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;'
@@ -333,11 +333,11 @@ properties:
stack, so two shapes on separate slides could have the same z-order
number.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'zOrderPosition?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
index 5c21b3c6aa..237e66f916 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
@@ -53,11 +53,11 @@ properties:
For EACH ITEM in the collection: Returns the zero-based index of the slide
representing its position in the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'index?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidedata.yml
index 9dafc33c2d..6f16449fa8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidedata.yml
@@ -34,11 +34,11 @@ properties:
Returns the zero-based index of the slide representing its position in the
presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'index?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
index 4914faca01..1d8a52c93b 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
@@ -71,11 +71,11 @@ properties:
fullName: type
summary: 'For EACH ITEM in the collection: Returns the type of the slide layout.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'type?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutdata.yml
index 5b1b6d0f01..d7092360b4 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutdata.yml
@@ -50,11 +50,11 @@ properties:
fullName: type
summary: Returns the type of the slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
index 0643f341cc..5b7ef53a54 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
@@ -67,11 +67,11 @@ properties:
fullName: type
summary: Returns the type of the slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'type?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slideloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slideloadoptions.yml
index 6ceb1d1fed..9003b3af6a 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slideloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slideloadoptions.yml
@@ -53,11 +53,11 @@ properties:
Returns the zero-based index of the slide representing its position in the
presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'index?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
index 59fca372c1..10c8984510 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
@@ -56,11 +56,11 @@ properties:
For EACH ITEM in the collection: Returns the zero-based index of the slide
representing its position in the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'index?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml
index a8d7227731..8efd219d45 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.TableCellCollectionLoadOptions
summary: Represents a collection of table cells.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -24,7 +24,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -39,11 +39,11 @@ properties:
For EACH ITEM in the collection: Gets the number of table columns this
cell spans across. Will be greater than or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnCount?: boolean;'
@@ -58,11 +58,11 @@ properties:
For EACH ITEM in the collection: Gets the zero-based column index of the
cell within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnIndex?: boolean;'
@@ -77,11 +77,11 @@ properties:
For EACH ITEM in the collection: Gets the number of table rows this cell
spans across. Will be greater than or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowCount?: boolean;'
@@ -96,11 +96,11 @@ properties:
For EACH ITEM in the collection: Gets the zero-based row index of the cell
within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowIndex?: boolean;'
@@ -115,11 +115,11 @@ properties:
For EACH ITEM in the collection: Specifies the text content of the table
cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'text?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecelldata.yml
index 7e754c6c4e..92f5ac202f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecelldata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -20,11 +20,11 @@ properties:
Gets the number of table columns this cell spans across. Will be greater
than or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnCount?: number;'
@@ -36,11 +36,11 @@ properties:
fullName: columnIndex
summary: Gets the zero-based column index of the cell within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnIndex?: number;'
@@ -54,11 +54,11 @@ properties:
Gets the number of table rows this cell spans across. Will be greater than
or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowCount?: number;'
@@ -70,11 +70,11 @@ properties:
fullName: rowIndex
summary: Gets the zero-based row index of the cell within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowIndex?: number;'
@@ -86,11 +86,11 @@ properties:
fullName: text
summary: Specifies the text content of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'text?: string;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml
index 6443d82fb2..b13acb7a9e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.TableCellLoadOptions
summary: Represents a table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -23,7 +23,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -37,11 +37,11 @@ properties:
Gets the number of table columns this cell spans across. Will be greater
than or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnCount?: boolean;'
@@ -53,11 +53,11 @@ properties:
fullName: columnIndex
summary: Gets the zero-based column index of the cell within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnIndex?: boolean;'
@@ -71,11 +71,11 @@ properties:
Gets the number of table rows this cell spans across. Will be greater than
or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowCount?: boolean;'
@@ -87,11 +87,11 @@ properties:
fullName: rowIndex
summary: Gets the zero-based row index of the cell within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowIndex?: boolean;'
@@ -103,11 +103,11 @@ properties:
fullName: text
summary: Specifies the text content of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'text?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
index d955484b30..ea50d49efc 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -18,11 +18,11 @@ properties:
fullName: text
summary: Specifies the text content of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'text?: string;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tabledata.yml
index 105d698240..0cb2e59f2f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tabledata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -16,11 +16,11 @@ properties:
fullName: columnCount
summary: Gets the number of columns in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnCount?: number;'
@@ -32,11 +32,11 @@ properties:
fullName: rowCount
summary: Gets the number of rows in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowCount?: number;'
@@ -48,11 +48,11 @@ properties:
fullName: values
summary: Gets all of the values in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'values?: string[][];'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tableloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tableloadoptions.yml
index f65bd60631..1684785ef5 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tableloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.tableloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.TableLoadOptions
summary: Represents a table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -23,7 +23,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -35,11 +35,11 @@ properties:
fullName: columnCount
summary: Gets the number of columns in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnCount?: boolean;'
@@ -51,11 +51,11 @@ properties:
fullName: rowCount
summary: Gets the number of rows in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowCount?: boolean;'
@@ -67,11 +67,11 @@ properties:
fullName: values
summary: Gets all of the values in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'values?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholderformat.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholderformat.yml
index 6711c21420..b77f78b35e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholderformat.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholderformat.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.PlaceholderFormat
summary: Represents the properties of a `placeholder` shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -22,11 +22,11 @@ properties:
[PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
details. Returns `null` if the placeholder is empty.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -50,7 +50,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -65,11 +65,11 @@ properties:
[PowerPoint.PlaceholderType](xref:powerpoint!PowerPoint.PlaceholderType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -95,7 +95,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -120,7 +120,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat;'
@@ -142,7 +142,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -180,7 +180,7 @@ methods:
shallow copies of any loaded child properties from the original object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholdertype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholdertype.yml
index d62cb80a40..3e35b531c1 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholdertype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholdertype.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.PlaceholderType
summary: Specifies the type of a placeholder.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: body
@@ -19,8 +19,8 @@ fields:
The placeholder is for a body.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Body"'
- name: cameo
@@ -30,8 +30,8 @@ fields:
The placeholder is for a cameo.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Cameo"'
- name: centerTitle
@@ -41,8 +41,8 @@ fields:
The placeholder is for a center title.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"CenterTitle"'
- name: chart
@@ -52,8 +52,8 @@ fields:
The placeholder is for a chart.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Chart"'
- name: content
@@ -63,8 +63,8 @@ fields:
The placeholder is for generic content.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Content"'
- name: date
@@ -74,8 +74,8 @@ fields:
The placeholder is for a date.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Date"'
- name: footer
@@ -85,8 +85,8 @@ fields:
The placeholder is for a footer.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Footer"'
- name: header
@@ -96,8 +96,8 @@ fields:
The placeholder is for a header.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Header"'
- name: media
@@ -107,8 +107,8 @@ fields:
The placeholder is for media.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Media"'
- name: onlinePicture
@@ -118,8 +118,8 @@ fields:
The placeholder is for an online picture.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"OnlinePicture"'
- name: picture
@@ -129,8 +129,8 @@ fields:
The placeholder is for a picture.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Picture"'
- name: slideNumber
@@ -140,8 +140,8 @@ fields:
The placeholder is for a slide number.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SlideNumber"'
- name: smartArt
@@ -151,8 +151,8 @@ fields:
The placeholder is for a SmartArt.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SmartArt"'
- name: subtitle
@@ -162,8 +162,8 @@ fields:
The placeholder is for a subtitle.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Subtitle"'
- name: table
@@ -173,8 +173,8 @@ fields:
The placeholder is for a table.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Table"'
- name: title
@@ -184,8 +184,8 @@ fields:
The placeholder is for a title.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Title"'
- name: unsupported
@@ -195,8 +195,8 @@ fields:
The placeholder is unsupported.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Unsupported"'
- name: verticalBody
@@ -206,8 +206,8 @@ fields:
The placeholder is for a vertical body.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"VerticalBody"'
- name: verticalContent
@@ -217,8 +217,8 @@ fields:
The placeholder is for generic vertical content.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"VerticalContent"'
- name: verticalTitle
@@ -228,7 +228,7 @@ fields:
The placeholder is for a vertical title.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"VerticalTitle"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml
index 75095adb1c..8186963ce0 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml
@@ -49,11 +49,11 @@ properties:
Returns a collection of bindings that are associated with the
presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly bindings: PowerPoint.BindingCollection;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml
index 2a11eae459..7ba40cec83 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml
@@ -123,11 +123,11 @@ properties:
isn't `group`, then this method returns the `GeneralException`
error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly group: PowerPoint.ShapeGroup;'
@@ -268,11 +268,11 @@ properties:
- A level greater than 1 indicates the shape is a nested group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly level: number;'
@@ -318,11 +318,11 @@ properties:
Returns the parent group of this shape. If the shape isn't part of a
group, then this method returns the `GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly parentGroup: PowerPoint.Shape;'
@@ -337,11 +337,11 @@ properties:
shape type isn't `placeholder`, then this method returns the
`GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly placeholderFormat: PowerPoint.PlaceholderFormat;'
@@ -551,11 +551,11 @@ properties:
slide also has a unique z-order stack, so two shapes on separate slides
could have the same z-order number.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly zOrderPosition: number;'
@@ -745,11 +745,11 @@ methods:
fullName: getTable()
summary: Returns the `Table` object if this shape is a table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getTable(): PowerPoint.Table;'
@@ -842,11 +842,11 @@ methods:
Moves the specified shape up or down the collection's z-order, which
shifts it in front of or behind other shapes.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'setZOrder(position: PowerPoint.ShapeZOrder): void;'
@@ -867,11 +867,11 @@ methods:
Moves the specified shape up or down the collection's z-order, which
shifts it in front of or behind other shapes.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapecollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapecollection.yml
index 4a8e1029c4..21a8479471 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapecollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapecollection.yml
@@ -277,11 +277,11 @@ methods:
fullName: addGroup(values)
summary: Create a shape group for several shapes.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'addGroup(values: Array): PowerPoint.Shape;'
@@ -409,11 +409,11 @@ methods:
new table. Use the `Shape.table` property to get the `Table` object for
the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefill.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefill.yml
index e925f22504..0117f8b95c 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefill.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefill.yml
@@ -292,11 +292,11 @@ methods:
Sets the fill formatting of the shape to an image. This changes the fill
type to `PictureAndTexture`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'setImage(base64EncodedImage: string): void;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefont.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefont.yml
index ee59c2bf16..36c0718b5c 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefont.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapefont.yml
@@ -54,11 +54,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**All Caps** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'allCaps: boolean | null;'
@@ -165,11 +165,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Double strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'doubleStrikethrough: boolean | null;'
@@ -260,11 +260,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Small Caps** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'smallCaps: boolean | null;'
@@ -289,11 +289,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Strikethrough** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'strikethrough: boolean | null;'
@@ -317,11 +317,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Subscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'subscript: boolean | null;'
@@ -345,11 +345,11 @@ properties:
- `null`: Returned if some, but not all, of the text has the
**Superscript** attribute.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'superscript: boolean | null;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegroup.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegroup.yml
index 8237892cbe..dd3b7091d4 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegroup.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegroup.yml
@@ -7,11 +7,11 @@ summary: >-
Represents a shape group inside a presentation. To get the corresponding Shape
object, use `ShapeGroup.shape`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -24,7 +24,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -36,11 +36,11 @@ properties:
fullName: id
summary: Gets the unique ID of the shape group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: string;'
@@ -52,11 +52,11 @@ properties:
fullName: shape
summary: Returns the `Shape` object associated with the group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly shape: PowerPoint.Shape;'
@@ -68,11 +68,11 @@ properties:
fullName: shapes
summary: Returns the collection of `Shape` objects in the group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly shapes: PowerPoint.ShapeScopedCollection;'
@@ -88,7 +88,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -113,7 +113,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.ShapeGroup;'
@@ -135,7 +135,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -173,7 +173,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.ShapeGroupData;'
@@ -188,11 +188,11 @@ methods:
fullName: ungroup()
summary: Ungroups any grouped shapes in the specified shape group.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'ungroup(): void;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapescopedcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapescopedcollection.yml
index b75b3f4135..494fb29952 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapescopedcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapescopedcollection.yml
@@ -202,11 +202,11 @@ methods:
collection contains fewer than two shapes, then this method returns the
`GeneralException` error.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'group(): PowerPoint.Shape;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapezorder.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapezorder.yml
index da21a89266..b159f78a6f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapezorder.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapezorder.yml
@@ -7,11 +7,11 @@ summary: >-
Use with `setZOrder` to move the specified shape up or down the collection's
z-order, which shifts it in front of or behind other shapes.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: bringForward
@@ -21,8 +21,8 @@ fields:
Brings the shape forward one spot in the z-order.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"BringForward"'
- name: bringToFront
@@ -32,8 +32,8 @@ fields:
Brings the shape to the front of the z-order.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"BringToFront"'
- name: sendBackward
@@ -43,8 +43,8 @@ fields:
Sends the shape backward one spot in the z-order.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SendBackward"'
- name: sendToBack
@@ -54,7 +54,7 @@ fields:
Sends the shape to the back of the z-order.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SendToBack"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml
index daeb521aa2..10c8471b41 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml
@@ -105,11 +105,11 @@ properties:
Returns the zero-based index of the slide representing its position in the
presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly index: number;'
@@ -188,11 +188,11 @@ methods:
Applies the specified layout to the slide, changing its design and
structure according to the chosen layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'applyLayout(slideLayout: PowerPoint.SlideLayout): void;'
@@ -258,11 +258,11 @@ methods:
Exports the slide to its own presentation file, returned as Base64-encoded
data.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'exportAsBase64(): OfficeExtension.ClientResult;'
@@ -279,11 +279,11 @@ methods:
slide is used. If only one of either width or height is specified, the
other will be calculated to preserve aspect ratio.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -295,7 +295,7 @@ methods:
type:
return:
type: <string>
- description: A base64 string of the slide image in PNG format.
+ description: A Base64 string of the slide image in PNG format.
- name: load(options)
uid: powerpoint!PowerPoint.Slide#load:member(1)
package: powerpoint!
@@ -380,11 +380,11 @@ methods:
fullName: moveTo(slideIndex)
summary: Moves the slide to a new position within the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'moveTo(slideIndex: number): void;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml
index 54abc606b5..a473d8a899 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.SlideGetImageOptions
summary: Represents the available options when getting an image of a slide.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -19,11 +19,11 @@ properties:
fullName: height
summary: The desired height of the resulting image in pixels.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'height?: number;'
@@ -35,11 +35,11 @@ properties:
fullName: width
summary: The desired width of the resulting image in pixels.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'width?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayout.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayout.yml
index adc5687ab6..6f60caeca7 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayout.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayout.yml
@@ -158,11 +158,11 @@ properties:
fullName: type
summary: Returns the type of the slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayouttype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayouttype.yml
index c044c9f147..88169ff1ff 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayouttype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayouttype.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.SlideLayoutType
summary: Specifies the type of a slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: blank
@@ -19,8 +19,8 @@ fields:
Blank layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Blank"'
- name: chart
@@ -30,8 +30,8 @@ fields:
Chart layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Chart"'
- name: chartAndText
@@ -41,8 +41,8 @@ fields:
Chart and text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ChartAndText"'
- name: clipArtAndText
@@ -52,8 +52,8 @@ fields:
ClipArt and text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ClipArtAndText"'
- name: clipArtAndVerticalText
@@ -63,8 +63,8 @@ fields:
ClipArt and vertical text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ClipArtAndVerticalText"'
- name: comparison
@@ -74,8 +74,8 @@ fields:
Comparison layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Comparison"'
- name: contentWithCaption
@@ -85,8 +85,8 @@ fields:
Content with caption layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ContentWithCaption"'
- name: custom
@@ -96,8 +96,8 @@ fields:
Custom layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Custom"'
- name: fourObjects
@@ -107,8 +107,8 @@ fields:
Four objects layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"FourObjects"'
- name: largeObject
@@ -118,8 +118,8 @@ fields:
Large object layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LargeObject"'
- name: mediaClipAndText
@@ -129,8 +129,8 @@ fields:
MediaClip and text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"MediaClipAndText"'
- name: mixed
@@ -140,8 +140,8 @@ fields:
Mixed layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Mixed"'
- name: object
@@ -151,8 +151,8 @@ fields:
Object layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Object"'
- name: objectAndText
@@ -162,8 +162,8 @@ fields:
Object and text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ObjectAndText"'
- name: objectAndTwoObjects
@@ -173,8 +173,8 @@ fields:
Object and two objects layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ObjectAndTwoObjects"'
- name: objectOverText
@@ -184,8 +184,8 @@ fields:
Object over text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ObjectOverText"'
- name: organizationChart
@@ -195,8 +195,8 @@ fields:
Organization chart layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"OrganizationChart"'
- name: pictureWithCaption
@@ -206,8 +206,8 @@ fields:
Picture with caption layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"PictureWithCaption"'
- name: sectionHeader
@@ -217,8 +217,8 @@ fields:
Section header layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SectionHeader"'
- name: table
@@ -228,8 +228,8 @@ fields:
Table layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Table"'
- name: text
@@ -239,8 +239,8 @@ fields:
Text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Text"'
- name: textAndChart
@@ -250,8 +250,8 @@ fields:
Text and chart layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TextAndChart"'
- name: textAndClipArt
@@ -261,8 +261,8 @@ fields:
Text and ClipArt layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TextAndClipArt"'
- name: textAndMediaClip
@@ -272,8 +272,8 @@ fields:
Text and MediaClip layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TextAndMediaClip"'
- name: textAndObject
@@ -283,8 +283,8 @@ fields:
Text and object layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TextAndObject"'
- name: textAndTwoObjects
@@ -294,8 +294,8 @@ fields:
Text and two objects layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TextAndTwoObjects"'
- name: textOverObject
@@ -305,8 +305,8 @@ fields:
Text over object layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TextOverObject"'
- name: title
@@ -316,8 +316,8 @@ fields:
Title layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Title"'
- name: titleOnly
@@ -327,8 +327,8 @@ fields:
Title only layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TitleOnly"'
- name: twoColumnText
@@ -338,8 +338,8 @@ fields:
Two-column text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TwoColumnText"'
- name: twoObjects
@@ -349,8 +349,8 @@ fields:
Two objects layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TwoObjects"'
- name: twoObjectsAndObject
@@ -360,8 +360,8 @@ fields:
Two objects and object layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TwoObjectsAndObject"'
- name: twoObjectsAndText
@@ -371,8 +371,8 @@ fields:
Two objects and text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TwoObjectsAndText"'
- name: twoObjectsOverText
@@ -382,8 +382,8 @@ fields:
Two objects over text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TwoObjectsOverText"'
- name: verticalText
@@ -393,8 +393,8 @@ fields:
Vertical text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"VerticalText"'
- name: verticalTitleAndText
@@ -404,8 +404,8 @@ fields:
Vertical title and text layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"VerticalTitleAndText"'
- name: verticalTitleAndTextOverChart
@@ -415,7 +415,7 @@ fields:
Vertical title and text over chart layout.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"VerticalTitleAndTextOverChart"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemastercollection.yml
index 9e9d270bdd..0b7af1f7ff 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemastercollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemastercollection.yml
@@ -144,7 +144,7 @@ methods:
exist, an object with an `isNullObject` property set to true is returned.
For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)."
+ -->.
remarks: >-
\[ [API set: PowerPointApi
1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.table.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.table.yml
index 27a12499be..9569038a47 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.table.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.table.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Table
summary: Represents a table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -19,11 +19,11 @@ properties:
fullName: columnCount
summary: Gets the number of columns in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly columnCount: number;'
@@ -38,7 +38,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -50,11 +50,11 @@ properties:
fullName: rowCount
summary: Gets the number of rows in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly rowCount: number;'
@@ -66,11 +66,11 @@ properties:
fullName: values
summary: Gets all of the values in the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly values: string[][];'
@@ -83,11 +83,11 @@ methods:
fullName: getCellOrNullObject(rowIndex, columnIndex)
summary: Gets the cell at the specified `rowIndex` and `columnIndex`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -112,11 +112,11 @@ methods:
fullName: getMergedAreas()
summary: Gets a collection of cells that represent the merged areas of the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getMergedAreas(): PowerPoint.TableCellCollection;'
@@ -131,11 +131,11 @@ methods:
fullName: getShape()
summary: Gets the shape object for the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getShape(): PowerPoint.Shape;'
@@ -151,7 +151,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -175,7 +175,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.Table;'
@@ -197,7 +197,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -234,7 +234,7 @@ methods:
shallow copies of any loaded child properties from the original object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.TableData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tableaddoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tableaddoptions.yml
index f5055c9d56..f72f369e5d 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tableaddoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tableaddoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableAddOptions
summary: Represents the available options when adding a table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -22,11 +22,11 @@ properties:
length must be equal to the number of columns in the table. Specify an
empty object for columns that should use the default formatting.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columns?: PowerPoint.TableColumnProperties[];'
@@ -41,11 +41,11 @@ properties:
when this parameter is not provided. Throws an `InvalidArgument` exception
when set with a negative value.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'height?: number | undefined;'
@@ -60,11 +60,11 @@ properties:
left side of the slide. The table is centered horizontally when this
parameter is not provided.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'left?: number | undefined;'
@@ -78,11 +78,11 @@ properties:
If specified, represents an rectangular area where multiple cells appear
as a single cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'mergedAreas?: PowerPoint.TableMergedAreaProperties[];'
@@ -99,11 +99,11 @@ properties:
length must be equal to the number of rows in the table. Specify an empty
object for rows that should use the default formatting.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rows?: PowerPoint.TableRowProperties[];'
@@ -123,11 +123,11 @@ properties:
properties specified, which will be applied to the entire merged area. For
the other cells in the merged area, an empty object should be provided.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'specificCellProperties?: PowerPoint.TableCellProperties[][];'
@@ -142,11 +142,11 @@ properties:
top edge of the slide. A default value is used when this parameter is not
provided.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'top?: number | undefined;'
@@ -174,11 +174,11 @@ properties:
To provide a plain appearance for the table, set this property to an empty
object and do not specify specificCellProperties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'uniformCellProperties?: PowerPoint.TableCellProperties;'
@@ -196,11 +196,11 @@ properties:
each merged area can have a non-empty string value. The other cells in the
merged area must be an empty string.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'values?: string[][];'
@@ -215,11 +215,11 @@ properties:
this parameter is not provided. Throws an `InvalidArgument` exception when
set with a negative value.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'width?: number | undefined;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecell.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecell.yml
index 1e58a6dce5..7d3035cd64 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecell.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecell.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableCell
summary: Represents a table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -21,11 +21,11 @@ properties:
Gets the number of table columns this cell spans across. Will be greater
than or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly columnCount: number;'
@@ -37,11 +37,11 @@ properties:
fullName: columnIndex
summary: Gets the zero-based column index of the cell within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly columnIndex: number;'
@@ -56,7 +56,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -70,11 +70,11 @@ properties:
Gets the number of table rows this cell spans across. Will be greater than
or equal to 1.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly rowCount: number;'
@@ -86,11 +86,11 @@ properties:
fullName: rowIndex
summary: Gets the zero-based row index of the cell within the table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly rowIndex: number;'
@@ -102,11 +102,11 @@ properties:
fullName: text
summary: Specifies the text content of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'text: string;'
@@ -122,7 +122,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -147,7 +147,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.TableCell;'
@@ -169,7 +169,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -207,7 +207,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.TableCellData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellborders.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellborders.yml
index 1ca9b6a6be..595fa52a23 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellborders.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellborders.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableCellBorders
summary: Represents the borders of a table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -19,11 +19,11 @@ properties:
fullName: bottom
summary: Represents the bottom border.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'bottom?: PowerPoint.BorderProperties;'
@@ -35,11 +35,11 @@ properties:
fullName: diagonalDown
summary: Represents the diagonal border (top-left to bottom-right).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'diagonalDown?: PowerPoint.BorderProperties;'
@@ -51,11 +51,11 @@ properties:
fullName: diagonalUp
summary: Represents the diagonal border (bottom-left to top-right).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'diagonalUp?: PowerPoint.BorderProperties;'
@@ -67,11 +67,11 @@ properties:
fullName: left
summary: Represents the left border.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'left?: PowerPoint.BorderProperties;'
@@ -83,11 +83,11 @@ properties:
fullName: right
summary: Represents the right border.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'right?: PowerPoint.BorderProperties;'
@@ -99,11 +99,11 @@ properties:
fullName: top
summary: Represents the top border.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'top?: PowerPoint.BorderProperties;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellcollection.yml
index a255708185..e8c75af482 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellcollection.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableCellCollection
summary: Represents a collection of table cells.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -22,7 +22,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -35,7 +35,7 @@ properties:
summary: Gets the loaded child items in this collection.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly items: PowerPoint.TableCell[];'
@@ -48,11 +48,11 @@ methods:
fullName: getCount()
summary: Gets the number of table cells in the collection.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getCount(): OfficeExtension.ClientResult;'
@@ -69,11 +69,11 @@ methods:
`isNullObject` property set to `true`. For further information,
see .
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -102,7 +102,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -130,7 +130,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.TableCellCollection;'
@@ -152,7 +152,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -185,7 +185,7 @@ methods:
collection's items.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.TableCellCollectionData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellmargins.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellmargins.yml
index a36fcae4e5..c8181d43c9 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellmargins.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellmargins.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableCellMargins
summary: Represents the margins of a table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -19,11 +19,11 @@ properties:
fullName: bottom
summary: Specifies the bottom margin in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'bottom?: number | undefined;'
@@ -35,11 +35,11 @@ properties:
fullName: left
summary: Specifies the left margin in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'left?: number | undefined;'
@@ -51,11 +51,11 @@ properties:
fullName: right
summary: Specifies the right margin in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'right?: number | undefined;'
@@ -67,11 +67,11 @@ properties:
fullName: top
summary: Specifies the top margin in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'top?: number | undefined;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellproperties.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellproperties.yml
index 3249a6419c..f6aadb8ee8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellproperties.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecellproperties.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableCellProperties
summary: Represents the table cell properties to update.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -19,11 +19,11 @@ properties:
fullName: borders
summary: Specifies the border formatting of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'borders?: PowerPoint.TableCellBorders;'
@@ -35,11 +35,11 @@ properties:
fullName: fill
summary: Specifies the fill formatting of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'fill?: PowerPoint.FillProperties;'
@@ -51,11 +51,11 @@ properties:
fullName: font
summary: Specifies the font formatting of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'font?: PowerPoint.FontProperties;'
@@ -67,11 +67,11 @@ properties:
fullName: horizontalAlignment
summary: Represents the horizontal alignment of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -89,11 +89,11 @@ properties:
fullName: indentLevel
summary: Represents the indent level of the text in the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'indentLevel?: number | undefined;'
@@ -105,11 +105,11 @@ properties:
fullName: margins
summary: Specifies the margin settings in the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'margins?: PowerPoint.TableCellMargins;'
@@ -126,11 +126,11 @@ properties:
If a portion of the text requires different formatting, use the `textRuns`
property instead.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'text?: string;'
@@ -145,11 +145,11 @@ properties:
`TextRun` object represents a sequence of one or more characters that
share the same font attributes.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'textRuns?: PowerPoint.TextRun[];'
@@ -161,11 +161,11 @@ properties:
fullName: verticalAlignment
summary: Represents the vertical alignment of the table cell.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecolumnproperties.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecolumnproperties.yml
index 312b95a8dc..c400c2cbe8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecolumnproperties.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablecolumnproperties.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableColumnProperties
summary: Provides the table column properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -26,11 +26,11 @@ properties:
the table amongst those columns. If the table does not have a defined
width, a default column width will be used.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnWidth?: number | undefined;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablemergedareaproperties.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablemergedareaproperties.yml
index 2ecd36b52d..e724763572 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablemergedareaproperties.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablemergedareaproperties.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableMergedAreaProperties
summary: Represents the properties of a merged area of cells in a table.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -21,11 +21,11 @@ properties:
Specifies the number of columns for the merged cells area. Must be 1 or
greater.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnCount: number;'
@@ -39,11 +39,11 @@ properties:
Specifies the zero-based index of the column of the top left cell of the
merged area.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'columnIndex: number;'
@@ -57,11 +57,11 @@ properties:
Specifies the number of rows for the merged cells area. Must be 1 or
greater.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowCount: number;'
@@ -75,11 +75,11 @@ properties:
Specifies the zero-based index of the row of the top left cell of the
merged area.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowIndex: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablerowproperties.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablerowproperties.yml
index 2f6a918ded..3099aee473 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablerowproperties.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tablerowproperties.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TableRowProperties
summary: Provides the table row properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -26,11 +26,11 @@ properties:
table amongst those rows. If the table does not have a defined height, a
default row height will be used.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rowHeight?: number | undefined;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrun.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrun.yml
index 1c554bc1a6..e65959e5a0 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrun.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrun.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.TextRun
summary: Represents a sequence of one or more characters with the same font attributes.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -21,11 +21,11 @@ properties:
The font attributes (such as font name, font size, and color) applied to
this text run.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'font?: PowerPoint.FontProperties;'
@@ -37,11 +37,11 @@ properties:
fullName: text
summary: The text of this text run.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'text: string;'
diff --git a/docs/docs-ref-autogen/powerpoint/toc.yml b/docs/docs-ref-autogen/powerpoint/toc.yml
index 758a0d1b22..4c4eb1c196 100644
--- a/docs/docs-ref-autogen/powerpoint/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint/toc.yml
@@ -973,6 +973,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint.yml
index 03ae5def61..1b2b31b0f7 100644
--- a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint.yml
@@ -10,6 +10,9 @@ classes:
enums:
- powerpoint!PowerPoint.ErrorCodes:enum
interfaces:
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.CollectionLoadOptions:interface
@@ -32,6 +35,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
- powerpoint!PowerPoint.Interfaces.PresentationData:interface
- powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
@@ -41,6 +45,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeFillUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
@@ -57,6 +62,11 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.SlideMasterData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.TagData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..67d07e5918
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7570a966cb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..123a06e464
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..d63a5bd8ca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..6f9d0a883a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..1a3240cc26
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,11 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml
index b2135df851..13194971fc 100644
--- a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml
@@ -841,6 +841,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml
index b4815e9476..c795157d86 100644
--- a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml
@@ -14,6 +14,9 @@ enums:
- powerpoint!PowerPoint.InsertSlideFormatting:enum
interfaces:
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.CollectionLoadOptions:interface
@@ -36,6 +39,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
- powerpoint!PowerPoint.Interfaces.PresentationData:interface
- powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
@@ -45,6 +49,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeFillUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
@@ -63,6 +68,11 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.SlideMasterData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.TagData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..67d07e5918
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7570a966cb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..123a06e464
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..d63a5bd8ca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..6f9d0a883a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..1a3240cc26
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,11 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml
index d707c62a1c..8abab6a76b 100644
--- a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml
@@ -849,6 +849,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint.yml
index a672a93e0e..64cd922239 100644
--- a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint.yml
@@ -6,6 +6,9 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.CollectionLoadOptions:interface
@@ -28,6 +31,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
- powerpoint!PowerPoint.Interfaces.PresentationData:interface
- powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
@@ -38,6 +42,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeFillUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLoadOptions:interface
@@ -61,6 +66,11 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..67d07e5918
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7570a966cb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..123a06e464
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..d63a5bd8ca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..6f9d0a883a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..1a3240cc26
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,11 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.slidemastercollection.yml
index 9e9d270bdd..0b7af1f7ff 100644
--- a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.slidemastercollection.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.slidemastercollection.yml
@@ -144,7 +144,7 @@ methods:
exist, an object with an `isNullObject` property set to true is returned.
For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)."
+ -->.
remarks: >-
\[ [API set: PowerPointApi
1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml
index 9fd43b11c8..dfaf4086a8 100644
--- a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml
@@ -867,6 +867,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint.yml
index 8008613b25..bbabd2f581 100644
--- a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint.yml
@@ -6,6 +6,9 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
@@ -30,6 +33,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
- powerpoint!PowerPoint.Interfaces.PresentationData:interface
- powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
@@ -42,6 +46,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
@@ -66,6 +71,11 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..67d07e5918
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7570a966cb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..123a06e464
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..d63a5bd8ca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..6f9d0a883a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..1a3240cc26
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,11 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.slidemastercollection.yml
index 9e9d270bdd..0b7af1f7ff 100644
--- a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.slidemastercollection.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.slidemastercollection.yml
@@ -144,7 +144,7 @@ methods:
exist, an object with an `isNullObject` property set to true is returned.
For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)."
+ -->.
remarks: >-
\[ [API set: PowerPointApi
1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml
index 4db3f9a0f9..8415a44991 100644
--- a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml
@@ -903,6 +903,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint.yml
index 4ec69ee925..16a6cc794a 100644
--- a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint.yml
@@ -6,6 +6,9 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
@@ -30,6 +33,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
- powerpoint!PowerPoint.Interfaces.PresentationData:interface
- powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
@@ -42,6 +46,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
@@ -68,6 +73,11 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..67d07e5918
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7570a966cb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..123a06e464
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..d63a5bd8ca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..6f9d0a883a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..1a3240cc26
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,11 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.slidemastercollection.yml
index 9e9d270bdd..0b7af1f7ff 100644
--- a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.slidemastercollection.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.slidemastercollection.yml
@@ -144,7 +144,7 @@ methods:
exist, an object with an `isNullObject` property set to true is returned.
For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)."
+ -->.
remarks: >-
\[ [API set: PowerPointApi
1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml
index d67daadb70..3c31c51e04 100644
--- a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml
@@ -907,6 +907,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint.yml
index 9fdb0ac2d1..ebfa951a2b 100644
--- a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint.yml
@@ -6,6 +6,9 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
@@ -32,6 +35,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
- powerpoint!PowerPoint.Interfaces.PresentationData:interface
- powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
@@ -44,6 +48,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
@@ -70,6 +75,11 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..67d07e5918
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7570a966cb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..123a06e464
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..d63a5bd8ca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..6f9d0a883a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..1a3240cc26
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,11 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.slidemastercollection.yml
index 9e9d270bdd..0b7af1f7ff 100644
--- a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.slidemastercollection.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.slidemastercollection.yml
@@ -144,7 +144,7 @@ methods:
exist, an object with an `isNullObject` property set to true is returned.
For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)."
+ -->.
remarks: >-
\[ [API set: PowerPointApi
1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml
index 583ff9e042..a493328667 100644
--- a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml
@@ -911,6 +911,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint.yml
index ae5dcbbe71..e5b5c186e7 100644
--- a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint.yml
@@ -6,6 +6,9 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
@@ -41,6 +44,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
- powerpoint!PowerPoint.Interfaces.PresentationData:interface
- powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
@@ -53,6 +57,7 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
@@ -79,6 +84,11 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..67d07e5918
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7570a966cb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..123a06e464
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..d63a5bd8ca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..6f9d0a883a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..1a3240cc26
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,11 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.slidemastercollection.yml
index 9e9d270bdd..0b7af1f7ff 100644
--- a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.slidemastercollection.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.slidemastercollection.yml
@@ -144,7 +144,7 @@ methods:
exist, an object with an `isNullObject` property set to true is returned.
For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)."
+ -->.
remarks: >-
\[ [API set: PowerPointApi
1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml
index fe3702af7c..f4aaa4e6eb 100644
--- a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml
@@ -925,6 +925,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint.yml
new file mode 100644
index 0000000000..aa0f01bd8f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint.yml
@@ -0,0 +1,338 @@
+### YamlMime:TSPackage
+uid: powerpoint!
+name: powerpoint
+type: package
+summary: ''
+interfaces:
+ - powerpoint!PowerPoint.AddSlideOptions:interface
+ - powerpoint!PowerPoint.BorderProperties:interface
+ - powerpoint!PowerPoint.FillProperties:interface
+ - powerpoint!PowerPoint.FontProperties:interface
+ - powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingData:interface
+ - powerpoint!PowerPoint.Interfaces.BindingLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
+ - powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.CollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.CustomPropertyData:interface
+ - powerpoint!PowerPoint.Interfaces.CustomPropertyLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.CustomPropertyUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.CustomXmlPartData:interface
+ - powerpoint!PowerPoint.Interfaces.CustomXmlPartLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.DocumentPropertiesData:interface
+ - powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
+ - powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+ - powerpoint!PowerPoint.Interfaces.PlaceholderFormatLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.PresentationData:interface
+ - powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeFillData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeFillLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeGroupLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellData:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
+ - powerpoint!PowerPoint.Interfaces.TableLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TagData:interface
+ - powerpoint!PowerPoint.Interfaces.TagLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TagUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TextFrameData:interface
+ - powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TextFrameUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TextRangeData:interface
+ - powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TextRangeUpdateData:interface
+ - powerpoint!PowerPoint.ShapeAddOptions:interface
+ - powerpoint!PowerPoint.SlideGetImageOptions:interface
+ - powerpoint!PowerPoint.TableAddOptions:interface
+ - powerpoint!PowerPoint.TableCellBorders:interface
+ - powerpoint!PowerPoint.TableCellMargins:interface
+ - powerpoint!PowerPoint.TableCellProperties:interface
+ - powerpoint!PowerPoint.TableColumnProperties:interface
+ - powerpoint!PowerPoint.TableMergedAreaProperties:interface
+ - powerpoint!PowerPoint.TableRowProperties:interface
+ - powerpoint!PowerPoint.TextRun:interface
+classes:
+ - powerpoint!PowerPoint.Application:class
+ - powerpoint!PowerPoint.Binding:class
+ - powerpoint!PowerPoint.BindingCollection:class
+ - powerpoint!PowerPoint.BulletFormat:class
+ - powerpoint!PowerPoint.CustomProperty:class
+ - powerpoint!PowerPoint.CustomPropertyCollection:class
+ - powerpoint!PowerPoint.CustomXmlPart:class
+ - powerpoint!PowerPoint.CustomXmlPartCollection:class
+ - powerpoint!PowerPoint.CustomXmlPartScopedCollection:class
+ - powerpoint!PowerPoint.DocumentProperties:class
+ - powerpoint!PowerPoint.Hyperlink:class
+ - powerpoint!PowerPoint.HyperlinkCollection:class
+ - powerpoint!PowerPoint.ParagraphFormat:class
+ - powerpoint!PowerPoint.PlaceholderFormat:class
+ - powerpoint!PowerPoint.Presentation:class
+ - powerpoint!PowerPoint.RequestContext:class
+ - powerpoint!PowerPoint.Shape:class
+ - powerpoint!PowerPoint.ShapeCollection:class
+ - powerpoint!PowerPoint.ShapeFill:class
+ - powerpoint!PowerPoint.ShapeFont:class
+ - powerpoint!PowerPoint.ShapeGroup:class
+ - powerpoint!PowerPoint.ShapeLineFormat:class
+ - powerpoint!PowerPoint.ShapeScopedCollection:class
+ - powerpoint!PowerPoint.Slide:class
+ - powerpoint!PowerPoint.SlideCollection:class
+ - powerpoint!PowerPoint.SlideLayout:class
+ - powerpoint!PowerPoint.SlideLayoutCollection:class
+ - powerpoint!PowerPoint.SlideMaster:class
+ - powerpoint!PowerPoint.SlideMasterCollection:class
+ - powerpoint!PowerPoint.SlideScopedCollection:class
+ - powerpoint!PowerPoint.Table:class
+ - powerpoint!PowerPoint.TableCell:class
+ - powerpoint!PowerPoint.TableCellCollection:class
+ - powerpoint!PowerPoint.Tag:class
+ - powerpoint!PowerPoint.TagCollection:class
+ - powerpoint!PowerPoint.TextFrame:class
+ - powerpoint!PowerPoint.TextRange:class
+enums:
+ - powerpoint!PowerPoint.BindingType:enum
+ - powerpoint!PowerPoint.ConnectorType:enum
+ - powerpoint!PowerPoint.DocumentPropertyType:enum
+ - powerpoint!PowerPoint.ErrorCodes:enum
+ - powerpoint!PowerPoint.GeometricShapeType:enum
+ - powerpoint!PowerPoint.InsertSlideFormatting:enum
+ - powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum
+ - powerpoint!PowerPoint.PlaceholderType:enum
+ - powerpoint!PowerPoint.ShapeAutoSize:enum
+ - powerpoint!PowerPoint.ShapeFillType:enum
+ - powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum
+ - powerpoint!PowerPoint.ShapeLineDashStyle:enum
+ - powerpoint!PowerPoint.ShapeLineStyle:enum
+ - powerpoint!PowerPoint.ShapeType:enum
+ - powerpoint!PowerPoint.ShapeZOrder:enum
+ - powerpoint!PowerPoint.SlideLayoutType:enum
+ - powerpoint!PowerPoint.TextVerticalAlignment:enum
+functions:
+ - name: PowerPoint.createPresentation(base64File)
+ uid: powerpoint!PowerPoint.createPresentation:function(1)
+ package: powerpoint!
+ summary: >-
+ Creates and opens a new presentation. Optionally, the presentation can be
+ pre-populated with a Base64-encoded .pptx file.
+
+
+ \[ [API set: PowerPointApi
+ 1.1](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'export function createPresentation(base64File?: string): Promise;'
+ parameters:
+ - id: base64File
+ description: Optional. The Base64-encoded .pptx file. The default value is null.
+ type: string
+ return:
+ type: Promise<void>
+ description: >-
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ const myFile = document.getElementById("file");
+
+ const reader = new FileReader();
+
+
+ reader.onload = (event) => {
+ // Remove the metadata before the base64-encoded string.
+ const startIndex = reader.result.toString().indexOf("base64,");
+ const copyBase64 = reader.result.toString().substr(startIndex + 7);
+
+ PowerPoint.createPresentation(copyBase64);
+ };
+
+
+ // Read in the file as a data URL so we can parse the base64-encoded
+ string.
+
+ reader.readAsDataURL(myFile.files[0]);
+
+ ```
+ - name: PowerPoint.run(batch)
+ uid: powerpoint!PowerPoint.run:function(1)
+ package: powerpoint!
+ summary: >-
+ 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ export function run(batch: (context: PowerPoint.RequestContext) =>
+ OfficeExtension.IPromise): OfficeExtension.IPromise;
+ parameters:
+ - id: batch
+ description: >-
+ 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.
+ type: >-
+ (context: )
+ => <T>
+ return:
+ type: <T>
+ description: ''
+ - name: PowerPoint.run(object, batch)
+ uid: powerpoint!PowerPoint.run:function(2)
+ package: powerpoint!
+ summary: >-
+ 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ export function run(object: OfficeExtension.ClientObject, batch:
+ (context: PowerPoint.RequestContext) => OfficeExtension.IPromise):
+ OfficeExtension.IPromise;
+ parameters:
+ - id: object
+ description: >-
+ 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()".
+ type:
+ - id: batch
+ description: >-
+ 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.
+ type: >-
+ (context: )
+ => <T>
+ return:
+ type: <T>
+ description: ''
+ - name: PowerPoint.run(objects, batch)
+ uid: powerpoint!PowerPoint.run:function(3)
+ package: powerpoint!
+ summary: >-
+ Executes a batch script that performs actions on the PowerPoint object
+ model, using the RequestContext of previously-created API objects.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ export function run(objects: OfficeExtension.ClientObject[], batch:
+ (context: PowerPoint.RequestContext) => OfficeExtension.IPromise):
+ OfficeExtension.IPromise;
+ parameters:
+ - id: objects
+ description: >-
+ 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()".
+ type: []
+ - id: batch
+ description: >-
+ 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.
+ type: >-
+ (context: )
+ => <T>
+ return:
+ type: <T>
+ description: ''
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.addslideoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.addslideoptions.yml
new file mode 100644
index 0000000000..8d5c80bc2e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.addslideoptions.yml
@@ -0,0 +1,87 @@
+### YamlMime:TSType
+name: PowerPoint.AddSlideOptions
+uid: powerpoint!PowerPoint.AddSlideOptions:interface
+package: powerpoint!
+fullName: PowerPoint.AddSlideOptions
+summary: Represents the available options when adding a new slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ const chosenMaster = (document.getElementById("master-id") as
+ HTMLInputElement).value;
+
+ const chosenLayout = (document.getElementById("layout-id") as
+ HTMLInputElement).value;
+
+
+ await PowerPoint.run(async function(context) {
+ // Create a new slide using an existing master slide and layout.
+ const newSlideOptions: PowerPoint.AddSlideOptions = {
+ slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
+ layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
+ };
+ context.presentation.slides.add(newSlideOptions);
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: layoutId
+ uid: powerpoint!PowerPoint.AddSlideOptions#layoutId:member
+ package: powerpoint!
+ fullName: layoutId
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'layoutId?: string;'
+ return:
+ type: string
+ - name: slideMasterId
+ uid: powerpoint!PowerPoint.AddSlideOptions#slideMasterId:member
+ package: powerpoint!
+ fullName: slideMasterId
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideMasterId?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.application.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.application.yml
new file mode 100644
index 0000000000..14fbf3146d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.application.yml
@@ -0,0 +1,80 @@
+### YamlMime:TSType
+name: PowerPoint.Application
+uid: powerpoint!PowerPoint.Application:class
+package: powerpoint!
+fullName: PowerPoint.Application
+summary: ''
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.0](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.Application#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+methods:
+ - name: newObject(context)
+ uid: powerpoint!PowerPoint.Application.newObject:member(1)
+ package: powerpoint!
+ fullName: newObject(context)
+ summary: Create a new instance of the `PowerPoint.Application` object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ static newObject(context: OfficeExtension.ClientRequestContext):
+ PowerPoint.Application;
+ parameters:
+ - id: context
+ description: ''
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Application#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ toJSON(): {
+ [key: string]: string;
+ };
+ return:
+ type: |-
+ {
+ [key: string]: string;
+ }
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.binding.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.binding.yml
new file mode 100644
index 0000000000..22a59258f0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.binding.yml
@@ -0,0 +1,201 @@
+### YamlMime:TSType
+name: PowerPoint.Binding
+uid: powerpoint!PowerPoint.Binding:class
+package: powerpoint!
+fullName: PowerPoint.Binding
+summary: Represents an Office.js binding that is defined in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.Binding#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: id
+ uid: powerpoint!PowerPoint.Binding#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Represents the binding identifier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: type
+ uid: powerpoint!PowerPoint.Binding#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Returns the type of the binding. See `BindingType` for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly type: PowerPoint.BindingType | "Shape";'
+ return:
+ type: | "Shape"
+methods:
+ - name: delete()
+ uid: powerpoint!PowerPoint.Binding#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: Deletes the binding.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getShape()
+ uid: powerpoint!PowerPoint.Binding#getShape:member(1)
+ package: powerpoint!
+ fullName: getShape()
+ summary: >-
+ Returns the shape represented by the binding. Will throw an error if the
+ binding is not of the correct type.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShape(): PowerPoint.Shape;'
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Binding#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.BindingLoadOptions):
+ PowerPoint.Binding;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Binding#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.Binding;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.Binding#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Binding;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Binding#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original `PowerPoint.Binding`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.BindingData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.BindingData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bindingcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bindingcollection.yml
new file mode 100644
index 0000000000..318921f5ae
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bindingcollection.yml
@@ -0,0 +1,357 @@
+### YamlMime:TSType
+name: PowerPoint.BindingCollection
+uid: powerpoint!PowerPoint.BindingCollection:class
+package: powerpoint!
+fullName: PowerPoint.BindingCollection
+summary: >-
+ Represents the collection of all the binding objects that are part of the
+ presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.BindingCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.BindingCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.Binding[];'
+ return:
+ type: []
+methods:
+ - name: add(shape, bindingType, id)
+ uid: powerpoint!PowerPoint.BindingCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(shape, bindingType, id)
+ summary: >-
+ Adds a new binding to a particular Shape. If the provided ID is already
+ being used by a binding, the existing binding will be overwritten.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id:
+ string): PowerPoint.Binding;
+ parameters:
+ - id: shape
+ description: Shape to which the binding is added.
+ type:
+ - id: bindingType
+ description: Type of binding. See `BindingType`.
+ type:
+ - id: id
+ description: ID of the binding.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: add(shape, bindingTypeString, id)
+ uid: powerpoint!PowerPoint.BindingCollection#add:member(2)
+ package: powerpoint!
+ fullName: add(shape, bindingTypeString, id)
+ summary: >-
+ Adds a new binding to a particular Shape. If the provided ID is already
+ being used by a binding, the existing binding will be overwritten.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ add(shape: PowerPoint.Shape, bindingTypeString: "Shape", id: string):
+ PowerPoint.Binding;
+ parameters:
+ - id: shape
+ description: Shape to which the binding is added.
+ type:
+ - id: bindingTypeString
+ description: Type of binding. See `BindingType`.
+ type: '"Shape"'
+ - id: id
+ description: ID of the binding.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: addFromSelection(bindingType, id)
+ uid: powerpoint!PowerPoint.BindingCollection#addFromSelection:member(1)
+ package: powerpoint!
+ fullName: addFromSelection(bindingType, id)
+ summary: >-
+ Adds a new binding based on the current selection. If the selection has
+ multiple areas, the `InvalidReference` error will be returned.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addFromSelection(bindingType: PowerPoint.BindingType, id: string):
+ PowerPoint.Binding;
+ parameters:
+ - id: bindingType
+ description: Type of binding. See `BindingType`.
+ type:
+ - id: id
+ description: ID of the binding.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: addFromSelection(bindingTypeString, id)
+ uid: powerpoint!PowerPoint.BindingCollection#addFromSelection:member(2)
+ package: powerpoint!
+ fullName: addFromSelection(bindingTypeString, id)
+ summary: >-
+ Adds a new binding based on the current selection. If the selection has
+ multiple areas, the `InvalidReference` error will be returned.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addFromSelection(bindingTypeString: "Shape", id: string):
+ PowerPoint.Binding;
+ parameters:
+ - id: bindingTypeString
+ description: Type of binding. See `BindingType`.
+ type: '"Shape"'
+ - id: id
+ description: ID of the binding.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: getCount()
+ uid: powerpoint!PowerPoint.BindingCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of bindings in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: ''
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.BindingCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: >-
+ Gets a binding object by ID. Throws an ItemNotFoundException if there's no
+ binding with that ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.Binding;'
+ parameters:
+ - id: key
+ description: ID of the binding object to be retrieved.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.BindingCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ Gets a binding object based on its position in the items array. Throws an
+ InvalidArgumentException if the index less than 0, or greater than or
+ equal to the count of items in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.Binding;'
+ parameters:
+ - id: index
+ description: Index value of the object to be retrieved. Zero-indexed.
+ type: number
+ return:
+ type:
+ description: ''
+ - name: getItemOrNullObject(id)
+ uid: powerpoint!PowerPoint.BindingCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ Gets a binding object by ID. If the binding object doesn't exist, then
+ this method returns an object with its `isNullObject` property set to
+ `true`. For further information, see [*OrNullObject methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.Binding;'
+ parameters:
+ - id: id
+ description: ID of the binding object to be retrieved.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.BindingCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.BindingCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.BindingCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.BindingCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.BindingCollection;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.BindingCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.BindingCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.BindingCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.BindingCollection` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.BindingCollectionData`) that contains an
+ "items" array with shallow copies of any loaded properties from the
+ collection's items.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.BindingCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bindingtype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bindingtype.yml
new file mode 100644
index 0000000000..339cf901af
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bindingtype.yml
@@ -0,0 +1,25 @@
+### YamlMime:TSEnum
+name: PowerPoint.BindingType
+uid: powerpoint!PowerPoint.BindingType:enum
+package: powerpoint!
+fullName: PowerPoint.BindingType
+summary: Represents the possible binding types.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: shape
+ uid: powerpoint!PowerPoint.BindingType.shape:member
+ package: powerpoint!
+ summary: >-
+ Represents a shape binding.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Shape"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.borderproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.borderproperties.yml
new file mode 100644
index 0000000000..1609dcdc68
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.borderproperties.yml
@@ -0,0 +1,91 @@
+### YamlMime:TSType
+name: PowerPoint.BorderProperties
+uid: powerpoint!PowerPoint.BorderProperties:interface
+package: powerpoint!
+fullName: PowerPoint.BorderProperties
+summary: Represents the properties for a table cell border.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.BorderProperties#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Represents the line color in the hexadecimal format \#RRGGBB (e.g.,
+ "FFA500") or as a named HTML color value (e.g., "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string | undefined;'
+ return:
+ type: string | undefined
+ - name: dashStyle
+ uid: powerpoint!PowerPoint.BorderProperties#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: Represents the dash style of the line.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" |
+ "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" |
+ "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" |
+ "SystemDashDot" | undefined;
+ return:
+ type: >-
+ | "Dash"
+ | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" |
+ "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot"
+ | "SystemDashDot" | undefined
+ - name: transparency
+ uid: powerpoint!PowerPoint.BorderProperties#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ Specifies the transparency percentage of the line as a value from 0.0
+ (opaque) through 1.0 (clear).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: weight
+ uid: powerpoint!PowerPoint.BorderProperties#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: Represents the weight of the line, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'weight?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bulletformat.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bulletformat.yml
new file mode 100644
index 0000000000..ad5fd4b168
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.bulletformat.yml
@@ -0,0 +1,157 @@
+### YamlMime:TSType
+name: PowerPoint.BulletFormat
+uid: powerpoint!PowerPoint.BulletFormat:class
+package: powerpoint!
+fullName: PowerPoint.BulletFormat
+summary: >-
+ Represents the bullet formatting properties of a text that is attached to the
+ [PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.BulletFormat#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: visible
+ uid: powerpoint!PowerPoint.BulletFormat#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible: boolean;'
+ return:
+ type: boolean
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.BulletFormat#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions):
+ PowerPoint.BulletFormat;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.BulletFormat#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.BulletFormat;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.BulletFormat#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.BulletFormat;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.BulletFormat#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.BulletFormatData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.connectortype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.connectortype.yml
new file mode 100644
index 0000000000..d2acf1e37c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.connectortype.yml
@@ -0,0 +1,82 @@
+### YamlMime:TSEnum
+name: PowerPoint.ConnectorType
+uid: powerpoint!PowerPoint.ConnectorType:enum
+package: powerpoint!
+fullName: PowerPoint.ConnectorType
+summary: Specifies the connector type for line shapes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and adds a line to the collection, while specifying its
+
+ // start and end points. Then it names the shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+
+ // For a line, left and top are the coordinates of the start point,
+ // while height and width are the coordinates of the end point.
+ const line: PowerPoint.Shape = shapes.addLine(PowerPoint.ConnectorType.straight,
+ {
+ left: 400,
+ top: 200,
+ height: 20,
+ width: 150
+ });
+ line.name = "StraightLine";
+
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: curve
+ uid: powerpoint!PowerPoint.ConnectorType.curve:member
+ package: powerpoint!
+ summary: >-
+ Curve connector type
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Curve"'
+ - name: elbow
+ uid: powerpoint!PowerPoint.ConnectorType.elbow:member
+ package: powerpoint!
+ summary: >-
+ Elbow connector type
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Elbow"'
+ - name: straight
+ uid: powerpoint!PowerPoint.ConnectorType.straight:member
+ package: powerpoint!
+ summary: >-
+ Straight connector type
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Straight"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customproperty.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customproperty.yml
new file mode 100644
index 0000000000..1101e615dc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customproperty.yml
@@ -0,0 +1,207 @@
+### YamlMime:TSType
+name: PowerPoint.CustomProperty
+uid: powerpoint!PowerPoint.CustomProperty:class
+package: powerpoint!
+fullName: PowerPoint.CustomProperty
+summary: Represents a custom property.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.CustomProperty#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: key
+ uid: powerpoint!PowerPoint.CustomProperty#key:member
+ package: powerpoint!
+ fullName: key
+ summary: The string that uniquely identifies the custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly key: string;'
+ return:
+ type: string
+ - name: type
+ uid: powerpoint!PowerPoint.CustomProperty#type:member
+ package: powerpoint!
+ fullName: type
+ summary: The type of the value used for the custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" |
+ "Number" | "String";
+ return:
+ type: >-
+ |
+ "Boolean" | "Date" | "Number" | "String"
+ - name: value
+ uid: powerpoint!PowerPoint.CustomProperty#value:member
+ package: powerpoint!
+ fullName: value
+ summary: >-
+ The value of the custom property. If the value is a string, the maximum
+ length 255 characters. Larger strings cause the operation to fail with an
+ `InvalidArgument` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value: boolean | Date | number | string;'
+ return:
+ type: boolean | Date | number | string
+methods:
+ - name: delete()
+ uid: powerpoint!PowerPoint.CustomProperty#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: Deletes the custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.CustomProperty#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.CustomPropertyLoadOptions):
+ PowerPoint.CustomProperty;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.CustomProperty#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.CustomProperty;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.CustomProperty#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.CustomProperty;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.CustomProperty#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.CustomProperty` object is an API object, the `toJSON` method
+ returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow
+ copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.CustomPropertyData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.custompropertycollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.custompropertycollection.yml
new file mode 100644
index 0000000000..3de6653e78
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.custompropertycollection.yml
@@ -0,0 +1,271 @@
+### YamlMime:TSType
+name: PowerPoint.CustomPropertyCollection
+uid: powerpoint!PowerPoint.CustomPropertyCollection:class
+package: powerpoint!
+fullName: PowerPoint.CustomPropertyCollection
+summary: A collection of custom properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.CustomProperty[];'
+ return:
+ type: []
+methods:
+ - name: add(key, value)
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(key, value)
+ summary: Creates a new `CustomProperty` or updates the property with the given key.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ add(key: string, value: boolean | Date | number | string):
+ PowerPoint.CustomProperty;
+ parameters:
+ - id: key
+ description: >-
+ The string that identifies the `CustomProperty` object. It's
+ case-insensitive. The maximum key length is 255 characters. Larger
+ strings cause the operation to fail with an `InvalidArgument` error.
+ type: string
+ - id: value
+ description: >-
+ The value of the `CustomProperty`. If the value is a string,
+ the maximum length 255 characters. Larger strings cause the
+ operation to fail with an `InvalidArgument` error.
+ type: boolean | Date | number | string
+ return:
+ type:
+ description: ''
+ - name: deleteAll()
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#deleteAll:member(1)
+ package: powerpoint!
+ fullName: deleteAll()
+ summary: Deletes all custom properties in this collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'deleteAll(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getCount()
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of custom properties in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of custom properties in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: Gets a `CustomProperty` by its key.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.CustomProperty;'
+ parameters:
+ - id: key
+ description: >-
+ The string that identifies the `CustomProperty` object. It's
+ case-insensitive. Keys have a maximum length of 255 characters. If
+ the argument exceeds 255 characters, then this method returns the
+ `InvalidArgument` error.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: getItemOrNullObject(key)
+ uid: >-
+ powerpoint!PowerPoint.CustomPropertyCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(key)
+ summary: >-
+ Gets a `CustomProperty` by its key. If the `CustomProperty` doesn't exist,
+ then this method returns an object with its `isNullObject` property set to
+ `true`. For further information, see [*OrNullObject methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(key: string): PowerPoint.CustomProperty;'
+ parameters:
+ - id: key
+ description: >-
+ The string that identifies the `CustomProperty` object. It's
+ case-insensitive. Keys have a maximum length of 255 characters. If
+ the argument exceeds 255 characters, then this method returns the
+ `InvalidArgument` error.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions
+ & PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.CustomPropertyCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNames?: string | string[]):
+ PowerPoint.CustomPropertyCollection;
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.CustomPropertyCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.CustomPropertyCollection` object is an API object, the
+ `toJSON` method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.CustomPropertyCollectionData`) that
+ contains an "items" array with shallow copies of any loaded properties
+ from the collection's items.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpart.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpart.yml
new file mode 100644
index 0000000000..0fc0ba9bb3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpart.yml
@@ -0,0 +1,222 @@
+### YamlMime:TSType
+name: PowerPoint.CustomXmlPart
+uid: powerpoint!PowerPoint.CustomXmlPart:class
+package: powerpoint!
+fullName: PowerPoint.CustomXmlPart
+summary: Represents a custom XML part object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.CustomXmlPart#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: id
+ uid: powerpoint!PowerPoint.CustomXmlPart#id:member
+ package: powerpoint!
+ fullName: id
+ summary: The ID of the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: namespaceUri
+ uid: powerpoint!PowerPoint.CustomXmlPart#namespaceUri:member
+ package: powerpoint!
+ fullName: namespaceUri
+ summary: The namespace URI of the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly namespaceUri: string;'
+ return:
+ type: string
+methods:
+ - name: delete()
+ uid: powerpoint!PowerPoint.CustomXmlPart#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: Deletes the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getXml()
+ uid: powerpoint!PowerPoint.CustomXmlPart#getXml:member(1)
+ package: powerpoint!
+ fullName: getXml()
+ summary: Gets the XML content of the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getXml(): OfficeExtension.ClientResult;'
+ return:
+ type: <string>
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.CustomXmlPart#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.CustomXmlPartLoadOptions):
+ PowerPoint.CustomXmlPart;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.CustomXmlPart#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.CustomXmlPart#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.CustomXmlPart;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: setXml(xml)
+ uid: powerpoint!PowerPoint.CustomXmlPart#setXml:member(1)
+ package: powerpoint!
+ fullName: setXml(xml)
+ summary: Sets the XML content for the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setXml(xml: string): void;'
+ parameters:
+ - id: xml
+ description: XML content for the part.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.CustomXmlPart#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method
+ returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow
+ copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.CustomXmlPartData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpartcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpartcollection.yml
new file mode 100644
index 0000000000..af4c6b780c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpartcollection.yml
@@ -0,0 +1,267 @@
+### YamlMime:TSType
+name: PowerPoint.CustomXmlPartCollection
+uid: powerpoint!PowerPoint.CustomXmlPartCollection:class
+package: powerpoint!
+fullName: PowerPoint.CustomXmlPartCollection
+summary: A collection of custom XML parts.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.CustomXmlPart[];'
+ return:
+ type: []
+methods:
+ - name: add(xml)
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(xml)
+ summary: Adds a new `CustomXmlPart` to the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'add(xml: string): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: xml
+ description: >-
+ XML content. Must be a valid XML fragment. If the XML fragment is
+ invalid, then this method returns the `GeneralException` error.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: getByNamespace(namespaceUri)
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#getByNamespace:member(1)
+ package: powerpoint!
+ fullName: getByNamespace(namespaceUri)
+ summary: >-
+ Gets a new scoped collection of custom XML parts whose namespaces match
+ the given namespace.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getByNamespace(namespaceUri: string):
+ PowerPoint.CustomXmlPartScopedCollection;
+ parameters:
+ - id: namespaceUri
+ description: >-
+ This must be a fully qualified schema URI, such as
+ "http://schemas.contoso.com/review/1.0".
+ type: string
+ return:
+ type: >-
+
+ description: ''
+ - name: getCount()
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of custom XML parts in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of custom XML parts in the collection.
+ - name: getItem(id)
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(id)
+ summary: Gets a `CustomXmlPart` based on its ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(id: string): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: id
+ description: ID of the object to be retrieved.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: getItemOrNullObject(id)
+ uid: >-
+ powerpoint!PowerPoint.CustomXmlPartCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ Gets a `CustomXmlPart` based on its ID. If the `CustomXmlPart` doesn't
+ exist, then this method returns an object with its `isNullObject` property
+ set to `true`. For further information, see [*OrNullObject
+ methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: id
+ description: ID of the object to be retrieved.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions
+ & PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.CustomXmlPartCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNames?: string | string[]):
+ PowerPoint.CustomXmlPartCollection;
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.CustomXmlPartCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains
+ an "items" array with shallow copies of any loaded properties from the
+ collection's items.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpartscopedcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpartscopedcollection.yml
new file mode 100644
index 0000000000..340857684e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.customxmlpartscopedcollection.yml
@@ -0,0 +1,265 @@
+### YamlMime:TSType
+name: PowerPoint.CustomXmlPartScopedCollection
+uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection:class
+package: powerpoint!
+fullName: PowerPoint.CustomXmlPartScopedCollection
+summary: >-
+ A scoped collection of custom XML parts. A scoped collection is the result of
+ some operation (such as filtering by namespace). A scoped collection cannot be
+ scoped any further.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.CustomXmlPart[];'
+ return:
+ type: []
+methods:
+ - name: getCount()
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of custom XML parts in this collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of custom XML parts in the collection.
+ - name: getItem(id)
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(id)
+ summary: Gets a `CustomXmlPart` based on its ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(id: string): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: id
+ description: ID of the object to be retrieved.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: getItemOrNullObject(id)
+ uid: >-
+ powerpoint!PowerPoint.CustomXmlPartScopedCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ Gets a `CustomXmlPart` based on its ID. If the `CustomXmlPart` doesn't
+ exist, then this method returns an object with its `isNullObject` property
+ set to `true`. For further information, see [*OrNullObject
+ methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: id
+ description: ID of the object to be retrieved.
+ type: string
+ return:
+ type:
+ description: ''
+ - name: getOnlyItem()
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#getOnlyItem:member(1)
+ package: powerpoint!
+ fullName: getOnlyItem()
+ summary: >-
+ If the collection contains exactly one item, this method returns it. If
+ the collection contains no items or more than one item, then this method
+ returns the `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOnlyItem(): PowerPoint.CustomXmlPart;'
+ return:
+ type:
+ description: ''
+ - name: getOnlyItemOrNullObject()
+ uid: >-
+ powerpoint!PowerPoint.CustomXmlPartScopedCollection#getOnlyItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getOnlyItemOrNullObject()
+ summary: >-
+ If the collection contains exactly one item, this method returns it.
+ Otherwise, this method returns `null`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;'
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?:
+ PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.CustomXmlPartScopedCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type: >-
+
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNames?: string | string[]):
+ PowerPoint.CustomXmlPartScopedCollection;
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type: >-
+
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.CustomXmlPartScopedCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type: >-
+
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the
+ `toJSON` method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that
+ contains an "items" array with shallow copies of any loaded properties
+ from the collection's items.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.documentproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.documentproperties.yml
new file mode 100644
index 0000000000..f600fb1581
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.documentproperties.yml
@@ -0,0 +1,330 @@
+### YamlMime:TSType
+name: PowerPoint.DocumentProperties
+uid: powerpoint!PowerPoint.DocumentProperties:class
+package: powerpoint!
+fullName: PowerPoint.DocumentProperties
+summary: Represents presentation properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: author
+ uid: powerpoint!PowerPoint.DocumentProperties#author:member
+ package: powerpoint!
+ fullName: author
+ summary: The author of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'author: string;'
+ return:
+ type: string
+ - name: category
+ uid: powerpoint!PowerPoint.DocumentProperties#category:member
+ package: powerpoint!
+ fullName: category
+ summary: The category of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'category: string;'
+ return:
+ type: string
+ - name: comments
+ uid: powerpoint!PowerPoint.DocumentProperties#comments:member
+ package: powerpoint!
+ fullName: comments
+ summary: >-
+ The Comments field in the metadata of the presentation. These have no
+ connection to comments made in slides.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'comments: string;'
+ return:
+ type: string
+ - name: company
+ uid: powerpoint!PowerPoint.DocumentProperties#company:member
+ package: powerpoint!
+ fullName: company
+ summary: The company of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'company: string;'
+ return:
+ type: string
+ - name: context
+ uid: powerpoint!PowerPoint.DocumentProperties#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: creationDate
+ uid: powerpoint!PowerPoint.DocumentProperties#creationDate:member
+ package: powerpoint!
+ fullName: creationDate
+ summary: The creation date of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly creationDate: Date;'
+ return:
+ type: Date
+ - name: customProperties
+ uid: powerpoint!PowerPoint.DocumentProperties#customProperties:member
+ package: powerpoint!
+ fullName: customProperties
+ summary: The collection of custom properties of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly customProperties: PowerPoint.CustomPropertyCollection;'
+ return:
+ type:
+ - name: keywords
+ uid: powerpoint!PowerPoint.DocumentProperties#keywords:member
+ package: powerpoint!
+ fullName: keywords
+ summary: The keywords of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'keywords: string;'
+ return:
+ type: string
+ - name: lastAuthor
+ uid: powerpoint!PowerPoint.DocumentProperties#lastAuthor:member
+ package: powerpoint!
+ fullName: lastAuthor
+ summary: The last author of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly lastAuthor: string;'
+ return:
+ type: string
+ - name: manager
+ uid: powerpoint!PowerPoint.DocumentProperties#manager:member
+ package: powerpoint!
+ fullName: manager
+ summary: The manager of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'manager: string;'
+ return:
+ type: string
+ - name: revisionNumber
+ uid: powerpoint!PowerPoint.DocumentProperties#revisionNumber:member
+ package: powerpoint!
+ fullName: revisionNumber
+ summary: The revision number of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'revisionNumber: number;'
+ return:
+ type: number
+ - name: subject
+ uid: powerpoint!PowerPoint.DocumentProperties#subject:member
+ package: powerpoint!
+ fullName: subject
+ summary: The subject of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subject: string;'
+ return:
+ type: string
+ - name: title
+ uid: powerpoint!PowerPoint.DocumentProperties#title:member
+ package: powerpoint!
+ fullName: title
+ summary: The title of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title: string;'
+ return:
+ type: string
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.DocumentProperties#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions):
+ PowerPoint.DocumentProperties;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.DocumentProperties#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.DocumentProperties;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.DocumentProperties#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.DocumentProperties;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.DocumentProperties#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.DocumentProperties` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.DocumentPropertiesData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.DocumentPropertiesData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.documentpropertytype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.documentpropertytype.yml
new file mode 100644
index 0000000000..21c0e6c9a7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.documentpropertytype.yml
@@ -0,0 +1,58 @@
+### YamlMime:TSEnum
+name: PowerPoint.DocumentPropertyType
+uid: powerpoint!PowerPoint.DocumentPropertyType:enum
+package: powerpoint!
+fullName: PowerPoint.DocumentPropertyType
+summary: Specifies the document property type for custom properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: boolean
+ uid: powerpoint!PowerPoint.DocumentPropertyType.boolean:member
+ package: powerpoint!
+ summary: >-
+ The Boolean document property type.
+
+
+ * \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Boolean"'
+ - name: date
+ uid: powerpoint!PowerPoint.DocumentPropertyType.date:member
+ package: powerpoint!
+ summary: >-
+ The Date document property type.
+
+
+ * \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Date"'
+ - name: number
+ uid: powerpoint!PowerPoint.DocumentPropertyType.number:member
+ package: powerpoint!
+ summary: >-
+ The Number document property type.
+
+
+ * \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Number"'
+ - name: string
+ uid: powerpoint!PowerPoint.DocumentPropertyType.string:member
+ package: powerpoint!
+ summary: >-
+ The String document property type.
+
+
+ * \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"String"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.errorcodes.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.errorcodes.yml
new file mode 100644
index 0000000000..5a99a70369
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.errorcodes.yml
@@ -0,0 +1,16 @@
+### YamlMime:TSEnum
+name: PowerPoint.ErrorCodes
+uid: powerpoint!PowerPoint.ErrorCodes:enum
+package: powerpoint!
+fullName: PowerPoint.ErrorCodes
+summary: ''
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: generalException
+ uid: powerpoint!PowerPoint.ErrorCodes.generalException:member
+ package: powerpoint!
+ summary: ''
+ value: '"GeneralException"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.fillproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.fillproperties.yml
new file mode 100644
index 0000000000..1d29fbfc8b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.fillproperties.yml
@@ -0,0 +1,51 @@
+### YamlMime:TSType
+name: PowerPoint.FillProperties
+uid: powerpoint!PowerPoint.FillProperties:interface
+package: powerpoint!
+fullName: PowerPoint.FillProperties
+summary: Represents the fill formatting of a table cell.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.FillProperties#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Represents the shape fill color in the hexadecimal format \#RRGGBB (e.g.,
+ "FFA500") or as a named HTML color value (e.g., "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string | undefined;'
+ return:
+ type: string | undefined
+ - name: transparency
+ uid: powerpoint!PowerPoint.FillProperties#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ Specifies the transparency percentage of the fill as a value from 0.0
+ (opaque) through 1.0 (clear).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.fontproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.fontproperties.yml
new file mode 100644
index 0000000000..fcd80ca95e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.fontproperties.yml
@@ -0,0 +1,228 @@
+### YamlMime:TSType
+name: PowerPoint.FontProperties
+uid: powerpoint!PowerPoint.FontProperties:interface
+package: powerpoint!
+fullName: PowerPoint.FontProperties
+summary: Represents the font attributes, such as font name, size, and color.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: allCaps
+ uid: powerpoint!PowerPoint.FontProperties#allCaps:member
+ package: powerpoint!
+ fullName: allCaps
+ summary: >-
+ Represents whether the font uses all caps, where lowercase letters are
+ shown as capital letters.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allCaps?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: bold
+ uid: powerpoint!PowerPoint.FontProperties#bold:member
+ package: powerpoint!
+ fullName: bold
+ summary: Represents the bold status of font.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bold?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: color
+ uid: powerpoint!PowerPoint.FontProperties#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Represents the HTML color in the hexadecimal format (e.g., "\#FF0000"
+ represents red) or as a named HTML color value (e.g., "red").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string | undefined;'
+ return:
+ type: string | undefined
+ - name: doubleStrikethrough
+ uid: powerpoint!PowerPoint.FontProperties#doubleStrikethrough:member
+ package: powerpoint!
+ fullName: doubleStrikethrough
+ summary: Represents the double-strikethrough status of the font.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'doubleStrikethrough?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: italic
+ uid: powerpoint!PowerPoint.FontProperties#italic:member
+ package: powerpoint!
+ fullName: italic
+ summary: Represents the italic status of font.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'italic?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: name
+ uid: powerpoint!PowerPoint.FontProperties#name:member
+ package: powerpoint!
+ fullName: name
+ summary: >-
+ Represents the font name (e.g., "Calibri"). If the text is a Complex
+ Script or East Asian language, this is the corresponding font name;
+ otherwise it's the Latin font name.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: string | undefined;'
+ return:
+ type: string | undefined
+ - name: size
+ uid: powerpoint!PowerPoint.FontProperties#size:member
+ package: powerpoint!
+ fullName: size
+ summary: Represents the font size in points (e.g., 11).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'size?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: smallCaps
+ uid: powerpoint!PowerPoint.FontProperties#smallCaps:member
+ package: powerpoint!
+ fullName: smallCaps
+ summary: >-
+ Represents whether the text uses small caps, where lowercase letters are
+ shown as small capital letters.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'smallCaps?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: strikethrough
+ uid: powerpoint!PowerPoint.FontProperties#strikethrough:member
+ package: powerpoint!
+ fullName: strikethrough
+ summary: Represents the strikethrough status of the font.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'strikethrough?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: subscript
+ uid: powerpoint!PowerPoint.FontProperties#subscript:member
+ package: powerpoint!
+ fullName: subscript
+ summary: Represents the subscript status of the font.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subscript?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: superscript
+ uid: powerpoint!PowerPoint.FontProperties#superscript:member
+ package: powerpoint!
+ fullName: superscript
+ summary: Represents the superscript status of the font.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'superscript?: boolean | undefined;'
+ return:
+ type: boolean | undefined
+ - name: underline
+ uid: powerpoint!PowerPoint.FontProperties#underline:member
+ package: powerpoint!
+ fullName: underline
+ summary: >-
+ Type of underline applied to the font. See
+ [PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" |
+ "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" |
+ "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash"
+ | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;
+ return:
+ type: >-
+ |
+ "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" |
+ "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" |
+ "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" |
+ "WavyHeavy" | "WavyDouble" | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.geometricshapetype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.geometricshapetype.yml
new file mode 100644
index 0000000000..127e775e02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.geometricshapetype.yml
@@ -0,0 +1,1994 @@
+### YamlMime:TSEnum
+name: PowerPoint.GeometricShapeType
+uid: powerpoint!PowerPoint.GeometricShapeType:enum
+package: powerpoint!
+fullName: PowerPoint.GeometricShapeType
+summary: Specifies the shape type for a `GeometricShape` object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and adds a hexagon shape to the collection, while specifying its
+
+ // location and size. Then it names the shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ const shapeOptions: PowerPoint.ShapeAddOptions = {
+ left: 100,
+ top: 100,
+ height: 150,
+ width: 150
+ };
+ const hexagon: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.hexagon, shapeOptions);
+ hexagon.name = "Hexagon";
+
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: accentBorderCallout1
+ uid: powerpoint!PowerPoint.GeometricShapeType.accentBorderCallout1:member
+ package: powerpoint!
+ summary: >-
+ Callout: Line with Border and Accent Bar
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AccentBorderCallout1"'
+ - name: accentBorderCallout2
+ uid: powerpoint!PowerPoint.GeometricShapeType.accentBorderCallout2:member
+ package: powerpoint!
+ summary: >-
+ Callout: Bent Line with Border and Accent Bar
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AccentBorderCallout2"'
+ - name: accentBorderCallout3
+ uid: powerpoint!PowerPoint.GeometricShapeType.accentBorderCallout3:member
+ package: powerpoint!
+ summary: >-
+ Callout: Double Bent Line with Border and Accent Bar
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AccentBorderCallout3"'
+ - name: accentCallout1
+ uid: powerpoint!PowerPoint.GeometricShapeType.accentCallout1:member
+ package: powerpoint!
+ summary: >-
+ Callout: Line with Accent Bar
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AccentCallout1"'
+ - name: accentCallout2
+ uid: powerpoint!PowerPoint.GeometricShapeType.accentCallout2:member
+ package: powerpoint!
+ summary: >-
+ Callout: Bent Line with Accent Bar
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AccentCallout2"'
+ - name: accentCallout3
+ uid: powerpoint!PowerPoint.GeometricShapeType.accentCallout3:member
+ package: powerpoint!
+ summary: >-
+ Callout: Double Bent Line with Accent Bar
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AccentCallout3"'
+ - name: actionButtonBackPrevious
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonBackPrevious:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Go Back or Previous
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonBackPrevious"'
+ - name: actionButtonBeginning
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonBeginning:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Go to Beginning
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonBeginning"'
+ - name: actionButtonBlank
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonBlank:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Blank
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonBlank"'
+ - name: actionButtonDocument
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonDocument:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Document
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonDocument"'
+ - name: actionButtonEnd
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonEnd:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Go to End
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonEnd"'
+ - name: actionButtonForwardNext
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonForwardNext:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Go Forward or Next
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonForwardNext"'
+ - name: actionButtonHelp
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonHelp:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Help
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonHelp"'
+ - name: actionButtonHome
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonHome:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Go Home
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonHome"'
+ - name: actionButtonInformation
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonInformation:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Get Information
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonInformation"'
+ - name: actionButtonMovie
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonMovie:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Video
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonMovie"'
+ - name: actionButtonReturn
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonReturn:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Return
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonReturn"'
+ - name: actionButtonSound
+ uid: powerpoint!PowerPoint.GeometricShapeType.actionButtonSound:member
+ package: powerpoint!
+ summary: >-
+ Action Button: Sound
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ActionButtonSound"'
+ - name: arc
+ uid: powerpoint!PowerPoint.GeometricShapeType.arc:member
+ package: powerpoint!
+ summary: >-
+ Arc
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Arc"'
+ - name: bentArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.bentArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Bent
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BentArrow"'
+ - name: bentUpArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.bentUpArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Bent-Up
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BentUpArrow"'
+ - name: bevel
+ uid: powerpoint!PowerPoint.GeometricShapeType.bevel:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Beveled
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Bevel"'
+ - name: blockArc
+ uid: powerpoint!PowerPoint.GeometricShapeType.blockArc:member
+ package: powerpoint!
+ summary: >-
+ Block Arc
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BlockArc"'
+ - name: borderCallout1
+ uid: powerpoint!PowerPoint.GeometricShapeType.borderCallout1:member
+ package: powerpoint!
+ summary: >-
+ Callout: Line
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BorderCallout1"'
+ - name: borderCallout2
+ uid: powerpoint!PowerPoint.GeometricShapeType.borderCallout2:member
+ package: powerpoint!
+ summary: >-
+ Callout: Bent Line
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BorderCallout2"'
+ - name: borderCallout3
+ uid: powerpoint!PowerPoint.GeometricShapeType.borderCallout3:member
+ package: powerpoint!
+ summary: >-
+ Callout: Double Bent Line
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BorderCallout3"'
+ - name: bracePair
+ uid: powerpoint!PowerPoint.GeometricShapeType.bracePair:member
+ package: powerpoint!
+ summary: >-
+ Double Brace
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BracePair"'
+ - name: bracketPair
+ uid: powerpoint!PowerPoint.GeometricShapeType.bracketPair:member
+ package: powerpoint!
+ summary: >-
+ Double Bracket
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BracketPair"'
+ - name: callout1
+ uid: powerpoint!PowerPoint.GeometricShapeType.callout1:member
+ package: powerpoint!
+ summary: >-
+ Callout: Line with No Border
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Callout1"'
+ - name: callout2
+ uid: powerpoint!PowerPoint.GeometricShapeType.callout2:member
+ package: powerpoint!
+ summary: >-
+ Callout: Bent Line with No Border
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Callout2"'
+ - name: callout3
+ uid: powerpoint!PowerPoint.GeometricShapeType.callout3:member
+ package: powerpoint!
+ summary: >-
+ Callout: Double Bent Line with No Border
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Callout3"'
+ - name: can
+ uid: powerpoint!PowerPoint.GeometricShapeType.can:member
+ package: powerpoint!
+ summary: >-
+ Cylinder
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Can"'
+ - name: chartPlus
+ uid: powerpoint!PowerPoint.GeometricShapeType.chartPlus:member
+ package: powerpoint!
+ summary: >-
+ A Rectangle Divided Vertically and Horizontally into Four Quarters.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ChartPlus"'
+ - name: chartStar
+ uid: powerpoint!PowerPoint.GeometricShapeType.chartStar:member
+ package: powerpoint!
+ summary: >-
+ A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal
+ Lines.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ChartStar"'
+ - name: chartX
+ uid: powerpoint!PowerPoint.GeometricShapeType.chartX:member
+ package: powerpoint!
+ summary: >-
+ A Rectangle Divided into Four Parts Along Diagonal Lines.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ChartX"'
+ - name: chevron
+ uid: powerpoint!PowerPoint.GeometricShapeType.chevron:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Chevron
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Chevron"'
+ - name: chord
+ uid: powerpoint!PowerPoint.GeometricShapeType.chord:member
+ package: powerpoint!
+ summary: >-
+ Chord
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Chord"'
+ - name: circularArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.circularArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Circular
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CircularArrow"'
+ - name: cloud
+ uid: powerpoint!PowerPoint.GeometricShapeType.cloud:member
+ package: powerpoint!
+ summary: >-
+ Cloud
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Cloud"'
+ - name: cloudCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.cloudCallout:member
+ package: powerpoint!
+ summary: >-
+ Thought Bubble: Cloud
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CloudCallout"'
+ - name: corner
+ uid: powerpoint!PowerPoint.GeometricShapeType.corner:member
+ package: powerpoint!
+ summary: >-
+ L-Shape
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Corner"'
+ - name: cornerTabs
+ uid: powerpoint!PowerPoint.GeometricShapeType.cornerTabs:member
+ package: powerpoint!
+ summary: >-
+ Four Right Triangles that Define a Rectangular Shape
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CornerTabs"'
+ - name: cube
+ uid: powerpoint!PowerPoint.GeometricShapeType.cube:member
+ package: powerpoint!
+ summary: >-
+ Cube
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Cube"'
+ - name: curvedDownArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.curvedDownArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Curved Down
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CurvedDownArrow"'
+ - name: curvedLeftArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.curvedLeftArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Curved Left
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CurvedLeftArrow"'
+ - name: curvedRightArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.curvedRightArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Curved Right
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CurvedRightArrow"'
+ - name: curvedUpArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.curvedUpArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Curved Up
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CurvedUpArrow"'
+ - name: decagon
+ uid: powerpoint!PowerPoint.GeometricShapeType.decagon:member
+ package: powerpoint!
+ summary: >-
+ Decagon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Decagon"'
+ - name: diagonalStripe
+ uid: powerpoint!PowerPoint.GeometricShapeType.diagonalStripe:member
+ package: powerpoint!
+ summary: >-
+ Diagonal Stripe
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DiagonalStripe"'
+ - name: diamond
+ uid: powerpoint!PowerPoint.GeometricShapeType.diamond:member
+ package: powerpoint!
+ summary: >-
+ Diamond
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Diamond"'
+ - name: dodecagon
+ uid: powerpoint!PowerPoint.GeometricShapeType.dodecagon:member
+ package: powerpoint!
+ summary: >-
+ Dodecagon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Dodecagon"'
+ - name: donut
+ uid: powerpoint!PowerPoint.GeometricShapeType.donut:member
+ package: powerpoint!
+ summary: >-
+ Circle: Hollow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Donut"'
+ - name: doubleWave
+ uid: powerpoint!PowerPoint.GeometricShapeType.doubleWave:member
+ package: powerpoint!
+ summary: >-
+ Double Wave
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DoubleWave"'
+ - name: downArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.downArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Down
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DownArrow"'
+ - name: downArrowCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.downArrowCallout:member
+ package: powerpoint!
+ summary: >-
+ Callout: Down Arrow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DownArrowCallout"'
+ - name: ellipse
+ uid: powerpoint!PowerPoint.GeometricShapeType.ellipse:member
+ package: powerpoint!
+ summary: >-
+ Oval
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Ellipse"'
+ - name: ellipseRibbon
+ uid: powerpoint!PowerPoint.GeometricShapeType.ellipseRibbon:member
+ package: powerpoint!
+ summary: >-
+ Ribbon: Curved and Tilted Down
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"EllipseRibbon"'
+ - name: ellipseRibbon2
+ uid: powerpoint!PowerPoint.GeometricShapeType.ellipseRibbon2:member
+ package: powerpoint!
+ summary: >-
+ Ribbon: Curved and Tilted Up
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"EllipseRibbon2"'
+ - name: flowChartAlternateProcess
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartAlternateProcess:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Alternate Process
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartAlternateProcess"'
+ - name: flowChartCollate
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartCollate:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Collate
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartCollate"'
+ - name: flowChartConnector
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartConnector:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Connector
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartConnector"'
+ - name: flowChartDecision
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartDecision:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Decision
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartDecision"'
+ - name: flowChartDelay
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartDelay:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Delay
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartDelay"'
+ - name: flowChartDisplay
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartDisplay:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Display
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartDisplay"'
+ - name: flowChartDocument
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartDocument:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Document
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartDocument"'
+ - name: flowChartExtract
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartExtract:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Extract
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartExtract"'
+ - name: flowChartInputOutput
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartInputOutput:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Data
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartInputOutput"'
+ - name: flowChartInternalStorage
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartInternalStorage:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Internal Storage
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartInternalStorage"'
+ - name: flowChartMagneticDisk
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartMagneticDisk:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Magnetic Disk
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartMagneticDisk"'
+ - name: flowChartMagneticDrum
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartMagneticDrum:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Direct Access Storage
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartMagneticDrum"'
+ - name: flowChartMagneticTape
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartMagneticTape:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Sequential Access Storage
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartMagneticTape"'
+ - name: flowChartManualInput
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartManualInput:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Manual Input
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartManualInput"'
+ - name: flowChartManualOperation
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartManualOperation:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Manual Operation
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartManualOperation"'
+ - name: flowChartMerge
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartMerge:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Merge
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartMerge"'
+ - name: flowChartMultidocument
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartMultidocument:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Multidocument
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartMultidocument"'
+ - name: flowChartOfflineStorage
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartOfflineStorage:member
+ package: powerpoint!
+ summary: >-
+ FlowChart: Offline Storage
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartOfflineStorage"'
+ - name: flowChartOffpageConnector
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartOffpageConnector:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Off-page Connector
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartOffpageConnector"'
+ - name: flowChartOnlineStorage
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartOnlineStorage:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Stored Data
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartOnlineStorage"'
+ - name: flowChartOr
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartOr:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Or
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartOr"'
+ - name: flowChartPredefinedProcess
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartPredefinedProcess:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Predefined Process
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartPredefinedProcess"'
+ - name: flowChartPreparation
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartPreparation:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Preparation
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartPreparation"'
+ - name: flowChartProcess
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartProcess:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Process
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartProcess"'
+ - name: flowChartPunchedCard
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartPunchedCard:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Card
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartPunchedCard"'
+ - name: flowChartPunchedTape
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartPunchedTape:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Punched Tape
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartPunchedTape"'
+ - name: flowChartSort
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartSort:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Sort
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartSort"'
+ - name: flowChartSummingJunction
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartSummingJunction:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Summing Junction
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartSummingJunction"'
+ - name: flowChartTerminator
+ uid: powerpoint!PowerPoint.GeometricShapeType.flowChartTerminator:member
+ package: powerpoint!
+ summary: >-
+ Flowchart: Terminator
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FlowChartTerminator"'
+ - name: foldedCorner
+ uid: powerpoint!PowerPoint.GeometricShapeType.foldedCorner:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Folded Corner
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FoldedCorner"'
+ - name: frame
+ uid: powerpoint!PowerPoint.GeometricShapeType.frame:member
+ package: powerpoint!
+ summary: >-
+ Frame
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Frame"'
+ - name: funnel
+ uid: powerpoint!PowerPoint.GeometricShapeType.funnel:member
+ package: powerpoint!
+ summary: >-
+ Funnel
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Funnel"'
+ - name: gear6
+ uid: powerpoint!PowerPoint.GeometricShapeType.gear6:member
+ package: powerpoint!
+ summary: >-
+ Gear: A Gear with Six Teeth
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Gear6"'
+ - name: gear9
+ uid: powerpoint!PowerPoint.GeometricShapeType.gear9:member
+ package: powerpoint!
+ summary: >-
+ Gear: A Gear with Nine Teeth
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Gear9"'
+ - name: halfFrame
+ uid: powerpoint!PowerPoint.GeometricShapeType.halfFrame:member
+ package: powerpoint!
+ summary: >-
+ Half Frame
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HalfFrame"'
+ - name: heart
+ uid: powerpoint!PowerPoint.GeometricShapeType.heart:member
+ package: powerpoint!
+ summary: >-
+ Heart
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Heart"'
+ - name: heptagon
+ uid: powerpoint!PowerPoint.GeometricShapeType.heptagon:member
+ package: powerpoint!
+ summary: >-
+ Heptagon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Heptagon"'
+ - name: hexagon
+ uid: powerpoint!PowerPoint.GeometricShapeType.hexagon:member
+ package: powerpoint!
+ summary: >-
+ Hexagon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Hexagon"'
+ - name: homePlate
+ uid: powerpoint!PowerPoint.GeometricShapeType.homePlate:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Pentagon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HomePlate"'
+ - name: horizontalScroll
+ uid: powerpoint!PowerPoint.GeometricShapeType.horizontalScroll:member
+ package: powerpoint!
+ summary: >-
+ Scroll: Horizontal
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HorizontalScroll"'
+ - name: irregularSeal1
+ uid: powerpoint!PowerPoint.GeometricShapeType.irregularSeal1:member
+ package: powerpoint!
+ summary: >-
+ Explosion: 8 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"IrregularSeal1"'
+ - name: irregularSeal2
+ uid: powerpoint!PowerPoint.GeometricShapeType.irregularSeal2:member
+ package: powerpoint!
+ summary: >-
+ Explosion: 14 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"IrregularSeal2"'
+ - name: leftArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Left
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftArrow"'
+ - name: leftArrowCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftArrowCallout:member
+ package: powerpoint!
+ summary: >-
+ Callout: Left Arrow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftArrowCallout"'
+ - name: leftBrace
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftBrace:member
+ package: powerpoint!
+ summary: >-
+ Left Brace
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftBrace"'
+ - name: leftBracket
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftBracket:member
+ package: powerpoint!
+ summary: >-
+ Left Bracket
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftBracket"'
+ - name: leftCircularArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftCircularArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Circular with Opposite Arrow Direction
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftCircularArrow"'
+ - name: leftRightArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftRightArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Left-Right
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftRightArrow"'
+ - name: leftRightArrowCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftRightArrowCallout:member
+ package: powerpoint!
+ summary: >-
+ Callout: Left-Right Arrow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftRightArrowCallout"'
+ - name: leftRightCircularArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftRightCircularArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Circular with Two Arrows in Both Directions
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftRightCircularArrow"'
+ - name: leftRightRibbon
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftRightRibbon:member
+ package: powerpoint!
+ summary: >-
+ Ribbon: Straight with Both Left and Right Arrows
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftRightRibbon"'
+ - name: leftRightUpArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftRightUpArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Left-Right-Up
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftRightUpArrow"'
+ - name: leftUpArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.leftUpArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Left-Up
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LeftUpArrow"'
+ - name: lightningBolt
+ uid: powerpoint!PowerPoint.GeometricShapeType.lightningBolt:member
+ package: powerpoint!
+ summary: >-
+ Lightning Bolt
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightningBolt"'
+ - name: lineInverse
+ uid: powerpoint!PowerPoint.GeometricShapeType.lineInverse:member
+ package: powerpoint!
+ summary: >-
+ Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LineInverse"'
+ - name: mathDivide
+ uid: powerpoint!PowerPoint.GeometricShapeType.mathDivide:member
+ package: powerpoint!
+ summary: >-
+ Division Sign
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MathDivide"'
+ - name: mathEqual
+ uid: powerpoint!PowerPoint.GeometricShapeType.mathEqual:member
+ package: powerpoint!
+ summary: >-
+ Equals
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MathEqual"'
+ - name: mathMinus
+ uid: powerpoint!PowerPoint.GeometricShapeType.mathMinus:member
+ package: powerpoint!
+ summary: >-
+ Minus Sign
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MathMinus"'
+ - name: mathMultiply
+ uid: powerpoint!PowerPoint.GeometricShapeType.mathMultiply:member
+ package: powerpoint!
+ summary: >-
+ Multiplication Sign
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MathMultiply"'
+ - name: mathNotEqual
+ uid: powerpoint!PowerPoint.GeometricShapeType.mathNotEqual:member
+ package: powerpoint!
+ summary: >-
+ Not Equal
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MathNotEqual"'
+ - name: mathPlus
+ uid: powerpoint!PowerPoint.GeometricShapeType.mathPlus:member
+ package: powerpoint!
+ summary: >-
+ Plus Sign
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MathPlus"'
+ - name: moon
+ uid: powerpoint!PowerPoint.GeometricShapeType.moon:member
+ package: powerpoint!
+ summary: >-
+ Moon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Moon"'
+ - name: nonIsoscelesTrapezoid
+ uid: powerpoint!PowerPoint.GeometricShapeType.nonIsoscelesTrapezoid:member
+ package: powerpoint!
+ summary: >-
+ Trapezoid which may have Non-Equal Sides
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NonIsoscelesTrapezoid"'
+ - name: noSmoking
+ uid: powerpoint!PowerPoint.GeometricShapeType.noSmoking:member
+ package: powerpoint!
+ summary: >-
+ "Not Allowed" Symbol
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NoSmoking"'
+ - name: notchedRightArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.notchedRightArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Notched Right
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NotchedRightArrow"'
+ - name: octagon
+ uid: powerpoint!PowerPoint.GeometricShapeType.octagon:member
+ package: powerpoint!
+ summary: >-
+ Octagon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Octagon"'
+ - name: parallelogram
+ uid: powerpoint!PowerPoint.GeometricShapeType.parallelogram:member
+ package: powerpoint!
+ summary: >-
+ Parallelogram
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Parallelogram"'
+ - name: pentagon
+ uid: powerpoint!PowerPoint.GeometricShapeType.pentagon:member
+ package: powerpoint!
+ summary: >-
+ Pentagon
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Pentagon"'
+ - name: pie
+ uid: powerpoint!PowerPoint.GeometricShapeType.pie:member
+ package: powerpoint!
+ summary: >-
+ Partial Circle with Adjustable Spanning Area
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Pie"'
+ - name: pieWedge
+ uid: powerpoint!PowerPoint.GeometricShapeType.pieWedge:member
+ package: powerpoint!
+ summary: >-
+ Partial Circle
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"PieWedge"'
+ - name: plaque
+ uid: powerpoint!PowerPoint.GeometricShapeType.plaque:member
+ package: powerpoint!
+ summary: >-
+ Plaque
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Plaque"'
+ - name: plaqueTabs
+ uid: powerpoint!PowerPoint.GeometricShapeType.plaqueTabs:member
+ package: powerpoint!
+ summary: >-
+ Four Quarter Circles that Define a Rectangular Shape.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"PlaqueTabs"'
+ - name: plus
+ uid: powerpoint!PowerPoint.GeometricShapeType.plus:member
+ package: powerpoint!
+ summary: >-
+ Cross
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Plus"'
+ - name: quadArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.quadArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Quad
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"QuadArrow"'
+ - name: quadArrowCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.quadArrowCallout:member
+ package: powerpoint!
+ summary: >-
+ Callout: Quad Arrow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"QuadArrowCallout"'
+ - name: rectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.rectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Rectangle"'
+ - name: ribbon
+ uid: powerpoint!PowerPoint.GeometricShapeType.ribbon:member
+ package: powerpoint!
+ summary: >-
+ Ribbon: Tilted Down
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Ribbon"'
+ - name: ribbon2
+ uid: powerpoint!PowerPoint.GeometricShapeType.ribbon2:member
+ package: powerpoint!
+ summary: >-
+ Ribbon: Tilted Up
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Ribbon2"'
+ - name: rightArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.rightArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Right
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RightArrow"'
+ - name: rightArrowCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.rightArrowCallout:member
+ package: powerpoint!
+ summary: >-
+ Callout: Right Arrow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RightArrowCallout"'
+ - name: rightBrace
+ uid: powerpoint!PowerPoint.GeometricShapeType.rightBrace:member
+ package: powerpoint!
+ summary: >-
+ Right Brace
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RightBrace"'
+ - name: rightBracket
+ uid: powerpoint!PowerPoint.GeometricShapeType.rightBracket:member
+ package: powerpoint!
+ summary: >-
+ Right Bracket
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RightBracket"'
+ - name: rightTriangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.rightTriangle:member
+ package: powerpoint!
+ summary: >-
+ Right Triangle
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RightTriangle"'
+ - name: round1Rectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.round1Rectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Single Corner Rounded
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Round1Rectangle"'
+ - name: round2DiagonalRectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.round2DiagonalRectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Diagonal Corners Rounded
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Round2DiagonalRectangle"'
+ - name: round2SameRectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.round2SameRectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Top Corners Rounded
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Round2SameRectangle"'
+ - name: roundRectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.roundRectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Rounded Corners
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RoundRectangle"'
+ - name: smileyFace
+ uid: powerpoint!PowerPoint.GeometricShapeType.smileyFace:member
+ package: powerpoint!
+ summary: >-
+ Smiley Face
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SmileyFace"'
+ - name: snip1Rectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.snip1Rectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Single Corner Snipped
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Snip1Rectangle"'
+ - name: snip2DiagonalRectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.snip2DiagonalRectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Diagonal Corners Snipped
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Snip2DiagonalRectangle"'
+ - name: snip2SameRectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.snip2SameRectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Top Corners Snipped
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Snip2SameRectangle"'
+ - name: snipRoundRectangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.snipRoundRectangle:member
+ package: powerpoint!
+ summary: >-
+ Rectangle: Top Corners One Rounded and One Snipped
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SnipRoundRectangle"'
+ - name: squareTabs
+ uid: powerpoint!PowerPoint.GeometricShapeType.squareTabs:member
+ package: powerpoint!
+ summary: >-
+ Four Small Squares that Define a Rectangular Shape.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SquareTabs"'
+ - name: star10
+ uid: powerpoint!PowerPoint.GeometricShapeType.star10:member
+ package: powerpoint!
+ summary: >-
+ Star: 10 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star10"'
+ - name: star12
+ uid: powerpoint!PowerPoint.GeometricShapeType.star12:member
+ package: powerpoint!
+ summary: >-
+ Star: 12 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star12"'
+ - name: star16
+ uid: powerpoint!PowerPoint.GeometricShapeType.star16:member
+ package: powerpoint!
+ summary: >-
+ Star: 16 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star16"'
+ - name: star24
+ uid: powerpoint!PowerPoint.GeometricShapeType.star24:member
+ package: powerpoint!
+ summary: >-
+ Star: 24 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star24"'
+ - name: star32
+ uid: powerpoint!PowerPoint.GeometricShapeType.star32:member
+ package: powerpoint!
+ summary: >-
+ Star: 32 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star32"'
+ - name: star4
+ uid: powerpoint!PowerPoint.GeometricShapeType.star4:member
+ package: powerpoint!
+ summary: >-
+ Star: 4 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star4"'
+ - name: star5
+ uid: powerpoint!PowerPoint.GeometricShapeType.star5:member
+ package: powerpoint!
+ summary: >-
+ Star: 5 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star5"'
+ - name: star6
+ uid: powerpoint!PowerPoint.GeometricShapeType.star6:member
+ package: powerpoint!
+ summary: >-
+ Star: 6 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star6"'
+ - name: star7
+ uid: powerpoint!PowerPoint.GeometricShapeType.star7:member
+ package: powerpoint!
+ summary: >-
+ Star: 7 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star7"'
+ - name: star8
+ uid: powerpoint!PowerPoint.GeometricShapeType.star8:member
+ package: powerpoint!
+ summary: >-
+ Star: 8 Points
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Star8"'
+ - name: stripedRightArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.stripedRightArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Striped Right
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"StripedRightArrow"'
+ - name: sun
+ uid: powerpoint!PowerPoint.GeometricShapeType.sun:member
+ package: powerpoint!
+ summary: >-
+ Sun
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Sun"'
+ - name: swooshArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.swooshArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Curved Right Arrow with Varying Width
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SwooshArrow"'
+ - name: teardrop
+ uid: powerpoint!PowerPoint.GeometricShapeType.teardrop:member
+ package: powerpoint!
+ summary: >-
+ Teardrop
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Teardrop"'
+ - name: trapezoid
+ uid: powerpoint!PowerPoint.GeometricShapeType.trapezoid:member
+ package: powerpoint!
+ summary: >-
+ Trapezoid
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Trapezoid"'
+ - name: triangle
+ uid: powerpoint!PowerPoint.GeometricShapeType.triangle:member
+ package: powerpoint!
+ summary: >-
+ Isosceles Triangle
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Triangle"'
+ - name: upArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.upArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Up
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"UpArrow"'
+ - name: upArrowCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.upArrowCallout:member
+ package: powerpoint!
+ summary: >-
+ Callout: Up Arrow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"UpArrowCallout"'
+ - name: upDownArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.upDownArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: Up-Down
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"UpDownArrow"'
+ - name: upDownArrowCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.upDownArrowCallout:member
+ package: powerpoint!
+ summary: >-
+ Callout: Up-Down Arrow
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"UpDownArrowCallout"'
+ - name: uturnArrow
+ uid: powerpoint!PowerPoint.GeometricShapeType.uturnArrow:member
+ package: powerpoint!
+ summary: >-
+ Arrow: U-Turn
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"UturnArrow"'
+ - name: verticalScroll
+ uid: powerpoint!PowerPoint.GeometricShapeType.verticalScroll:member
+ package: powerpoint!
+ summary: >-
+ Scroll: Vertical
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"VerticalScroll"'
+ - name: wave
+ uid: powerpoint!PowerPoint.GeometricShapeType.wave:member
+ package: powerpoint!
+ summary: >-
+ Wave
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Wave"'
+ - name: wedgeEllipseCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.wedgeEllipseCallout:member
+ package: powerpoint!
+ summary: >-
+ Speech Bubble: Oval
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"WedgeEllipseCallout"'
+ - name: wedgeRectCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.wedgeRectCallout:member
+ package: powerpoint!
+ summary: >-
+ Speech Bubble: Rectangle
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"WedgeRectCallout"'
+ - name: wedgeRRectCallout
+ uid: powerpoint!PowerPoint.GeometricShapeType.wedgeRRectCallout:member
+ package: powerpoint!
+ summary: >-
+ Speech Bubble: Rectangle with Corners Rounded
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"WedgeRRectCallout"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.hyperlink.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.hyperlink.yml
new file mode 100644
index 0000000000..deadec7f42
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.hyperlink.yml
@@ -0,0 +1,193 @@
+### YamlMime:TSType
+name: PowerPoint.Hyperlink
+uid: powerpoint!PowerPoint.Hyperlink:class
+package: powerpoint!
+fullName: PowerPoint.Hyperlink
+summary: Represents a single hyperlink.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml
+
+
+ // Gets the hyperlinks found in the first selected slide.
+
+ await PowerPoint.run(async (context) => {
+ const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks.load("address,screenTip");
+ const hyperlinksCount = hyperlinks.getCount();
+ await context.sync();
+
+ console.log(`${hyperlinksCount.value} hyperlinks found in first selected slide:`);
+ for (let link of hyperlinks.items) {
+ console.log(`Address: "${link.address}" (Screen tip: "${link.screenTip}")`);
+ }
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: address
+ uid: powerpoint!PowerPoint.Hyperlink#address:member
+ package: powerpoint!
+ fullName: address
+ summary: Specifies the URL target of the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'address: string;'
+ return:
+ type: string
+ - name: context
+ uid: powerpoint!PowerPoint.Hyperlink#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: screenTip
+ uid: powerpoint!PowerPoint.Hyperlink#screenTip:member
+ package: powerpoint!
+ fullName: screenTip
+ summary: Specifies the string displayed when hovering over the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'screenTip: string;'
+ return:
+ type: string
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Hyperlink#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions):
+ PowerPoint.Hyperlink;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Hyperlink#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.Hyperlink;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.Hyperlink#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Hyperlink;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Hyperlink#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.HyperlinkData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.hyperlinkcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.hyperlinkcollection.yml
new file mode 100644
index 0000000000..7ba0f310c1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.hyperlinkcollection.yml
@@ -0,0 +1,215 @@
+### YamlMime:TSType
+name: PowerPoint.HyperlinkCollection
+uid: powerpoint!PowerPoint.HyperlinkCollection:class
+package: powerpoint!
+fullName: PowerPoint.HyperlinkCollection
+summary: Represents a collection of hyperlinks.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml
+
+
+ // Gets the hyperlinks found in the first selected slide.
+
+ await PowerPoint.run(async (context) => {
+ const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks.load("address,screenTip");
+ const hyperlinksCount = hyperlinks.getCount();
+ await context.sync();
+
+ console.log(`${hyperlinksCount.value} hyperlinks found in first selected slide:`);
+ for (let link of hyperlinks.items) {
+ console.log(`Address: "${link.address}" (Screen tip: "${link.screenTip}")`);
+ }
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.HyperlinkCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.HyperlinkCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.Hyperlink[];'
+ return:
+ type: []
+methods:
+ - name: getCount()
+ uid: powerpoint!PowerPoint.HyperlinkCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of hyperlinks in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of hyperlinks in the collection.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.HyperlinkCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.Hyperlink;'
+ parameters:
+ - id: index
+ description: The index of the hyperlink in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The hyperlink at the given index. An error is thrown if index is out
+ of range.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.HyperlinkCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.HyperlinkCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.HyperlinkCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.HyperlinkCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.HyperlinkCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.HyperlinkCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.insertslideformatting.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.insertslideformatting.yml
new file mode 100644
index 0000000000..c052ef8203
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.insertslideformatting.yml
@@ -0,0 +1,64 @@
+### YamlMime:TSEnum
+name: PowerPoint.InsertSlideFormatting
+uid: powerpoint!PowerPoint.InsertSlideFormatting:enum
+package: powerpoint!
+fullName: PowerPoint.InsertSlideFormatting
+summary: Specifies the formatting options for when slides are inserted.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/insert-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Get the ID of the first selected slide.
+ const presentation: PowerPoint.Presentation = context.presentation;
+ const selected: PowerPoint.Slide = presentation.getSelectedSlides().getItemAt(0);
+ selected.load("id");
+ await context.sync();
+
+ // Insert the other presentation after the selected slide.
+ const insertOptions: PowerPoint.InsertSlideOptions = {
+ formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
+ targetSlideId: selected.id
+ };
+ presentation.insertSlidesFromBase64(chosenFileBase64, insertOptions);
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: keepSourceFormatting
+ uid: powerpoint!PowerPoint.InsertSlideFormatting.keepSourceFormatting:member
+ package: powerpoint!
+ summary: >-
+ Copy the source theme into the target presentation and use that theme.
+
+
+ * \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"KeepSourceFormatting"'
+ - name: useDestinationTheme
+ uid: powerpoint!PowerPoint.InsertSlideFormatting.useDestinationTheme:member
+ package: powerpoint!
+ summary: >-
+ Use the existing theme in the target presentation.
+
+
+ * \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"UseDestinationTheme"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.insertslideoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.insertslideoptions.yml
new file mode 100644
index 0000000000..5cefbaa866
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.insertslideoptions.yml
@@ -0,0 +1,111 @@
+### YamlMime:TSType
+name: PowerPoint.InsertSlideOptions
+uid: powerpoint!PowerPoint.InsertSlideOptions:interface
+package: powerpoint!
+fullName: PowerPoint.InsertSlideOptions
+summary: Represents the available options when inserting slides.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/insert-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Get the ID of the first selected slide.
+ const presentation: PowerPoint.Presentation = context.presentation;
+ const selected: PowerPoint.Slide = presentation.getSelectedSlides().getItemAt(0);
+ selected.load("id");
+ await context.sync();
+
+ // Insert the other presentation after the selected slide.
+ const insertOptions: PowerPoint.InsertSlideOptions = {
+ formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
+ targetSlideId: selected.id
+ };
+ presentation.insertSlidesFromBase64(chosenFileBase64, insertOptions);
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: formatting
+ uid: powerpoint!PowerPoint.InsertSlideOptions#formatting:member
+ package: powerpoint!
+ fullName: formatting
+ summary: >-
+ Specifies which formatting to use during slide insertion. The default
+ option is to use "KeepSourceFormatting".
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" |
+ "UseDestinationTheme";
+ return:
+ type: >-
+ |
+ "KeepSourceFormatting" | "UseDestinationTheme"
+ - name: sourceSlideIds
+ uid: powerpoint!PowerPoint.InsertSlideOptions#sourceSlideIds:member
+ package: powerpoint!
+ fullName: sourceSlideIds
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'sourceSlideIds?: string[];'
+ return:
+ type: string[]
+ - name: targetSlideId
+ uid: powerpoint!PowerPoint.InsertSlideOptions#targetSlideId:member
+ package: powerpoint!
+ fullName: targetSlideId
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'targetSlideId?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `bindingCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml
new file mode 100644
index 0000000000..9fab8d724f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml
@@ -0,0 +1,67 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionLoadOptions
+summary: >-
+ Represents the collection of all the binding objects that are part of the
+ presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: Represents the binding identifier.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ For EACH ITEM in the collection: Returns the type of the binding. See
+ `BindingType` for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingCollectionUpdateData
+summary: >-
+ An interface for updating data on the `BindingCollection` object, for use in
+ `bindingCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.BindingData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..29ff917fca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingdata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingData
+uid: powerpoint!PowerPoint.Interfaces.BindingData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingData
+summary: >-
+ An interface describing the data returned by calling `binding.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.BindingData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Represents the binding identifier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.BindingData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Returns the type of the binding. See `BindingType` for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: PowerPoint.BindingType | "Shape";'
+ return:
+ type: | "Shape"
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingloadoptions.yml
new file mode 100644
index 0000000000..c46636dbe7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bindingloadoptions.yml
@@ -0,0 +1,63 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BindingLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.BindingLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BindingLoadOptions
+summary: Represents an Office.js binding that is defined in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.BindingLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.BindingLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Represents the binding identifier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.BindingLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Returns the type of the binding. See `BindingType` for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatdata.yml
new file mode 100644
index 0000000000..564a81e121
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatdata.yml
@@ -0,0 +1,33 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BulletFormatData
+uid: powerpoint!PowerPoint.Interfaces.BulletFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BulletFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `bulletFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: visible
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatData#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml
new file mode 100644
index 0000000000..6703c6b0b4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml
@@ -0,0 +1,53 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BulletFormatLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BulletFormatLoadOptions
+summary: >-
+ Represents the bullet formatting properties of a text that is attached to the
+ [PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: visible
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml
new file mode 100644
index 0000000000..acc6e81e77
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml
@@ -0,0 +1,33 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BulletFormatUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BulletFormatUpdateData
+summary: >-
+ An interface for updating data on the `BulletFormat` object, for use in
+ `bulletFormat.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: visible
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.collectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.collectionloadoptions.yml
new file mode 100644
index 0000000000..ff23f8998b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.collectionloadoptions.yml
@@ -0,0 +1,43 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.CollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CollectionLoadOptions
+summary: Provides ways to load properties of only a subset of members of a collection.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $skip
+ uid: powerpoint!PowerPoint.Interfaces.CollectionLoadOptions#$skip:member
+ package: powerpoint!
+ fullName: $skip
+ summary: >-
+ 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$skip?: number;'
+ return:
+ type: number
+ - name: $top
+ uid: powerpoint!PowerPoint.Interfaces.CollectionLoadOptions#$top:member
+ package: powerpoint!
+ fullName: $top
+ summary: >-
+ Specify the number of items in the queried collection to be included in
+ the result.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$top?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectiondata.yml
new file mode 100644
index 0000000000..a62ea2d5f3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomPropertyCollectionData
+uid: powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomPropertyCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `customPropertyCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.CustomPropertyData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectionloadoptions.yml
new file mode 100644
index 0000000000..61e7618aa4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectionloadoptions.yml
@@ -0,0 +1,90 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions
+summary: A collection of custom properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: key
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions#key:member
+ package: powerpoint!
+ fullName: key
+ summary: >-
+ For EACH ITEM in the collection: The string that uniquely identifies the
+ custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'key?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ For EACH ITEM in the collection: The type of the value used for the custom
+ property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
+ - name: value
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions#value:member
+ package: powerpoint!
+ fullName: value
+ summary: >-
+ For EACH ITEM in the collection: The value of the custom property. If the
+ value is a string, the maximum length 255 characters. Larger strings cause
+ the operation to fail with an `InvalidArgument` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectionupdatedata.yml
new file mode 100644
index 0000000000..30677e389a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertycollectionupdatedata.yml
@@ -0,0 +1,31 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomPropertyCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomPropertyCollectionUpdateData
+summary: >-
+ An interface for updating data on the `CustomPropertyCollection` object, for
+ use in `customPropertyCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomPropertyCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.CustomPropertyData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertydata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertydata.yml
new file mode 100644
index 0000000000..64ff37d266
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertydata.yml
@@ -0,0 +1,69 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomPropertyData
+uid: powerpoint!PowerPoint.Interfaces.CustomPropertyData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomPropertyData
+summary: >-
+ An interface describing the data returned by calling
+ `customProperty.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: key
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyData#key:member
+ package: powerpoint!
+ fullName: key
+ summary: The string that uniquely identifies the custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'key?: string;'
+ return:
+ type: string
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: The type of the value used for the custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" |
+ "String";
+ return:
+ type: >-
+ |
+ "Boolean" | "Date" | "Number" | "String"
+ - name: value
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyData#value:member
+ package: powerpoint!
+ fullName: value
+ summary: >-
+ The value of the custom property. If the value is a string, the maximum
+ length 255 characters. Larger strings cause the operation to fail with an
+ `InvalidArgument` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: boolean | Date | number | string;'
+ return:
+ type: boolean | Date | number | string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertyloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertyloadoptions.yml
new file mode 100644
index 0000000000..743a0e32bb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertyloadoptions.yml
@@ -0,0 +1,82 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomPropertyLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.CustomPropertyLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomPropertyLoadOptions
+summary: Represents a custom property.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: key
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyLoadOptions#key:member
+ package: powerpoint!
+ fullName: key
+ summary: The string that uniquely identifies the custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'key?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: The type of the value used for the custom property.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
+ - name: value
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyLoadOptions#value:member
+ package: powerpoint!
+ fullName: value
+ summary: >-
+ The value of the custom property. If the value is a string, the maximum
+ length 255 characters. Larger strings cause the operation to fail with an
+ `InvalidArgument` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertyupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertyupdatedata.yml
new file mode 100644
index 0000000000..7225c8a34c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.custompropertyupdatedata.yml
@@ -0,0 +1,33 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomPropertyUpdateData
+uid: powerpoint!PowerPoint.Interfaces.CustomPropertyUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomPropertyUpdateData
+summary: >-
+ An interface for updating data on the `CustomProperty` object, for use in
+ `customProperty.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: value
+ uid: powerpoint!PowerPoint.Interfaces.CustomPropertyUpdateData#value:member
+ package: powerpoint!
+ fullName: value
+ summary: >-
+ The value of the custom property. If the value is a string, the maximum
+ length 255 characters. Larger strings cause the operation to fail with an
+ `InvalidArgument` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: boolean | Date | number | string;'
+ return:
+ type: boolean | Date | number | string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectiondata.yml
new file mode 100644
index 0000000000..da0fd365be
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartCollectionData
+uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `customXmlPartCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.CustomXmlPartData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectionloadoptions.yml
new file mode 100644
index 0000000000..eb2c27d2c0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectionloadoptions.yml
@@ -0,0 +1,66 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions
+summary: A collection of custom XML parts.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: The ID of the custom XML part.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: namespaceUri
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions#namespaceUri:member
+ package: powerpoint!
+ fullName: namespaceUri
+ summary: 'For EACH ITEM in the collection: The namespace URI of the custom XML part.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'namespaceUri?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectionupdatedata.yml
new file mode 100644
index 0000000000..e31e2f3f36
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartcollectionupdatedata.yml
@@ -0,0 +1,31 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData
+summary: >-
+ An interface for updating data on the `CustomXmlPartCollection` object, for
+ use in `customXmlPartCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.CustomXmlPartData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartdata.yml
new file mode 100644
index 0000000000..8a1d41fbbb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartdata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartData
+uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartData
+summary: >-
+ An interface describing the data returned by calling
+ `customXmlPart.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: The ID of the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
+ - name: namespaceUri
+ uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartData#namespaceUri:member
+ package: powerpoint!
+ fullName: namespaceUri
+ summary: The namespace URI of the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'namespaceUri?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartloadoptions.yml
new file mode 100644
index 0000000000..6361f4e321
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartloadoptions.yml
@@ -0,0 +1,64 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartLoadOptions
+summary: Represents a custom XML part object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: The ID of the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: namespaceUri
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartLoadOptions#namespaceUri:member
+ package: powerpoint!
+ fullName: namespaceUri
+ summary: The namespace URI of the custom XML part.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'namespaceUri?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectiondata.yml
new file mode 100644
index 0000000000..fa1a74efa2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectiondata.yml
@@ -0,0 +1,31 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `customXmlPartScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.CustomXmlPartData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionloadoptions.yml
new file mode 100644
index 0000000000..d139b41d42
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionloadoptions.yml
@@ -0,0 +1,70 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions
+uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions
+summary: >-
+ A scoped collection of custom XML parts. A scoped collection is the result of
+ some operation (such as filtering by namespace). A scoped collection cannot be
+ scoped any further.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: The ID of the custom XML part.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: namespaceUri
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions#namespaceUri:member
+ package: powerpoint!
+ fullName: namespaceUri
+ summary: 'For EACH ITEM in the collection: The namespace URI of the custom XML part.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'namespaceUri?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..4f9d2c8176
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionupdatedata.yml
@@ -0,0 +1,32 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `CustomXmlPartScopedCollection` object,
+ for use in `customXmlPartScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.CustomXmlPartData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesdata.yml
new file mode 100644
index 0000000000..556231d99b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesdata.yml
@@ -0,0 +1,194 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.DocumentPropertiesData
+uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.DocumentPropertiesData
+summary: >-
+ An interface describing the data returned by calling
+ `documentProperties.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: author
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#author:member
+ package: powerpoint!
+ fullName: author
+ summary: The author of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'author?: string;'
+ return:
+ type: string
+ - name: category
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#category:member
+ package: powerpoint!
+ fullName: category
+ summary: The category of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'category?: string;'
+ return:
+ type: string
+ - name: comments
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#comments:member
+ package: powerpoint!
+ fullName: comments
+ summary: >-
+ The Comments field in the metadata of the presentation. These have no
+ connection to comments made in slides.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'comments?: string;'
+ return:
+ type: string
+ - name: company
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#company:member
+ package: powerpoint!
+ fullName: company
+ summary: The company of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'company?: string;'
+ return:
+ type: string
+ - name: creationDate
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#creationDate:member
+ package: powerpoint!
+ fullName: creationDate
+ summary: The creation date of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationDate?: Date;'
+ return:
+ type: Date
+ - name: keywords
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#keywords:member
+ package: powerpoint!
+ fullName: keywords
+ summary: The keywords of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'keywords?: string;'
+ return:
+ type: string
+ - name: lastAuthor
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#lastAuthor:member
+ package: powerpoint!
+ fullName: lastAuthor
+ summary: The last author of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lastAuthor?: string;'
+ return:
+ type: string
+ - name: manager
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#manager:member
+ package: powerpoint!
+ fullName: manager
+ summary: The manager of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'manager?: string;'
+ return:
+ type: string
+ - name: revisionNumber
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#revisionNumber:member
+ package: powerpoint!
+ fullName: revisionNumber
+ summary: The revision number of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'revisionNumber?: number;'
+ return:
+ type: number
+ - name: subject
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#subject:member
+ package: powerpoint!
+ fullName: subject
+ summary: The subject of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subject?: string;'
+ return:
+ type: string
+ - name: title
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesData#title:member
+ package: powerpoint!
+ fullName: title
+ summary: The title of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesloadoptions.yml
new file mode 100644
index 0000000000..b5e14080c1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesloadoptions.yml
@@ -0,0 +1,220 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.DocumentPropertiesLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.DocumentPropertiesLoadOptions
+summary: Represents presentation properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: author
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#author:member
+ package: powerpoint!
+ fullName: author
+ summary: The author of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'author?: boolean;'
+ return:
+ type: boolean
+ - name: category
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#category:member
+ package: powerpoint!
+ fullName: category
+ summary: The category of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'category?: boolean;'
+ return:
+ type: boolean
+ - name: comments
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#comments:member
+ package: powerpoint!
+ fullName: comments
+ summary: >-
+ The Comments field in the metadata of the presentation. These have no
+ connection to comments made in slides.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'comments?: boolean;'
+ return:
+ type: boolean
+ - name: company
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#company:member
+ package: powerpoint!
+ fullName: company
+ summary: The company of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'company?: boolean;'
+ return:
+ type: boolean
+ - name: creationDate
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#creationDate:member
+ package: powerpoint!
+ fullName: creationDate
+ summary: The creation date of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationDate?: boolean;'
+ return:
+ type: boolean
+ - name: keywords
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#keywords:member
+ package: powerpoint!
+ fullName: keywords
+ summary: The keywords of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'keywords?: boolean;'
+ return:
+ type: boolean
+ - name: lastAuthor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#lastAuthor:member
+ package: powerpoint!
+ fullName: lastAuthor
+ summary: The last author of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lastAuthor?: boolean;'
+ return:
+ type: boolean
+ - name: manager
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#manager:member
+ package: powerpoint!
+ fullName: manager
+ summary: The manager of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'manager?: boolean;'
+ return:
+ type: boolean
+ - name: revisionNumber
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#revisionNumber:member
+ package: powerpoint!
+ fullName: revisionNumber
+ summary: The revision number of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'revisionNumber?: boolean;'
+ return:
+ type: boolean
+ - name: subject
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#subject:member
+ package: powerpoint!
+ fullName: subject
+ summary: The subject of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subject?: boolean;'
+ return:
+ type: boolean
+ - name: title
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesLoadOptions#title:member
+ package: powerpoint!
+ fullName: title
+ summary: The title of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesupdatedata.yml
new file mode 100644
index 0000000000..b44d82bcd2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.documentpropertiesupdatedata.yml
@@ -0,0 +1,168 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.DocumentPropertiesUpdateData
+uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.DocumentPropertiesUpdateData
+summary: >-
+ An interface for updating data on the `DocumentProperties` object, for use in
+ `documentProperties.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: author
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#author:member
+ package: powerpoint!
+ fullName: author
+ summary: The author of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'author?: string;'
+ return:
+ type: string
+ - name: category
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#category:member
+ package: powerpoint!
+ fullName: category
+ summary: The category of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'category?: string;'
+ return:
+ type: string
+ - name: comments
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#comments:member
+ package: powerpoint!
+ fullName: comments
+ summary: >-
+ The Comments field in the metadata of the presentation. These have no
+ connection to comments made in slides.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'comments?: string;'
+ return:
+ type: string
+ - name: company
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#company:member
+ package: powerpoint!
+ fullName: company
+ summary: The company of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'company?: string;'
+ return:
+ type: string
+ - name: keywords
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#keywords:member
+ package: powerpoint!
+ fullName: keywords
+ summary: The keywords of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'keywords?: string;'
+ return:
+ type: string
+ - name: manager
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#manager:member
+ package: powerpoint!
+ fullName: manager
+ summary: The manager of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'manager?: string;'
+ return:
+ type: string
+ - name: revisionNumber
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#revisionNumber:member
+ package: powerpoint!
+ fullName: revisionNumber
+ summary: The revision number of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'revisionNumber?: number;'
+ return:
+ type: number
+ - name: subject
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#subject:member
+ package: powerpoint!
+ fullName: subject
+ summary: The subject of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subject?: string;'
+ return:
+ type: string
+ - name: title
+ uid: powerpoint!PowerPoint.Interfaces.DocumentPropertiesUpdateData#title:member
+ package: powerpoint!
+ fullName: title
+ summary: The title of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectiondata.yml
new file mode 100644
index 0000000000..70854c2712
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.HyperlinkData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml
new file mode 100644
index 0000000000..8f565832ad
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml
@@ -0,0 +1,70 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions
+summary: Represents a collection of hyperlinks.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: address
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkCollectionLoadOptions#address:member
+ package: powerpoint!
+ fullName: address
+ summary: >-
+ For EACH ITEM in the collection: Specifies the URL target of the
+ hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'address?: boolean;'
+ return:
+ type: boolean
+ - name: screenTip
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkCollectionLoadOptions#screenTip:member
+ package: powerpoint!
+ fullName: screenTip
+ summary: >-
+ For EACH ITEM in the collection: Specifies the string displayed when
+ hovering over the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'screenTip?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectionupdatedata.yml
new file mode 100644
index 0000000000..26ff6e3d6b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkCollection` object, for use in
+ `hyperlinkCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.HyperlinkData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkdata.yml
new file mode 100644
index 0000000000..0a79bdef8b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkdata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkData
+summary: >-
+ An interface describing the data returned by calling `hyperlink.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: address
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkData#address:member
+ package: powerpoint!
+ fullName: address
+ summary: Specifies the URL target of the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'address?: string;'
+ return:
+ type: string
+ - name: screenTip
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkData#screenTip:member
+ package: powerpoint!
+ fullName: screenTip
+ summary: Specifies the string displayed when hovering over the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'screenTip?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml
new file mode 100644
index 0000000000..6dcad19d9d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml
@@ -0,0 +1,63 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkLoadOptions
+summary: Represents a single hyperlink.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: address
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions#address:member
+ package: powerpoint!
+ fullName: address
+ summary: Specifies the URL target of the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'address?: boolean;'
+ return:
+ type: boolean
+ - name: screenTip
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions#screenTip:member
+ package: powerpoint!
+ fullName: screenTip
+ summary: Specifies the string displayed when hovering over the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'screenTip?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkupdatedata.yml
new file mode 100644
index 0000000000..2bbc34608e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkupdatedata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkUpdateData
+summary: >-
+ An interface for updating data on the `Hyperlink` object, for use in
+ `hyperlink.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: address
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData#address:member
+ package: powerpoint!
+ fullName: address
+ summary: Specifies the URL target of the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'address?: string;'
+ return:
+ type: string
+ - name: screenTip
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData#screenTip:member
+ package: powerpoint!
+ fullName: screenTip
+ summary: Specifies the string displayed when hovering over the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'screenTip?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatdata.yml
new file mode 100644
index 0000000000..26821ab406
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatdata.yml
@@ -0,0 +1,42 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ParagraphFormatData
+uid: powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ParagraphFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `paragraphFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: horizontalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ParagraphFormatData#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Represents the horizontal alignment of the paragraph. Returns 'null' if
+ the 'TextRange' includes text fragments with different horizontal
+ alignment values. See
+ [PowerPoint.ParagraphHorizontalAlignment](xref:powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" |
+ "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" |
+ "ThaiDistributed";
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed"
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml
new file mode 100644
index 0000000000..3bcff44084
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml
@@ -0,0 +1,79 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ParagraphFormatLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ParagraphFormatLoadOptions
+summary: >-
+ Represents the paragraph formatting properties of a text that is attached to
+ the [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: bulletFormat
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions#bulletFormat:member
+ package: powerpoint!
+ fullName: bulletFormat
+ summary: >-
+ Represents the bullet format of the paragraph. See
+ [PowerPoint.BulletFormat](xref:powerpoint!PowerPoint.BulletFormat:class)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: horizontalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Represents the horizontal alignment of the paragraph. Returns 'null' if
+ the 'TextRange' includes text fragments with different horizontal
+ alignment values. See
+ [PowerPoint.ParagraphHorizontalAlignment](xref:powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'horizontalAlignment?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml
new file mode 100644
index 0000000000..70d1f1e604
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml
@@ -0,0 +1,42 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ParagraphFormatUpdateData
+uid: powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ParagraphFormatUpdateData
+summary: >-
+ An interface for updating data on the `ParagraphFormat` object, for use in
+ `paragraphFormat.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: horizontalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Represents the horizontal alignment of the paragraph. Returns 'null' if
+ the 'TextRange' includes text fragments with different horizontal
+ alignment values. See
+ [PowerPoint.ParagraphHorizontalAlignment](xref:powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" |
+ "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" |
+ "ThaiDistributed";
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed"
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7b7cd7970e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
@@ -0,0 +1,72 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatData
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `placeholderFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: containedType
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.PlaceholderFormatData#containedType:member
+ package: powerpoint!
+ fullName: containedType
+ summary: >-
+ Gets the type of the shape contained within the placeholder. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details. Returns `null` if the placeholder is empty.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" |
+ "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" |
+ "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" |
+ "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
+ return:
+ type: >-
+ | "Unsupported" |
+ "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" |
+ "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" |
+ "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" |
+ null
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of this placeholder. See
+ [PowerPoint.PlaceholderType](xref:powerpoint!PowerPoint.PlaceholderType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" |
+ "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" |
+ "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" |
+ "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" |
+ "Picture" | "Cameo";
+ return:
+ type: >-
+ |
+ "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title"
+ | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" |
+ "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" |
+ "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml
new file mode 100644
index 0000000000..85885ac813
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml
@@ -0,0 +1,70 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PlaceholderFormatLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PlaceholderFormatLoadOptions
+summary: Represents the properties of a `placeholder` shape.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: containedType
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.PlaceholderFormatLoadOptions#containedType:member
+ package: powerpoint!
+ fullName: containedType
+ summary: >-
+ Gets the type of the shape contained within the placeholder. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details. Returns `null` if the placeholder is empty.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'containedType?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.PlaceholderFormatLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of this placeholder. See
+ [PowerPoint.PlaceholderType](xref:powerpoint!PowerPoint.PlaceholderType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.presentationdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.presentationdata.yml
new file mode 100644
index 0000000000..84575cfef4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.presentationdata.yml
@@ -0,0 +1,43 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PresentationData
+uid: powerpoint!PowerPoint.Interfaces.PresentationData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PresentationData
+summary: >-
+ An interface describing the data returned by calling
+ `presentation.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.PresentationData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the ID of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
+ - name: title
+ uid: powerpoint!PowerPoint.Interfaces.PresentationData#title:member
+ package: powerpoint!
+ fullName: title
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.presentationloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.presentationloadoptions.yml
new file mode 100644
index 0000000000..67e39267e8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.presentationloadoptions.yml
@@ -0,0 +1,79 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PresentationLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PresentationLoadOptions
+summary: ''
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.0](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.PresentationLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.PresentationLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the ID of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: properties
+ uid: powerpoint!PowerPoint.Interfaces.PresentationLoadOptions#properties:member
+ package: powerpoint!
+ fullName: properties
+ summary: Gets the properties of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;'
+ return:
+ type: >-
+
+ - name: title
+ uid: powerpoint!PowerPoint.Interfaces.PresentationLoadOptions#title:member
+ package: powerpoint!
+ fullName: title
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'title?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectiondata.yml
new file mode 100644
index 0000000000..a4e879d3fc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectiondata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeCollectionData
+uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `shapeCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.ShapeData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
new file mode 100644
index 0000000000..f4bb5cc68f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
@@ -0,0 +1,334 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeCollectionLoadOptions
+summary: Represents the collection of shapes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: fill
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: >-
+ For EACH ITEM in the collection: Returns the fill formatting of this
+ shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;'
+ return:
+ type: >-
+
+ - name: group
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#group:member
+ package: powerpoint!
+ fullName: group
+ summary: >-
+ For EACH ITEM in the collection: Returns the `ShapeGroup` associated with
+ the shape. If the shape type isn't `group`, then this method
+ returns the `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;'
+ return:
+ type: >-
+
+ - name: height
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: Gets the unique ID of the shape.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: left
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: boolean;'
+ return:
+ type: boolean
+ - name: level
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#level:member
+ package: powerpoint!
+ fullName: level
+ summary: |-
+ For EACH ITEM in the collection: Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'level?: boolean;'
+ return:
+ type: boolean
+ - name: lineFormat
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#lineFormat:member
+ package: powerpoint!
+ fullName: lineFormat
+ summary: >-
+ For EACH ITEM in the collection: Returns the line formatting of this
+ shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: 'For EACH ITEM in the collection: Specifies the name of this shape.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
+ - name: parentGroup
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#parentGroup:member
+ package: powerpoint!
+ fullName: parentGroup
+ summary: >-
+ For EACH ITEM in the collection: Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the
+ `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;'
+ return:
+ type: >-
+
+ - name: placeholderFormat
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#placeholderFormat:member
+ package: powerpoint!
+ fullName: placeholderFormat
+ summary: >-
+ For EACH ITEM in the collection: Returns the properties that apply
+ specifically to this placeholder. If the shape type isn't
+ `placeholder`, then this method returns the `GeneralException`
+ error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: textFrame
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#textFrame:member
+ package: powerpoint!
+ fullName: textFrame
+ summary: >-
+ For EACH ITEM in the collection: Returns the text frame object of this
+ shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;'
+ return:
+ type: >-
+
+ - name: top
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ For EACH ITEM in the collection: Returns the type of this shape. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
+ - name: width
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: boolean;'
+ return:
+ type: boolean
+ - name: zOrderPosition
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#zOrderPosition:member
+ package: powerpoint!
+ fullName: zOrderPosition
+ summary: >-
+ For EACH ITEM in the collection: Returns the z-order position of the
+ shape, with 0 representing the bottom of the order stack. Every shape on a
+ slide has a unique z-order, but each slide also has a unique z-order
+ stack, so two shapes on separate slides could have the same z-order
+ number.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'zOrderPosition?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectionupdatedata.yml
new file mode 100644
index 0000000000..ed728a0635
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapecollectionupdatedata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeCollectionUpdateData
+summary: >-
+ An interface for updating data on the `ShapeCollection` object, for use in
+ `shapeCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.ShapeData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapedata.yml
new file mode 100644
index 0000000000..c85fcd0e57
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapedata.yml
@@ -0,0 +1,186 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeData
+uid: powerpoint!PowerPoint.Interfaces.ShapeData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeData
+summary: An interface describing the data returned by calling `shape.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: height
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: number;'
+ return:
+ type: number
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
+ - name: left
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ The distance, in points, from the left side of the shape to the left side
+ of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: number;'
+ return:
+ type: number
+ - name: level
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#level:member
+ package: powerpoint!
+ fullName: level
+ summary: |-
+ Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'level?: number;'
+ return:
+ type: number
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Specifies the name of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: string;'
+ return:
+ type: string
+ - name: top
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ The distance, in points, from the top edge of the shape to the top edge of
+ the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: number;'
+ return:
+ type: number
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of this shape. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape"
+ | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" |
+ "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole"
+ | "Placeholder" | "SmartArt" | "TextBox";
+ return:
+ type: >-
+ | "Unsupported" |
+ "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" |
+ "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" |
+ "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"
+ - name: width
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Specifies the width, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: number;'
+ return:
+ type: number
+ - name: zOrderPosition
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#zOrderPosition:member
+ package: powerpoint!
+ fullName: zOrderPosition
+ summary: >-
+ Returns the z-order position of the shape, with 0 representing the bottom
+ of the order stack. Every shape on a slide has a unique z-order, but each
+ slide also has a unique z-order stack, so two shapes on separate slides
+ could have the same z-order number.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'zOrderPosition?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefilldata.yml
new file mode 100644
index 0000000000..c52042ed93
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefilldata.yml
@@ -0,0 +1,76 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeFillData
+uid: powerpoint!PowerPoint.Interfaces.ShapeFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeFillData
+summary: >-
+ An interface describing the data returned by calling `shapeFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: foregroundColor
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFillData#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor?: string;'
+ return:
+ type: string
+ - name: transparency
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFillData#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: number;'
+ return:
+ type: number
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFillData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the fill type of the shape. See
+ [PowerPoint.ShapeFillType](xref:powerpoint!PowerPoint.ShapeFillType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" |
+ "Pattern" | "PictureAndTexture" | "SlideBackground";
+ return:
+ type: >-
+ | "NoFill" |
+ "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" |
+ "SlideBackground"
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefillloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefillloadoptions.yml
new file mode 100644
index 0000000000..f560147516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefillloadoptions.yml
@@ -0,0 +1,89 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeFillLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ShapeFillLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeFillLoadOptions
+summary: Represents the fill formatting of a shape object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFillLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: foregroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeFillLoadOptions#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor?: boolean;'
+ return:
+ type: boolean
+ - name: transparency
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFillLoadOptions#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFillLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the fill type of the shape. See
+ [PowerPoint.ShapeFillType](xref:powerpoint!PowerPoint.ShapeFillType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefillupdatedata.yml
new file mode 100644
index 0000000000..827d22dd75
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefillupdatedata.yml
@@ -0,0 +1,53 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.ShapeFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeFillUpdateData
+summary: >-
+ An interface for updating data on the `ShapeFill` object, for use in
+ `shapeFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: foregroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeFillUpdateData#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor?: string;'
+ return:
+ type: string
+ - name: transparency
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFillUpdateData#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontdata.yml
new file mode 100644
index 0000000000..283806cbf0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontdata.yml
@@ -0,0 +1,328 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeFontData
+uid: powerpoint!PowerPoint.Interfaces.ShapeFontData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeFontData
+summary: >-
+ An interface describing the data returned by calling `shapeFont.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: allCaps
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#allCaps:member
+ package: powerpoint!
+ fullName: allCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **All
+ Caps** attribute which makes lowercase letters appear as uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **All Caps** attribute.
+
+
+ - `false`: None of the text has the **All Caps**attribute.
+
+
+ - `null`: Some, but not all, of the text has the **All Caps**
+ attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allCaps?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: bold
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#bold:member
+ package: powerpoint!
+ fullName: bold
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to bold. The possible
+ values are as follows:
+
+
+ - `true`: All the text is bold.
+
+
+ - `false`: None of the text is bold.
+
+
+ - `null`: Returned if some, but not all, of the text is bold.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bold?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the HTML color code representation of the text color (e.g.,
+ "\#FF0000" represents red). Returns `null` if the `TextRange` contains
+ text fragments with different colors.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string | null;'
+ return:
+ type: string | null
+ - name: doubleStrikethrough
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#doubleStrikethrough:member
+ package: powerpoint!
+ fullName: doubleStrikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Double
+ strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Double strikethrough**
+ attribute.
+
+
+ - `false`: None of the text has the **Double strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Double strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'doubleStrikethrough?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: italic
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#italic:member
+ package: powerpoint!
+ fullName: italic
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to italic. The
+ possible values are as follows:
+
+
+ - `true`: All the text is italicized.
+
+
+ - `false`: None of the text is italicized.
+
+
+ - `null`: Returned if some, but not all, of the text is
+ italicized.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'italic?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#name:member
+ package: powerpoint!
+ fullName: name
+ summary: >-
+ Specifies the 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. Returns `null` if the `TextRange` contains text
+ fragments with different font names.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: string | null;'
+ return:
+ type: string | null
+ - name: size
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#size:member
+ package: powerpoint!
+ fullName: size
+ summary: >-
+ Specifies the font size in points (e.g., 11). Returns `null` if the
+ `TextRange` contains text fragments with different font sizes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'size?: number | null;'
+ return:
+ type: number | null
+ - name: smallCaps
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#smallCaps:member
+ package: powerpoint!
+ fullName: smallCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Small
+ Caps** attribute which makes lowercase letters appear as small uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **Small Caps** attribute.
+
+
+ - `false`: None of the text has the **Small Caps** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Small Caps** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'smallCaps?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: strikethrough
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#strikethrough:member
+ package: powerpoint!
+ fullName: strikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Strikethrough** attribute.
+
+
+ - `false`: None of the text has the **Strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'strikethrough?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: subscript
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#subscript:member
+ package: powerpoint!
+ fullName: subscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Subscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Subscript** attribute.
+
+
+ - `false`: None of the text has the **Subscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Subscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subscript?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: superscript
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#superscript:member
+ package: powerpoint!
+ fullName: superscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Superscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Superscript** attribute.
+
+
+ - `false`: None of the text has the **Superscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Superscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'superscript?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: underline
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontData#underline:member
+ package: powerpoint!
+ fullName: underline
+ summary: >-
+ Specifies the type of underline applied to the font. Returns `null` if the
+ `TextRange` contains text fragments with different underline styles. See
+ [PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" |
+ "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" |
+ "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash"
+ | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
+ return:
+ type: >-
+ |
+ "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" |
+ "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" |
+ "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" |
+ "WavyHeavy" | "WavyDouble" | null
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml
new file mode 100644
index 0000000000..620f108623
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml
@@ -0,0 +1,339 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeFontLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeFontLoadOptions
+summary: >-
+ Represents the font attributes, such as font name, font size, and color, for a
+ shape's TextRange object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: allCaps
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#allCaps:member
+ package: powerpoint!
+ fullName: allCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **All
+ Caps** attribute which makes lowercase letters appear as uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **All Caps** attribute.
+
+
+ - `false`: None of the text has the **All Caps**attribute.
+
+
+ - `null`: Some, but not all, of the text has the **All Caps**
+ attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allCaps?: boolean;'
+ return:
+ type: boolean
+ - name: bold
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#bold:member
+ package: powerpoint!
+ fullName: bold
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to bold. The possible
+ values are as follows:
+
+
+ - `true`: All the text is bold.
+
+
+ - `false`: None of the text is bold.
+
+
+ - `null`: Returned if some, but not all, of the text is bold.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bold?: boolean;'
+ return:
+ type: boolean
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the HTML color code representation of the text color (e.g.,
+ "\#FF0000" represents red). Returns `null` if the `TextRange` contains
+ text fragments with different colors.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: boolean;'
+ return:
+ type: boolean
+ - name: doubleStrikethrough
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#doubleStrikethrough:member
+ package: powerpoint!
+ fullName: doubleStrikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Double
+ strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Double strikethrough**
+ attribute.
+
+
+ - `false`: None of the text has the **Double strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Double strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'doubleStrikethrough?: boolean;'
+ return:
+ type: boolean
+ - name: italic
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#italic:member
+ package: powerpoint!
+ fullName: italic
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to italic. The
+ possible values are as follows:
+
+
+ - `true`: All the text is italicized.
+
+
+ - `false`: None of the text is italicized.
+
+
+ - `null`: Returned if some, but not all, of the text is
+ italicized.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'italic?: boolean;'
+ return:
+ type: boolean
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: >-
+ Specifies the 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. Returns `null` if the `TextRange` contains text
+ fragments with different font names.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
+ - name: size
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#size:member
+ package: powerpoint!
+ fullName: size
+ summary: >-
+ Specifies the font size in points (e.g., 11). Returns `null` if the
+ `TextRange` contains text fragments with different font sizes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'size?: boolean;'
+ return:
+ type: boolean
+ - name: smallCaps
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#smallCaps:member
+ package: powerpoint!
+ fullName: smallCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Small
+ Caps** attribute which makes lowercase letters appear as small uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **Small Caps** attribute.
+
+
+ - `false`: None of the text has the **Small Caps** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Small Caps** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'smallCaps?: boolean;'
+ return:
+ type: boolean
+ - name: strikethrough
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#strikethrough:member
+ package: powerpoint!
+ fullName: strikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Strikethrough** attribute.
+
+
+ - `false`: None of the text has the **Strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'strikethrough?: boolean;'
+ return:
+ type: boolean
+ - name: subscript
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#subscript:member
+ package: powerpoint!
+ fullName: subscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Subscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Subscript** attribute.
+
+
+ - `false`: None of the text has the **Subscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Subscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subscript?: boolean;'
+ return:
+ type: boolean
+ - name: superscript
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#superscript:member
+ package: powerpoint!
+ fullName: superscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Superscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Superscript** attribute.
+
+
+ - `false`: None of the text has the **Superscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Superscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'superscript?: boolean;'
+ return:
+ type: boolean
+ - name: underline
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontLoadOptions#underline:member
+ package: powerpoint!
+ fullName: underline
+ summary: >-
+ Specifies the type of underline applied to the font. Returns `null` if the
+ `TextRange` contains text fragments with different underline styles. See
+ [PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'underline?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml
new file mode 100644
index 0000000000..bf51c6fd2b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml
@@ -0,0 +1,329 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeFontUpdateData
+uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeFontUpdateData
+summary: >-
+ An interface for updating data on the `ShapeFont` object, for use in
+ `shapeFont.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: allCaps
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#allCaps:member
+ package: powerpoint!
+ fullName: allCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **All
+ Caps** attribute which makes lowercase letters appear as uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **All Caps** attribute.
+
+
+ - `false`: None of the text has the **All Caps**attribute.
+
+
+ - `null`: Some, but not all, of the text has the **All Caps**
+ attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allCaps?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: bold
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#bold:member
+ package: powerpoint!
+ fullName: bold
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to bold. The possible
+ values are as follows:
+
+
+ - `true`: All the text is bold.
+
+
+ - `false`: None of the text is bold.
+
+
+ - `null`: Returned if some, but not all, of the text is bold.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bold?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the HTML color code representation of the text color (e.g.,
+ "\#FF0000" represents red). Returns `null` if the `TextRange` contains
+ text fragments with different colors.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string | null;'
+ return:
+ type: string | null
+ - name: doubleStrikethrough
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#doubleStrikethrough:member
+ package: powerpoint!
+ fullName: doubleStrikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Double
+ strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Double strikethrough**
+ attribute.
+
+
+ - `false`: None of the text has the **Double strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Double strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'doubleStrikethrough?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: italic
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#italic:member
+ package: powerpoint!
+ fullName: italic
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to italic. The
+ possible values are as follows:
+
+
+ - `true`: All the text is italicized.
+
+
+ - `false`: None of the text is italicized.
+
+
+ - `null`: Returned if some, but not all, of the text is
+ italicized.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'italic?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#name:member
+ package: powerpoint!
+ fullName: name
+ summary: >-
+ Specifies the 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. Returns `null` if the `TextRange` contains text
+ fragments with different font names.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: string | null;'
+ return:
+ type: string | null
+ - name: size
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#size:member
+ package: powerpoint!
+ fullName: size
+ summary: >-
+ Specifies the font size in points (e.g., 11). Returns `null` if the
+ `TextRange` contains text fragments with different font sizes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'size?: number | null;'
+ return:
+ type: number | null
+ - name: smallCaps
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#smallCaps:member
+ package: powerpoint!
+ fullName: smallCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Small
+ Caps** attribute which makes lowercase letters appear as small uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **Small Caps** attribute.
+
+
+ - `false`: None of the text has the **Small Caps** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Small Caps** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'smallCaps?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: strikethrough
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#strikethrough:member
+ package: powerpoint!
+ fullName: strikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Strikethrough** attribute.
+
+
+ - `false`: None of the text has the **Strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'strikethrough?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: subscript
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#subscript:member
+ package: powerpoint!
+ fullName: subscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Subscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Subscript** attribute.
+
+
+ - `false`: None of the text has the **Subscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Subscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subscript?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: superscript
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#superscript:member
+ package: powerpoint!
+ fullName: superscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Superscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Superscript** attribute.
+
+
+ - `false`: None of the text has the **Superscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Superscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'superscript?: boolean | null;'
+ return:
+ type: boolean | null
+ - name: underline
+ uid: powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#underline:member
+ package: powerpoint!
+ fullName: underline
+ summary: >-
+ Specifies the type of underline applied to the font. Returns `null` if the
+ `TextRange` contains text fragments with different underline styles. See
+ [PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" |
+ "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" |
+ "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash"
+ | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
+ return:
+ type: >-
+ |
+ "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" |
+ "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" |
+ "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" |
+ "WavyHeavy" | "WavyDouble" | null
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..9e9a91cdd9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupData
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupData
+summary: >-
+ An interface describing the data returned by calling `shapeGroup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the shape group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
new file mode 100644
index 0000000000..d3e4b4957f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
@@ -0,0 +1,67 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeGroupLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ShapeGroupLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeGroupLoadOptions
+summary: >-
+ Represents a shape group inside a presentation. To get the corresponding Shape
+ object, use `ShapeGroup.shape`.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.ShapeGroupLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.ShapeGroupLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the shape group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: shape
+ uid: powerpoint!PowerPoint.Interfaces.ShapeGroupLoadOptions#shape:member
+ package: powerpoint!
+ fullName: shape
+ summary: Returns the `Shape` object associated with the group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'shape?: PowerPoint.Interfaces.ShapeLoadOptions;'
+ return:
+ type: >-
+
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatdata.yml
new file mode 100644
index 0000000000..915afcab54
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatdata.yml
@@ -0,0 +1,137 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeLineFormatData
+uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeLineFormatData
+summary: >-
+ An interface describing the data returned by calling
+ `shapeLineFormat.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatData#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ - name: dashStyle
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatData#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" |
+ "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" |
+ "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" |
+ "SystemDashDot";
+ return:
+ type: >-
+ | "Dash"
+ | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" |
+ "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot"
+ | "SystemDashDot"
+ - name: style
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatData#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" |
+ "ThickThin" | "ThinThick" | "ThinThin";
+ return:
+ type: >-
+ | "Single" |
+ "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
+ - name: transparency
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatData#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: number;'
+ return:
+ type: number
+ - name: visible
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatData#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
+ - name: weight
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatData#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'weight?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatloadoptions.yml
new file mode 100644
index 0000000000..9468025d9a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatloadoptions.yml
@@ -0,0 +1,146 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeLineFormatLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeLineFormatLoadOptions
+summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: boolean;'
+ return:
+ type: boolean
+ - name: dashStyle
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'dashStyle?: boolean;'
+ return:
+ type: boolean
+ - name: style
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'style?: boolean;'
+ return:
+ type: boolean
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: boolean;'
+ return:
+ type: boolean
+ - name: visible
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
+ - name: weight
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatLoadOptions#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'weight?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatupdatedata.yml
new file mode 100644
index 0000000000..fa81bfb2e8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapelineformatupdatedata.yml
@@ -0,0 +1,139 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeLineFormatUpdateData
+uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeLineFormatUpdateData
+summary: >-
+ An interface for updating data on the `ShapeLineFormat` object, for use in
+ `shapeLineFormat.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ - name: dashStyle
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" |
+ "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" |
+ "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" |
+ "SystemDashDot";
+ return:
+ type: >-
+ | "Dash"
+ | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" |
+ "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot"
+ | "SystemDashDot"
+ - name: style
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" |
+ "ThickThin" | "ThinThick" | "ThinThin";
+ return:
+ type: >-
+ | "Single" |
+ "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: number;'
+ return:
+ type: number
+ - name: visible
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
+ - name: weight
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLineFormatUpdateData#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'weight?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapeloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
new file mode 100644
index 0000000000..ba9d963b14
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
@@ -0,0 +1,318 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeLoadOptions
+summary: Represents a single shape in the slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: fill
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;'
+ return:
+ type: >-
+
+ - name: group
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#group:member
+ package: powerpoint!
+ fullName: group
+ summary: >-
+ Returns the `ShapeGroup` associated with the shape. If the shape type
+ isn't `group`, then this method returns the `GeneralException`
+ error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;'
+ return:
+ type: >-
+
+ - name: height
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: left
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ The distance, in points, from the left side of the shape to the left side
+ of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: boolean;'
+ return:
+ type: boolean
+ - name: level
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#level:member
+ package: powerpoint!
+ fullName: level
+ summary: |-
+ Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'level?: boolean;'
+ return:
+ type: boolean
+ - name: lineFormat
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#lineFormat:member
+ package: powerpoint!
+ fullName: lineFormat
+ summary: Returns the line formatting of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Specifies the name of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
+ - name: parentGroup
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#parentGroup:member
+ package: powerpoint!
+ fullName: parentGroup
+ summary: >-
+ Returns the parent group of this shape. If the shape isn't part of a
+ group, then this method returns the `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;'
+ return:
+ type: >-
+
+ - name: placeholderFormat
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#placeholderFormat:member
+ package: powerpoint!
+ fullName: placeholderFormat
+ summary: >-
+ Returns the properties that apply specifically to this placeholder. If the
+ shape type isn't `placeholder`, then this method returns the
+ `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: textFrame
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#textFrame:member
+ package: powerpoint!
+ fullName: textFrame
+ summary: Returns the text frame object of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;'
+ return:
+ type: >-
+
+ - name: top
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ The distance, in points, from the top edge of the shape to the top edge of
+ the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of this shape. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
+ - name: width
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Specifies the width, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: boolean;'
+ return:
+ type: boolean
+ - name: zOrderPosition
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#zOrderPosition:member
+ package: powerpoint!
+ fullName: zOrderPosition
+ summary: >-
+ Returns the z-order position of the shape, with 0 representing the bottom
+ of the order stack. Every shape on a slide has a unique z-order, but each
+ slide also has a unique z-order stack, so two shapes on separate slides
+ could have the same z-order number.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'zOrderPosition?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectiondata.yml
new file mode 100644
index 0000000000..8d3c802aa0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectiondata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `shapeScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.ShapeData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
new file mode 100644
index 0000000000..a7d0a0e970
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
@@ -0,0 +1,345 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions
+summary: Represents a collection of shapes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: fill
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: >-
+ For EACH ITEM in the collection: Returns the fill formatting of this
+ shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;'
+ return:
+ type: >-
+
+ - name: group
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#group:member
+ package: powerpoint!
+ fullName: group
+ summary: >-
+ For EACH ITEM in the collection: Returns the `ShapeGroup` associated with
+ the shape. If the shape type isn't `group`, then this method
+ returns the `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;'
+ return:
+ type: >-
+
+ - name: height
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: Gets the unique ID of the shape.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: left
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: boolean;'
+ return:
+ type: boolean
+ - name: level
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#level:member
+ package: powerpoint!
+ fullName: level
+ summary: |-
+ For EACH ITEM in the collection: Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'level?: boolean;'
+ return:
+ type: boolean
+ - name: lineFormat
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#lineFormat:member
+ package: powerpoint!
+ fullName: lineFormat
+ summary: >-
+ For EACH ITEM in the collection: Returns the line formatting of this
+ shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: name
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: 'For EACH ITEM in the collection: Specifies the name of this shape.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
+ - name: parentGroup
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#parentGroup:member
+ package: powerpoint!
+ fullName: parentGroup
+ summary: >-
+ For EACH ITEM in the collection: Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the
+ `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;'
+ return:
+ type: >-
+
+ - name: placeholderFormat
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#placeholderFormat:member
+ package: powerpoint!
+ fullName: placeholderFormat
+ summary: >-
+ For EACH ITEM in the collection: Returns the properties that apply
+ specifically to this placeholder. If the shape type isn't
+ `placeholder`, then this method returns the `GeneralException`
+ error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: textFrame
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#textFrame:member
+ package: powerpoint!
+ fullName: textFrame
+ summary: >-
+ For EACH ITEM in the collection: Returns the text frame object of this
+ shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;'
+ return:
+ type: >-
+
+ - name: top
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ For EACH ITEM in the collection: Returns the type of this shape. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
+ - name: width
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: boolean;'
+ return:
+ type: boolean
+ - name: zOrderPosition
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#zOrderPosition:member
+ package: powerpoint!
+ fullName: zOrderPosition
+ summary: >-
+ For EACH ITEM in the collection: Returns the z-order position of the
+ shape, with 0 representing the bottom of the order stack. Every shape on a
+ slide has a unique z-order, but each slide also has a unique z-order
+ stack, so two shapes on separate slides could have the same z-order
+ number.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'zOrderPosition?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..a4a27ceacd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapescopedcollectionupdatedata.yml
@@ -0,0 +1,28 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `ShapeScopedCollection` object, for use
+ in `shapeScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.ShapeData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapeupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapeupdatedata.yml
new file mode 100644
index 0000000000..8ce911c9b7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.shapeupdatedata.yml
@@ -0,0 +1,102 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.ShapeUpdateData
+uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.ShapeUpdateData
+summary: >-
+ An interface for updating data on the `Shape` object, for use in `shape.set({
+ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: height
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: number;'
+ return:
+ type: number
+ - name: left
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ The distance, in points, from the left side of the shape to the left side
+ of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: number;'
+ return:
+ type: number
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Specifies the name of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: string;'
+ return:
+ type: string
+ - name: top
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ The distance, in points, from the top edge of the shape to the top edge of
+ the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: number;'
+ return:
+ type: number
+ - name: width
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Specifies the width, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectiondata.yml
new file mode 100644
index 0000000000..123080b766
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectiondata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideCollectionData
+uid: powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `slideCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.SlideCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
new file mode 100644
index 0000000000..237e66f916
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
@@ -0,0 +1,106 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideCollectionLoadOptions
+summary: Represents the collection of slides in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: Gets the unique ID of the slide.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: index
+ uid: powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions#index:member
+ package: powerpoint!
+ fullName: index
+ summary: >-
+ For EACH ITEM in the collection: Returns the zero-based index of the slide
+ representing its position in the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'index?: boolean;'
+ return:
+ type: boolean
+ - name: layout
+ uid: powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions#layout:member
+ package: powerpoint!
+ fullName: layout
+ summary: 'For EACH ITEM in the collection: Gets the layout of the slide.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;'
+ return:
+ type: >-
+
+ - name: slideMaster
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions#slideMaster:member
+ package: powerpoint!
+ fullName: slideMaster
+ summary: >-
+ For EACH ITEM in the collection: Gets the `SlideMaster` object that
+ represents the slide's default content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;'
+ return:
+ type: >-
+
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectionupdatedata.yml
new file mode 100644
index 0000000000..e82c136e72
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidecollectionupdatedata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideCollectionUpdateData
+summary: >-
+ An interface for updating data on the `SlideCollection` object, for use in
+ `slideCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidedata.yml
new file mode 100644
index 0000000000..6f16449fa8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidedata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideData
+uid: powerpoint!PowerPoint.Interfaces.SlideData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideData
+summary: An interface describing the data returned by calling `slide.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.SlideData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
+ - name: index
+ uid: powerpoint!PowerPoint.Interfaces.SlideData#index:member
+ package: powerpoint!
+ fullName: index
+ summary: >-
+ Returns the zero-based index of the slide representing its position in the
+ presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'index?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectiondata.yml
new file mode 100644
index 0000000000..774bd02414
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutCollectionData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideLayoutData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
new file mode 100644
index 0000000000..1d8a52c93b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
@@ -0,0 +1,83 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions
+summary: Represents the collection of layouts provided by the Slide Master for slides.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: Gets the unique ID of the slide layout.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: name
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: 'For EACH ITEM in the collection: Gets the name of the slide layout.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: 'For EACH ITEM in the collection: Returns the type of the slide layout.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectionupdatedata.yml
new file mode 100644
index 0000000000..bb4fba6d0b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutCollectionUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutCollection` object, for use
+ in `slideLayoutCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideLayoutData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutdata.yml
new file mode 100644
index 0000000000..d7092360b4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutdata.yml
@@ -0,0 +1,84 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayout.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutData#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Gets the name of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: string;'
+ return:
+ type: string
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Returns the type of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" |
+ "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" |
+ "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" |
+ "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" |
+ "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" |
+ "PictureWithCaption" | "SectionHeader" | "Table" | "Text" |
+ "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject"
+ | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" |
+ "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" |
+ "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" |
+ "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
+ return:
+ type: >-
+ | "Blank" |
+ "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText"
+ | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" |
+ "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" |
+ "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" |
+ "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table"
+ | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" |
+ "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" |
+ "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" |
+ "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" |
+ "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
new file mode 100644
index 0000000000..5b7ef53a54
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
@@ -0,0 +1,79 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutLoadOptions
+summary: Represents the layout of a slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Gets the name of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Returns the type of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slideloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slideloadoptions.yml
new file mode 100644
index 0000000000..9003b3af6a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slideloadoptions.yml
@@ -0,0 +1,103 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLoadOptions
+summary: Represents a single slide of a presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.SlideLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.SlideLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: index
+ uid: powerpoint!PowerPoint.Interfaces.SlideLoadOptions#index:member
+ package: powerpoint!
+ fullName: index
+ summary: >-
+ Returns the zero-based index of the slide representing its position in the
+ presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'index?: boolean;'
+ return:
+ type: boolean
+ - name: layout
+ uid: powerpoint!PowerPoint.Interfaces.SlideLoadOptions#layout:member
+ package: powerpoint!
+ fullName: layout
+ summary: Gets the layout of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;'
+ return:
+ type: >-
+
+ - name: slideMaster
+ uid: powerpoint!PowerPoint.Interfaces.SlideLoadOptions#slideMaster:member
+ package: powerpoint!
+ fullName: slideMaster
+ summary: Gets the `SlideMaster` object that represents the slide's default content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;'
+ return:
+ type: >-
+
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectiondata.yml
new file mode 100644
index 0000000000..624d1771ea
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterCollectionData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideMasterData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml
new file mode 100644
index 0000000000..7ca8b6ea07
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml
@@ -0,0 +1,66 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterCollectionLoadOptions
+summary: Represents the collection of Slide Masters in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: Gets the unique ID of the Slide Master.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: name
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: 'For EACH ITEM in the collection: Gets the unique name of the Slide Master.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectionupdatedata.yml
new file mode 100644
index 0000000000..75b7ce0412
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemastercollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterCollectionUpdateData
+summary: >-
+ An interface for updating data on the `SlideMasterCollection` object, for use
+ in `slideMasterCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideMasterData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterdata.yml
new file mode 100644
index 0000000000..a6215ea3da
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterdata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMaster.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.SlideMasterData#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: string;'
+ return:
+ type: string
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.SlideMasterData#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Gets the unique name of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml
new file mode 100644
index 0000000000..b0e964a7ff
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml
@@ -0,0 +1,63 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterLoadOptions
+summary: Represents the Slide Master of a slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: name
+ uid: powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Gets the unique name of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectiondata.yml
new file mode 100644
index 0000000000..f06097ffae
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectiondata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `slideScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.SlideScopedCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
new file mode 100644
index 0000000000..10c8984510
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
@@ -0,0 +1,110 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions
+summary: Represents a collection of slides in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: id
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions#id:member
+ package: powerpoint!
+ fullName: id
+ summary: 'For EACH ITEM in the collection: Gets the unique ID of the slide.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'id?: boolean;'
+ return:
+ type: boolean
+ - name: index
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions#index:member
+ package: powerpoint!
+ fullName: index
+ summary: >-
+ For EACH ITEM in the collection: Returns the zero-based index of the slide
+ representing its position in the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'index?: boolean;'
+ return:
+ type: boolean
+ - name: layout
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions#layout:member
+ package: powerpoint!
+ fullName: layout
+ summary: 'For EACH ITEM in the collection: Gets the layout of the slide.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;'
+ return:
+ type: >-
+
+ - name: slideMaster
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions#slideMaster:member
+ package: powerpoint!
+ fullName: slideMaster
+ summary: >-
+ For EACH ITEM in the collection: Gets the `SlideMaster` object that
+ represents the slide's default content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;'
+ return:
+ type: >-
+
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..90e6b89c68
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidescopedcollectionupdatedata.yml
@@ -0,0 +1,28 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `SlideScopedCollection` object, for use
+ in `slideScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideScopedCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.SlideData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableCellCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml
new file mode 100644
index 0000000000..8efd219d45
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml
@@ -0,0 +1,127 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionLoadOptions
+summary: Represents a collection of table cells.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: columnCount
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: >-
+ For EACH ITEM in the collection: Gets the number of table columns this
+ cell spans across. Will be greater than or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnCount?: boolean;'
+ return:
+ type: boolean
+ - name: columnIndex
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: >-
+ For EACH ITEM in the collection: Gets the zero-based column index of the
+ cell within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnIndex?: boolean;'
+ return:
+ type: boolean
+ - name: rowCount
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: >-
+ For EACH ITEM in the collection: Gets the number of table rows this cell
+ spans across. Will be greater than or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowCount?: boolean;'
+ return:
+ type: boolean
+ - name: rowIndex
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: >-
+ For EACH ITEM in the collection: Gets the zero-based row index of the cell
+ within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowIndex?: boolean;'
+ return:
+ type: boolean
+ - name: text
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#text:member
+ package: powerpoint!
+ fullName: text
+ summary: >-
+ For EACH ITEM in the collection: Specifies the text content of the table
+ cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableCellCollection` object, for use in
+ `tableCellCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableCellData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..92f5ac202f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,98 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellData
+uid: powerpoint!PowerPoint.Interfaces.TableCellData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellData
+summary: >-
+ An interface describing the data returned by calling `tableCell.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: columnCount
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: >-
+ Gets the number of table columns this cell spans across. Will be greater
+ than or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnCount?: number;'
+ return:
+ type: number
+ - name: columnIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: Gets the zero-based column index of the cell within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnIndex?: number;'
+ return:
+ type: number
+ - name: rowCount
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: >-
+ Gets the number of table rows this cell spans across. Will be greater than
+ or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowCount?: number;'
+ return:
+ type: number
+ - name: rowIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: Gets the zero-based row index of the cell within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowIndex?: number;'
+ return:
+ type: number
+ - name: text
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Specifies the text content of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml
new file mode 100644
index 0000000000..b13acb7a9e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml
@@ -0,0 +1,115 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellLoadOptions
+summary: Represents a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: columnCount
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: >-
+ Gets the number of table columns this cell spans across. Will be greater
+ than or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnCount?: boolean;'
+ return:
+ type: boolean
+ - name: columnIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: Gets the zero-based column index of the cell within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnIndex?: boolean;'
+ return:
+ type: boolean
+ - name: rowCount
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: >-
+ Gets the number of table rows this cell spans across. Will be greater than
+ or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowCount?: boolean;'
+ return:
+ type: boolean
+ - name: rowIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: Gets the zero-based row index of the cell within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowIndex?: boolean;'
+ return:
+ type: boolean
+ - name: text
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Specifies the text content of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..ea50d49efc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableCellUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableCellUpdateData
+summary: >-
+ An interface for updating data on the `TableCell` object, for use in
+ `tableCell.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: text
+ uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Specifies the text content of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..0cb2e59f2f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tabledata.yml
@@ -0,0 +1,60 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableData
+uid: powerpoint!PowerPoint.Interfaces.TableData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableData
+summary: An interface describing the data returned by calling `table.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: columnCount
+ uid: powerpoint!PowerPoint.Interfaces.TableData#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: Gets the number of columns in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnCount?: number;'
+ return:
+ type: number
+ - name: rowCount
+ uid: powerpoint!PowerPoint.Interfaces.TableData#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: Gets the number of rows in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowCount?: number;'
+ return:
+ type: number
+ - name: values
+ uid: powerpoint!PowerPoint.Interfaces.TableData#values:member
+ package: powerpoint!
+ fullName: values
+ summary: Gets all of the values in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'values?: string[][];'
+ return:
+ type: string[][]
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tableloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tableloadoptions.yml
new file mode 100644
index 0000000000..1684785ef5
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tableloadoptions.yml
@@ -0,0 +1,79 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableLoadOptions
+summary: Represents a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TableLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: columnCount
+ uid: powerpoint!PowerPoint.Interfaces.TableLoadOptions#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: Gets the number of columns in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnCount?: boolean;'
+ return:
+ type: boolean
+ - name: rowCount
+ uid: powerpoint!PowerPoint.Interfaces.TableLoadOptions#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: Gets the number of rows in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowCount?: boolean;'
+ return:
+ type: boolean
+ - name: values
+ uid: powerpoint!PowerPoint.Interfaces.TableLoadOptions#values:member
+ package: powerpoint!
+ fullName: values
+ summary: Gets all of the values in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'values?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectiondata.yml
new file mode 100644
index 0000000000..0be0228d2c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectiondata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TagCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TagCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TagCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tagCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TagCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TagData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectionloadoptions.yml
new file mode 100644
index 0000000000..e111b6f9a7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectionloadoptions.yml
@@ -0,0 +1,66 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TagCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TagCollectionLoadOptions
+summary: Represents the collection of tags.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: key
+ uid: powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions#key:member
+ package: powerpoint!
+ fullName: key
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'key?: boolean;'
+ return:
+ type: boolean
+ - name: value
+ uid: powerpoint!PowerPoint.Interfaces.TagCollectionLoadOptions#value:member
+ package: powerpoint!
+ fullName: value
+ summary: 'For EACH ITEM in the collection: Gets the value of the tag.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectionupdatedata.yml
new file mode 100644
index 0000000000..9d01dd8250
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagcollectionupdatedata.yml
@@ -0,0 +1,27 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TagCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TagCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TagCollection` object, for use in
+ `tagCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TagCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TagData[];'
+ return:
+ type: []
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagdata.yml
new file mode 100644
index 0000000000..2501ae228d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagdata.yml
@@ -0,0 +1,47 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TagData
+uid: powerpoint!PowerPoint.Interfaces.TagData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TagData
+summary: An interface describing the data returned by calling `tag.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: key
+ uid: powerpoint!PowerPoint.Interfaces.TagData#key:member
+ package: powerpoint!
+ fullName: key
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'key?: string;'
+ return:
+ type: string
+ - name: value
+ uid: powerpoint!PowerPoint.Interfaces.TagData#value:member
+ package: powerpoint!
+ fullName: value
+ summary: Gets the value of the tag.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagloadoptions.yml
new file mode 100644
index 0000000000..85f9d447f3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagloadoptions.yml
@@ -0,0 +1,66 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TagLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TagLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TagLoadOptions
+summary: Represents a single tag in the slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TagLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: key
+ uid: powerpoint!PowerPoint.Interfaces.TagLoadOptions#key:member
+ package: powerpoint!
+ fullName: key
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'key?: boolean;'
+ return:
+ type: boolean
+ - name: value
+ uid: powerpoint!PowerPoint.Interfaces.TagLoadOptions#value:member
+ package: powerpoint!
+ fullName: value
+ summary: Gets the value of the tag.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagupdatedata.yml
new file mode 100644
index 0000000000..74a848caad
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.tagupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TagUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TagUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TagUpdateData
+summary: >-
+ An interface for updating data on the `Tag` object, for use in `tag.set({ ...
+ })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: value
+ uid: powerpoint!PowerPoint.Interfaces.TagUpdateData#value:member
+ package: powerpoint!
+ fullName: value
+ summary: Gets the value of the tag.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframedata.yml
new file mode 100644
index 0000000000..f8a3552e9b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframedata.yml
@@ -0,0 +1,158 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TextFrameData
+uid: powerpoint!PowerPoint.Interfaces.TextFrameData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TextFrameData
+summary: >-
+ An interface describing the data returned by calling `textFrame.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: autoSizeSetting
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#autoSizeSetting:member
+ package: powerpoint!
+ fullName: autoSizeSetting
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" |
+ "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
+ return:
+ type: >-
+ |
+ "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" |
+ "AutoSizeMixed"
+ - name: bottomMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#bottomMargin:member
+ package: powerpoint!
+ fullName: bottomMargin
+ summary: Represents the bottom margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottomMargin?: number;'
+ return:
+ type: number
+ - name: hasText
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#hasText:member
+ package: powerpoint!
+ fullName: hasText
+ summary: Specifies if the text frame contains text.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'hasText?: boolean;'
+ return:
+ type: boolean
+ - name: leftMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#leftMargin:member
+ package: powerpoint!
+ fullName: leftMargin
+ summary: Represents the left margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'leftMargin?: number;'
+ return:
+ type: number
+ - name: rightMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#rightMargin:member
+ package: powerpoint!
+ fullName: rightMargin
+ summary: Represents the right margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rightMargin?: number;'
+ return:
+ type: number
+ - name: topMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#topMargin:member
+ package: powerpoint!
+ fullName: topMargin
+ summary: Represents the top margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'topMargin?: number;'
+ return:
+ type: number
+ - name: verticalAlignment
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: >-
+ Represents the vertical alignment of the text frame. See
+ [PowerPoint.TextVerticalAlignment](xref:powerpoint!PowerPoint.TextVerticalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle"
+ | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ return:
+ type: >-
+ |
+ "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" |
+ "BottomCentered"
+ - name: wordWrap
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameData#wordWrap:member
+ package: powerpoint!
+ fullName: wordWrap
+ summary: Determines whether lines break automatically to fit text inside the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'wordWrap?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframeloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframeloadoptions.yml
new file mode 100644
index 0000000000..e49ad3db77
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframeloadoptions.yml
@@ -0,0 +1,190 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TextFrameLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TextFrameLoadOptions
+summary: Represents the text frame of a shape object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: autoSizeSetting
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#autoSizeSetting:member
+ package: powerpoint!
+ fullName: autoSizeSetting
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'autoSizeSetting?: boolean;'
+ return:
+ type: boolean
+ - name: bottomMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#bottomMargin:member
+ package: powerpoint!
+ fullName: bottomMargin
+ summary: Represents the bottom margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottomMargin?: boolean;'
+ return:
+ type: boolean
+ - name: hasText
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#hasText:member
+ package: powerpoint!
+ fullName: hasText
+ summary: Specifies if the text frame contains text.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'hasText?: boolean;'
+ return:
+ type: boolean
+ - name: leftMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#leftMargin:member
+ package: powerpoint!
+ fullName: leftMargin
+ summary: Represents the left margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'leftMargin?: boolean;'
+ return:
+ type: boolean
+ - name: rightMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#rightMargin:member
+ package: powerpoint!
+ fullName: rightMargin
+ summary: Represents the right margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rightMargin?: boolean;'
+ return:
+ type: boolean
+ - name: textRange
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#textRange:member
+ package: powerpoint!
+ fullName: textRange
+ summary: >-
+ Represents the text that is attached to a shape in the text frame, and
+ properties and methods for manipulating the text. See
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class) for
+ details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textRange?: PowerPoint.Interfaces.TextRangeLoadOptions;'
+ return:
+ type: >-
+
+ - name: topMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#topMargin:member
+ package: powerpoint!
+ fullName: topMargin
+ summary: Represents the top margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'topMargin?: boolean;'
+ return:
+ type: boolean
+ - name: verticalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: >-
+ Represents the vertical alignment of the text frame. See
+ [PowerPoint.TextVerticalAlignment](xref:powerpoint!PowerPoint.TextVerticalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'verticalAlignment?: boolean;'
+ return:
+ type: boolean
+ - name: wordWrap
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions#wordWrap:member
+ package: powerpoint!
+ fullName: wordWrap
+ summary: Determines whether lines break automatically to fit text inside the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'wordWrap?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframeupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframeupdatedata.yml
new file mode 100644
index 0000000000..aa9601744f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textframeupdatedata.yml
@@ -0,0 +1,144 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TextFrameUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TextFrameUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TextFrameUpdateData
+summary: >-
+ An interface for updating data on the `TextFrame` object, for use in
+ `textFrame.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: autoSizeSetting
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TextFrameUpdateData#autoSizeSetting:member
+ package: powerpoint!
+ fullName: autoSizeSetting
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" |
+ "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
+ return:
+ type: >-
+ |
+ "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" |
+ "AutoSizeMixed"
+ - name: bottomMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameUpdateData#bottomMargin:member
+ package: powerpoint!
+ fullName: bottomMargin
+ summary: Represents the bottom margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottomMargin?: number;'
+ return:
+ type: number
+ - name: leftMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameUpdateData#leftMargin:member
+ package: powerpoint!
+ fullName: leftMargin
+ summary: Represents the left margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'leftMargin?: number;'
+ return:
+ type: number
+ - name: rightMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameUpdateData#rightMargin:member
+ package: powerpoint!
+ fullName: rightMargin
+ summary: Represents the right margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rightMargin?: number;'
+ return:
+ type: number
+ - name: topMargin
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameUpdateData#topMargin:member
+ package: powerpoint!
+ fullName: topMargin
+ summary: Represents the top margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'topMargin?: number;'
+ return:
+ type: number
+ - name: verticalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TextFrameUpdateData#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: >-
+ Represents the vertical alignment of the text frame. See
+ [PowerPoint.TextVerticalAlignment](xref:powerpoint!PowerPoint.TextVerticalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle"
+ | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ return:
+ type: >-
+ |
+ "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" |
+ "BottomCentered"
+ - name: wordWrap
+ uid: powerpoint!PowerPoint.Interfaces.TextFrameUpdateData#wordWrap:member
+ package: powerpoint!
+ fullName: wordWrap
+ summary: Determines whether lines break automatically to fit text inside the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'wordWrap?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangedata.yml
new file mode 100644
index 0000000000..88541a58dd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangedata.yml
@@ -0,0 +1,70 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TextRangeData
+uid: powerpoint!PowerPoint.Interfaces.TextRangeData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TextRangeData
+summary: >-
+ An interface describing the data returned by calling `textRange.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: length
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeData#length:member
+ package: powerpoint!
+ fullName: length
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'length?: number;'
+ return:
+ type: number
+ - name: start
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeData#start:member
+ package: powerpoint!
+ fullName: start
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'start?: number;'
+ return:
+ type: number
+ - name: text
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeData#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Represents the plain text content of the text range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangeloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangeloadoptions.yml
new file mode 100644
index 0000000000..05d4757ef9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangeloadoptions.yml
@@ -0,0 +1,133 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TextRangeLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TextRangeLoadOptions
+summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions#$all:member
+ package: powerpoint!
+ fullName: $all
+ summary: >-
+ 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`).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: '$all?: boolean;'
+ return:
+ type: boolean
+ - name: font
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions#font:member
+ package: powerpoint!
+ fullName: font
+ summary: >-
+ Returns a `ShapeFont` object that represents the font attributes for the
+ text range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'font?: PowerPoint.Interfaces.ShapeFontLoadOptions;'
+ return:
+ type: >-
+
+ - name: length
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions#length:member
+ package: powerpoint!
+ fullName: length
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'length?: boolean;'
+ return:
+ type: boolean
+ - name: paragraphFormat
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions#paragraphFormat:member
+ package: powerpoint!
+ fullName: paragraphFormat
+ summary: >-
+ Represents the paragraph format of the text range. See
+ [PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'paragraphFormat?: PowerPoint.Interfaces.ParagraphFormatLoadOptions;'
+ return:
+ type: >-
+
+ - name: start
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions#start:member
+ package: powerpoint!
+ fullName: start
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'start?: boolean;'
+ return:
+ type: boolean
+ - name: text
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeLoadOptions#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Represents the plain text content of the text range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangeupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangeupdatedata.yml
new file mode 100644
index 0000000000..8ae6d7ac85
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.textrangeupdatedata.yml
@@ -0,0 +1,70 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TextRangeUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TextRangeUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TextRangeUpdateData
+summary: >-
+ An interface for updating data on the `TextRange` object, for use in
+ `textRange.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: length
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeUpdateData#length:member
+ package: powerpoint!
+ fullName: length
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'length?: number;'
+ return:
+ type: number
+ - name: start
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeUpdateData#start:member
+ package: powerpoint!
+ fullName: start
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'start?: number;'
+ return:
+ type: number
+ - name: text
+ uid: powerpoint!PowerPoint.Interfaces.TextRangeUpdateData#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Represents the plain text content of the text range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.paragraphformat.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.paragraphformat.yml
new file mode 100644
index 0000000000..554da4b88d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.paragraphformat.yml
@@ -0,0 +1,185 @@
+### YamlMime:TSType
+name: PowerPoint.ParagraphFormat
+uid: powerpoint!PowerPoint.ParagraphFormat:class
+package: powerpoint!
+fullName: PowerPoint.ParagraphFormat
+summary: >-
+ Represents the paragraph formatting properties of a text that is attached to
+ the [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: bulletFormat
+ uid: powerpoint!PowerPoint.ParagraphFormat#bulletFormat:member
+ package: powerpoint!
+ fullName: bulletFormat
+ summary: >-
+ Represents the bullet format of the paragraph. See
+ [PowerPoint.BulletFormat](xref:powerpoint!PowerPoint.BulletFormat:class)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly bulletFormat: PowerPoint.BulletFormat;'
+ return:
+ type:
+ - name: context
+ uid: powerpoint!PowerPoint.ParagraphFormat#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: horizontalAlignment
+ uid: powerpoint!PowerPoint.ParagraphFormat#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Represents the horizontal alignment of the paragraph. Returns 'null' if
+ the 'TextRange' includes text fragments with different horizontal
+ alignment values. See
+ [PowerPoint.ParagraphHorizontalAlignment](xref:powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" |
+ "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" |
+ "ThaiDistributed";
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed"
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.ParagraphFormat#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions):
+ PowerPoint.ParagraphFormat;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.ParagraphFormat#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.ParagraphFormat#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.ParagraphFormat;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ParagraphFormat#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ParagraphFormatData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.paragraphhorizontalalignment.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.paragraphhorizontalalignment.yml
new file mode 100644
index 0000000000..a4817df8d6
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.paragraphhorizontalalignment.yml
@@ -0,0 +1,95 @@
+### YamlMime:TSEnum
+name: PowerPoint.ParagraphHorizontalAlignment
+uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum
+package: powerpoint!
+fullName: PowerPoint.ParagraphHorizontalAlignment
+summary: >-
+ Represents the horizontal alignment of the
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) in a
+ [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: center
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment.center:member
+ package: powerpoint!
+ summary: >-
+ Align text in the center.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Center"'
+ - name: distributed
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment.distributed:member
+ package: powerpoint!
+ summary: >-
+ Distributes the text words across an entire text line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Distributed"'
+ - name: justify
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment.justify:member
+ package: powerpoint!
+ summary: >-
+ Align text so that it is justified across the whole line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Justify"'
+ - name: justifyLow
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment.justifyLow:member
+ package: powerpoint!
+ summary: >-
+ Specifies the alignment or adjustment of kashida length in Arabic text.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"JustifyLow"'
+ - name: left
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment.left:member
+ package: powerpoint!
+ summary: >-
+ Align text to the left margin.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Left"'
+ - name: right
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment.right:member
+ package: powerpoint!
+ summary: >-
+ Align text to the right margin.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Right"'
+ - name: thaiDistributed
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment.thaiDistributed:member
+ package: powerpoint!
+ summary: >-
+ Distributes Thai text specially, because each character is treated as a
+ word.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThaiDistributed"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.placeholderformat.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.placeholderformat.yml
new file mode 100644
index 0000000000..b77f78b35e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.placeholderformat.yml
@@ -0,0 +1,193 @@
+### YamlMime:TSType
+name: PowerPoint.PlaceholderFormat
+uid: powerpoint!PowerPoint.PlaceholderFormat:class
+package: powerpoint!
+fullName: PowerPoint.PlaceholderFormat
+summary: Represents the properties of a `placeholder` shape.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: containedType
+ uid: powerpoint!PowerPoint.PlaceholderFormat#containedType:member
+ package: powerpoint!
+ fullName: containedType
+ summary: >-
+ Gets the type of the shape contained within the placeholder. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details. Returns `null` if the placeholder is empty.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" |
+ "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" |
+ "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" |
+ "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
+ return:
+ type: >-
+ | "Unsupported" |
+ "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" |
+ "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" |
+ "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" |
+ null
+ - name: context
+ uid: powerpoint!PowerPoint.PlaceholderFormat#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: type
+ uid: powerpoint!PowerPoint.PlaceholderFormat#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of this placeholder. See
+ [PowerPoint.PlaceholderType](xref:powerpoint!PowerPoint.PlaceholderType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" |
+ "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" |
+ "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" |
+ "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" |
+ "Picture" | "Cameo";
+ return:
+ type: >-
+ |
+ "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title"
+ | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" |
+ "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" |
+ "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.PlaceholderFormat#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions):
+ PowerPoint.PlaceholderFormat;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.PlaceholderFormat#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.PlaceholderFormat#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.PlaceholderFormat;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.PlaceholderFormat#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.PlaceholderFormatData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.placeholdertype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.placeholdertype.yml
new file mode 100644
index 0000000000..3e35b531c1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.placeholdertype.yml
@@ -0,0 +1,234 @@
+### YamlMime:TSEnum
+name: PowerPoint.PlaceholderType
+uid: powerpoint!PowerPoint.PlaceholderType:enum
+package: powerpoint!
+fullName: PowerPoint.PlaceholderType
+summary: Specifies the type of a placeholder.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: body
+ uid: powerpoint!PowerPoint.PlaceholderType.body:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a body.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Body"'
+ - name: cameo
+ uid: powerpoint!PowerPoint.PlaceholderType.cameo:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a cameo.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Cameo"'
+ - name: centerTitle
+ uid: powerpoint!PowerPoint.PlaceholderType.centerTitle:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a center title.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CenterTitle"'
+ - name: chart
+ uid: powerpoint!PowerPoint.PlaceholderType.chart:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a chart.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Chart"'
+ - name: content
+ uid: powerpoint!PowerPoint.PlaceholderType.content:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for generic content.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Content"'
+ - name: date
+ uid: powerpoint!PowerPoint.PlaceholderType.date:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a date.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Date"'
+ - name: footer
+ uid: powerpoint!PowerPoint.PlaceholderType.footer:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a footer.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Footer"'
+ - name: header
+ uid: powerpoint!PowerPoint.PlaceholderType.header:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a header.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Header"'
+ - name: media
+ uid: powerpoint!PowerPoint.PlaceholderType.media:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for media.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Media"'
+ - name: onlinePicture
+ uid: powerpoint!PowerPoint.PlaceholderType.onlinePicture:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for an online picture.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"OnlinePicture"'
+ - name: picture
+ uid: powerpoint!PowerPoint.PlaceholderType.picture:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a picture.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Picture"'
+ - name: slideNumber
+ uid: powerpoint!PowerPoint.PlaceholderType.slideNumber:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a slide number.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SlideNumber"'
+ - name: smartArt
+ uid: powerpoint!PowerPoint.PlaceholderType.smartArt:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a SmartArt.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SmartArt"'
+ - name: subtitle
+ uid: powerpoint!PowerPoint.PlaceholderType.subtitle:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a subtitle.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Subtitle"'
+ - name: table
+ uid: powerpoint!PowerPoint.PlaceholderType.table:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a table.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Table"'
+ - name: title
+ uid: powerpoint!PowerPoint.PlaceholderType.title:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a title.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Title"'
+ - name: unsupported
+ uid: powerpoint!PowerPoint.PlaceholderType.unsupported:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is unsupported.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unsupported"'
+ - name: verticalBody
+ uid: powerpoint!PowerPoint.PlaceholderType.verticalBody:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a vertical body.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"VerticalBody"'
+ - name: verticalContent
+ uid: powerpoint!PowerPoint.PlaceholderType.verticalContent:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for generic vertical content.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"VerticalContent"'
+ - name: verticalTitle
+ uid: powerpoint!PowerPoint.PlaceholderType.verticalTitle:member
+ package: powerpoint!
+ summary: >-
+ The placeholder is for a vertical title.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"VerticalTitle"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.presentation.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.presentation.yml
new file mode 100644
index 0000000000..8186963ce0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.presentation.yml
@@ -0,0 +1,732 @@
+### YamlMime:TSType
+name: PowerPoint.Presentation
+uid: powerpoint!PowerPoint.Presentation:class
+package: powerpoint!
+fullName: PowerPoint.Presentation
+summary: ''
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.0](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/insert-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Get the ID of the first selected slide.
+ const presentation: PowerPoint.Presentation = context.presentation;
+ const selected: PowerPoint.Slide = presentation.getSelectedSlides().getItemAt(0);
+ selected.load("id");
+ await context.sync();
+
+ // Insert the other presentation after the selected slide.
+ const insertOptions: PowerPoint.InsertSlideOptions = {
+ formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
+ targetSlideId: selected.id
+ };
+ presentation.insertSlidesFromBase64(chosenFileBase64, insertOptions);
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: bindings
+ uid: powerpoint!PowerPoint.Presentation#bindings:member
+ package: powerpoint!
+ fullName: bindings
+ summary: >-
+ Returns a collection of bindings that are associated with the
+ presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly bindings: PowerPoint.BindingCollection;'
+ return:
+ type:
+ - name: context
+ uid: powerpoint!PowerPoint.Presentation#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: customXmlParts
+ uid: powerpoint!PowerPoint.Presentation#customXmlParts:member
+ package: powerpoint!
+ fullName: customXmlParts
+ summary: >-
+ Returns a collection of custom XML parts that are associated with the
+ presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly customXmlParts: PowerPoint.CustomXmlPartCollection;'
+ return:
+ type:
+ - name: id
+ uid: powerpoint!PowerPoint.Presentation#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the ID of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: properties
+ uid: powerpoint!PowerPoint.Presentation#properties:member
+ package: powerpoint!
+ fullName: properties
+ summary: Gets the properties of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly properties: PowerPoint.DocumentProperties;'
+ return:
+ type:
+ - name: slideMasters
+ uid: powerpoint!PowerPoint.Presentation#slideMasters:member
+ package: powerpoint!
+ fullName: slideMasters
+ summary: >-
+ Returns the collection of `SlideMaster` objects that are in the
+ presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly slideMasters: PowerPoint.SlideMasterCollection;'
+ return:
+ type:
+ - name: slides
+ uid: powerpoint!PowerPoint.Presentation#slides:member
+ package: powerpoint!
+ fullName: slides
+ summary: Returns an ordered collection of slides in the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly slides: PowerPoint.SlideCollection;'
+ return:
+ type:
+ - name: tags
+ uid: powerpoint!PowerPoint.Presentation#tags:member
+ package: powerpoint!
+ fullName: tags
+ summary: Returns a collection of tags attached to the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly tags: PowerPoint.TagCollection;'
+ return:
+ type:
+ - name: title
+ uid: powerpoint!PowerPoint.Presentation#title:member
+ package: powerpoint!
+ fullName: title
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly title: string;'
+ return:
+ type: string
+methods:
+ - name: getSelectedShapes()
+ uid: powerpoint!PowerPoint.Presentation#getSelectedShapes:member(1)
+ package: powerpoint!
+ fullName: getSelectedShapes()
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Arranges the selected shapes in a line from left to right.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ let maxHeight = 0;
+ shapes.items.map((shape) => {
+ shape.load("width,height");
+ });
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.left = currentLeft;
+ shape.top = currentTop;
+ currentLeft += shape.width;
+ if (shape.height > maxHeight) maxHeight = shape.height;
+ });
+ await context.sync();
+ currentLeft = 0;
+ if (currentTop > slideHeight - 200) currentTop = 0;
+ });
+
+
+ ...
+
+
+ // Gets the shapes you selected on the slide and displays their IDs on the
+ task pane.
+
+ await PowerPoint.run(async (context) => {
+ let finalTable = "";
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ await context.sync();
+ finalTable += "
getSelectedShapes.getCount returned:" + shapeCount.value + "
";
+ finalTable +=
+ "
Index | Id |
";
+ shapes.load("items");
+ await context.sync();
+ shapes.items.map((shape, index) => {
+ finalTable += "" + index + " | " + shape.id + " |
";
+ });
+ finalTable += "
";
+ const outputSpan = document.getElementById("outputSpan");
+ outputSpan.innerHTML = "";
+ outputSpan.innerHTML += finalTable;
+ });
+
+
+ ...
+
+
+ // Saves which shapes are selected so that they can be reselected later.
+
+ await PowerPoint.run(async (context) => {
+ context.presentation.load("slides");
+ await context.sync();
+ const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
+ const slideCount = slides.getCount();
+ slides.load("items");
+ await context.sync();
+ savedSlideSelection = [];
+ slides.items.map((slide) => {
+ savedSlideSelection.push(slide.id);
+ });
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ shapes.items.map((shape) => {
+ savedShapeSelection.push(shape.id);
+ });
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSelectedShapes(): PowerPoint.ShapeScopedCollection;'
+ return:
+ type:
+ description: ''
+ - name: getSelectedSlides()
+ uid: powerpoint!PowerPoint.Presentation#getSelectedSlides:member(1)
+ package: powerpoint!
+ fullName: getSelectedSlides()
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml
+
+
+ // Gets the selected slides and displays their IDs on the task pane.
+
+ await PowerPoint.run(async (context) => {
+ let finalTable = "";
+ context.presentation.load("slides");
+ await context.sync();
+ const allSlidesList = {};
+ const allSlidesCount = context.presentation.slides.getCount();
+ context.presentation.slides.load("items");
+ await context.sync();
+ let allSlideItems: PowerPoint.Slide[] = context.presentation.slides.items;
+ allSlideItems.map((slide, index) => {
+ allSlidesList[slide.id] = `Slide ${index + 1}`;
+ });
+
+ const checkbox = document.getElementById("id-check-usenative") as HTMLInputElement;
+ if (checkbox && checkbox.checked) {
+ context.presentation.load("tags");
+ }
+
+ const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
+ const slideCount = slides.getCount();
+ slides.load("items");
+ await context.sync();
+ finalTable += "
getSelectedSlides.getCount returned:" + slideCount.value + "
";
+ finalTable +=
+ "
Index | Id |
";
+ slides.items.map((slide, index) => {
+ finalTable += "" + index + " - " + allSlidesList[slide.id] + " | " + slide.id + " |
";
+ });
+ finalTable += "
";
+ const outputSpan = document.getElementById("outputSpan");
+ outputSpan.innerHTML = ""
+ outputSpan.innerHTML += finalTable;
+ });
+
+
+ ...
+
+
+ // Saves which slides are currently selected so they can be reselected
+ later.
+
+ await PowerPoint.run(async (context) => {
+ let finalTable = "";
+ context.presentation.load("slides");
+ await context.sync();
+ const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
+ const slideCount = slides.getCount();
+ await context.sync();
+ finalTable += "
getSelectedSlides.getCount returned:" + slideCount.value + "
";
+ finalTable +=
+ "
Index | Id |
";
+ savedSlideSelection = [];
+ slides.load("items");
+ await context.sync();
+ slides.items.map((slide, index) => {
+ finalTable += "" + index + " | " + slide.id + " |
";
+ savedSlideSelection.push(slide.id);
+ });
+ finalTable += "
";
+ const outputSpan = document.getElementById("outputSpan");
+ outputSpan.innerHTML = ""
+ outputSpan.innerHTML += finalTable;
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSelectedSlides(): PowerPoint.SlideScopedCollection;'
+ return:
+ type:
+ description: ''
+ - name: getSelectedTextRange()
+ uid: powerpoint!PowerPoint.Presentation#getSelectedTextRange:member(1)
+ package: powerpoint!
+ fullName: getSelectedTextRange()
+ summary: >-
+ Returns the selected
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class) in the
+ current view of the presentation. Throws an exception if no text is
+ selected.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Gets the selected text range and prints data about the range on the
+ task pane.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ try {
+ await context.sync();
+ } catch (error) {
+ console.warn("You must select only one range of text for this action to work.");
+ return;
+ }
+ textRange.load("text");
+ textRange.load("start");
+ textRange.load("length");
+ await context.sync();
+ let txtHtml = textRange.text;
+ txtHtml = txtHtml.replace(/\n/g, "
");
+ txtHtml = txtHtml.replace(/\r/g, "
");
+ txtHtml = txtHtml.replace(/\v/g, "
");
+ let txtExplained = textRange.text;
+ txtExplained = txtExplained.replace(/\n/g, "NL");
+ txtExplained = txtExplained.replace(/\r/g, "CR");
+ txtExplained = txtExplained.replace(/\v/g, "VV");
+ let finalTable = "";
+ finalTable +=
+ "
Index | Id |
";
+ finalTable += "Raw | " + textRange.text + " |
";
+ finalTable += "Html | " + txtHtml + " |
";
+ finalTable += "Exp | " + txtExplained + " |
";
+ finalTable += "Start | " + textRange.start + " |
";
+ finalTable += "Length | " + textRange.length + " |
";
+ finalTable += "
";
+ const outputSpan = document.getElementById("outputSpan");
+ outputSpan.innerHTML = ""
+ outputSpan.innerHTML += finalTable;
+ });
+
+
+ ...
+
+
+ // Sets the range selection to the range that was saved previously.
+
+ await PowerPoint.run(async (context) => {
+ const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedTextSlideSelection[0]);
+ const shape1: PowerPoint.Shape = slide1.shapes.getItem(savedTextShapeSelection[0]);
+ const textRange: PowerPoint.TextRange = shape1.textFrame.textRange.getSubstring(savedTextTextRangeStart, savedTextTextRangeLength);
+ textRange.setSelected();
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSelectedTextRange(): PowerPoint.TextRange;'
+ return:
+ type:
+ description: ''
+ - name: getSelectedTextRangeOrNullObject()
+ uid: >-
+ powerpoint!PowerPoint.Presentation#getSelectedTextRangeOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getSelectedTextRangeOrNullObject()
+ summary: >-
+ Returns the selected
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class) 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSelectedTextRangeOrNullObject(): PowerPoint.TextRange;'
+ return:
+ type:
+ description: ''
+ - name: insertSlidesFromBase64(base64File, options)
+ uid: powerpoint!PowerPoint.Presentation#insertSlidesFromBase64:member(1)
+ package: powerpoint!
+ fullName: insertSlidesFromBase64(base64File, options)
+ summary: >-
+ Inserts the specified slides from a presentation into the current
+ presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/insert-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Get the ID of the first selected slide.
+ const presentation: PowerPoint.Presentation = context.presentation;
+ const selected: PowerPoint.Slide = presentation.getSelectedSlides().getItemAt(0);
+ selected.load("id");
+ await context.sync();
+
+ // Insert the other presentation after the selected slide.
+ const insertOptions: PowerPoint.InsertSlideOptions = {
+ formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
+ targetSlideId: selected.id
+ };
+ presentation.insertSlidesFromBase64(chosenFileBase64, insertOptions);
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ insertSlidesFromBase64(base64File: string, options?:
+ PowerPoint.InsertSlideOptions): void;
+ parameters:
+ - id: base64File
+ description: The Base64-encoded string representing the source presentation file.
+ type: string
+ - id: options
+ description: >-
+ The options that define which slides will be inserted, where the new
+ slides will go, and which presentation's formatting will be used.
+ type:
+ return:
+ type: void
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Presentation#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.PresentationLoadOptions):
+ PowerPoint.Presentation;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Presentation#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.Presentation;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.Presentation#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Presentation;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: setSelectedSlides(slideIds)
+ uid: powerpoint!PowerPoint.Presentation#setSelectedSlides:member(1)
+ package: powerpoint!
+ fullName: setSelectedSlides(slideIds)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml
+
+
+ // Sets selection to the slides that were saved.
+
+ await PowerPoint.run(async (context) => {
+ context.presentation.setSelectedSlides(savedSlideSelection);
+ await context.sync();
+ });
+
+
+ ...
+
+
+ // Selects slides 2, 4, and 5.
+
+ await PowerPoint.run(async (context) => {
+ context.presentation.load("slides");
+ await context.sync();
+ const slide2: PowerPoint.Slide = context.presentation.slides.getItemAt(1);
+ const slide4: PowerPoint.Slide = context.presentation.slides.getItemAt(3);
+ const slide5: PowerPoint.Slide = context.presentation.slides.getItemAt(4);
+ slide2.load("id");
+ slide4.load("id");
+ slide5.load("id");
+ try {
+ await context.sync();
+ } catch (error) {
+ console.warn("This action requires at least 5 slides in the presentation.");
+ return;
+ }
+ await context.sync();
+ context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSelectedSlides(slideIds: string[]): void;'
+ parameters:
+ - id: slideIds
+ description: >-
+ List of slide IDs to select in the presentation. If the list is
+ empty, selection is cleared.
+ type: string[]
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Presentation#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.PresentationData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.requestcontext.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.requestcontext.yml
new file mode 100644
index 0000000000..6e9d64147a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.requestcontext.yml
@@ -0,0 +1,71 @@
+### YamlMime:TSType
+name: PowerPoint.RequestContext
+uid: powerpoint!PowerPoint.RequestContext:class
+package: powerpoint!
+fullName: PowerPoint.RequestContext
+summary: >-
+ 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.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ // *.run methods automatically create an OfficeExtension.ClientRequestContext
+ // object to work with the Office file.
+ await PowerPoint.run(async (context) => {
+ const presentation = context.presentation;
+ // Interact with the PowerPoint presentation...
+ });
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+constructors:
+ - name: (constructor)(url)
+ uid: powerpoint!PowerPoint.RequestContext:constructor(1)
+ package: powerpoint!
+ fullName: (constructor)(url)
+ summary: Constructs a new instance of the `RequestContext` class
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'constructor(url?: string);'
+ parameters:
+ - id: url
+ description: ''
+ type: string
+properties:
+ - name: application
+ uid: powerpoint!PowerPoint.RequestContext#application:member
+ package: powerpoint!
+ fullName: application
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly application: Application;'
+ return:
+ type:
+ - name: presentation
+ uid: powerpoint!PowerPoint.RequestContext#presentation:member
+ package: powerpoint!
+ fullName: presentation
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly presentation: Presentation;'
+ return:
+ type:
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shape.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shape.yml
new file mode 100644
index 0000000000..7ba40cec83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shape.yml
@@ -0,0 +1,910 @@
+### YamlMime:TSType
+name: PowerPoint.Shape
+uid: powerpoint!PowerPoint.Shape:class
+package: powerpoint!
+fullName: PowerPoint.Shape
+summary: Represents a single shape in the slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the transparency of every geometric shape in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the shape transparency to be halfway transparent.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.geometricShape) {
+ shape.fill.transparency = 0.5;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.Shape#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: customXmlParts
+ uid: powerpoint!PowerPoint.Shape#customXmlParts:member
+ package: powerpoint!
+ fullName: customXmlParts
+ summary: Returns a collection of custom XML parts in the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly customXmlParts: PowerPoint.CustomXmlPartCollection;'
+ return:
+ type:
+ - name: fill
+ uid: powerpoint!PowerPoint.Shape#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Changes the selected shapes fill color to red.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.fill.setSolidColor("red");
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly fill: PowerPoint.ShapeFill;'
+ return:
+ type:
+ - name: group
+ uid: powerpoint!PowerPoint.Shape#group:member
+ package: powerpoint!
+ fullName: group
+ summary: >-
+ Returns the `ShapeGroup` associated with the shape. If the shape type
+ isn't `group`, then this method returns the `GeneralException`
+ error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly group: PowerPoint.ShapeGroup;'
+ return:
+ type:
+ - name: height
+ uid: powerpoint!PowerPoint.Shape#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Arranges the selected shapes in a line from left to right.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ let maxHeight = 0;
+ shapes.items.map((shape) => {
+ shape.load("width,height");
+ });
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.left = currentLeft;
+ shape.top = currentTop;
+ currentLeft += shape.width;
+ if (shape.height > maxHeight) maxHeight = shape.height;
+ });
+ await context.sync();
+ currentLeft = 0;
+ if (currentTop > slideHeight - 200) currentTop = 0;
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height: number;'
+ return:
+ type: number
+ - name: id
+ uid: powerpoint!PowerPoint.Shape#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: left
+ uid: powerpoint!PowerPoint.Shape#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ The distance, in points, from the left side of the shape to the left side
+ of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Arranges the selected shapes in a line from left to right.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ let maxHeight = 0;
+ shapes.items.map((shape) => {
+ shape.load("width,height");
+ });
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.left = currentLeft;
+ shape.top = currentTop;
+ currentLeft += shape.width;
+ if (shape.height > maxHeight) maxHeight = shape.height;
+ });
+ await context.sync();
+ currentLeft = 0;
+ if (currentTop > slideHeight - 200) currentTop = 0;
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left: number;'
+ return:
+ type: number
+ - name: level
+ uid: powerpoint!PowerPoint.Shape#level:member
+ package: powerpoint!
+ fullName: level
+ summary: |-
+ Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly level: number;'
+ return:
+ type: number
+ - name: lineFormat
+ uid: powerpoint!PowerPoint.Shape#lineFormat:member
+ package: powerpoint!
+ fullName: lineFormat
+ summary: Returns the line formatting of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly lineFormat: PowerPoint.ShapeLineFormat;'
+ return:
+ type:
+ - name: name
+ uid: powerpoint!PowerPoint.Shape#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Specifies the name of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name: string;'
+ return:
+ type: string
+ - name: parentGroup
+ uid: powerpoint!PowerPoint.Shape#parentGroup:member
+ package: powerpoint!
+ fullName: parentGroup
+ summary: >-
+ Returns the parent group of this shape. If the shape isn't part of a
+ group, then this method returns the `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly parentGroup: PowerPoint.Shape;'
+ return:
+ type:
+ - name: placeholderFormat
+ uid: powerpoint!PowerPoint.Shape#placeholderFormat:member
+ package: powerpoint!
+ fullName: placeholderFormat
+ summary: >-
+ Returns the properties that apply specifically to this placeholder. If the
+ shape type isn't `placeholder`, then this method returns the
+ `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly placeholderFormat: PowerPoint.PlaceholderFormat;'
+ return:
+ type:
+ - name: tags
+ uid: powerpoint!PowerPoint.Shape#tags:member
+ package: powerpoint!
+ fullName: tags
+ summary: Returns a collection of tags in the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly tags: PowerPoint.TagCollection;'
+ return:
+ type:
+ - name: textFrame
+ uid: powerpoint!PowerPoint.Shape#textFrame:member
+ package: powerpoint!
+ fullName: textFrame
+ summary: Returns the text frame object of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly textFrame: PowerPoint.TextFrame;'
+ return:
+ type:
+ - name: top
+ uid: powerpoint!PowerPoint.Shape#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ The distance, in points, from the top edge of the shape to the top edge of
+ the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Arranges the selected shapes in a line from left to right.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ let maxHeight = 0;
+ shapes.items.map((shape) => {
+ shape.load("width,height");
+ });
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.left = currentLeft;
+ shape.top = currentTop;
+ currentLeft += shape.width;
+ if (shape.height > maxHeight) maxHeight = shape.height;
+ });
+ await context.sync();
+ currentLeft = 0;
+ if (currentTop > slideHeight - 200) currentTop = 0;
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top: number;'
+ return:
+ type: number
+ - name: type
+ uid: powerpoint!PowerPoint.Shape#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of this shape. See
+ [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for
+ details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the transparency of every geometric shape in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the shape transparency to be halfway transparent.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.geometricShape) {
+ shape.fill.transparency = 0.5;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" |
+ "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" |
+ "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" |
+ "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
+ return:
+ type: >-
+ | "Unsupported" |
+ "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" |
+ "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" |
+ "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"
+ - name: width
+ uid: powerpoint!PowerPoint.Shape#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Specifies the width, in points, of the shape. Throws an `InvalidArgument`
+ exception when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Arranges the selected shapes in a line from left to right.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ let maxHeight = 0;
+ shapes.items.map((shape) => {
+ shape.load("width,height");
+ });
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.left = currentLeft;
+ shape.top = currentTop;
+ currentLeft += shape.width;
+ if (shape.height > maxHeight) maxHeight = shape.height;
+ });
+ await context.sync();
+ currentLeft = 0;
+ if (currentTop > slideHeight - 200) currentTop = 0;
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width: number;'
+ return:
+ type: number
+ - name: zOrderPosition
+ uid: powerpoint!PowerPoint.Shape#zOrderPosition:member
+ package: powerpoint!
+ fullName: zOrderPosition
+ summary: >-
+ Returns the z-order position of the shape, with 0 representing the bottom
+ of the order stack. Every shape on a slide has a unique z-order, but each
+ slide also has a unique z-order stack, so two shapes on separate slides
+ could have the same z-order number.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly zOrderPosition: number;'
+ return:
+ type: number
+methods:
+ - name: delete()
+ uid: powerpoint!PowerPoint.Shape#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: >-
+ Deletes the shape from the shape collection. Does nothing if the shape
+ does not exist.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and then iterates through them, deleting each one.
+
+ await PowerPoint.run(async (context) => {
+ const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
+ const shapes: PowerPoint.ShapeCollection = slide.shapes;
+
+ // Load all the shapes in the collection without loading their properties.
+ shapes.load("items/$none");
+
+ await context.sync();
+
+ shapes.items.forEach((shape) => shape.delete());
+
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getParentSlide()
+ uid: powerpoint!PowerPoint.Shape#getParentSlide:member(1)
+ package: powerpoint!
+ fullName: getParentSlide()
+ summary: >-
+ Returns the parent
+ [PowerPoint.Slide](xref:powerpoint!PowerPoint.Slide:class) object that
+ holds this `Shape`. Throws an exception if this shape does not
+ belong to a `Slide`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentSlide(): PowerPoint.Slide;'
+ return:
+ type:
+ description: ''
+ - name: getParentSlideLayout()
+ uid: powerpoint!PowerPoint.Shape#getParentSlideLayout:member(1)
+ package: powerpoint!
+ fullName: getParentSlideLayout()
+ summary: >-
+ Returns the parent
+ [PowerPoint.SlideLayout](xref:powerpoint!PowerPoint.SlideLayout:class)
+ object that holds this `Shape`. Throws an exception if this shape
+ does not belong to a `SlideLayout`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentSlideLayout(): PowerPoint.SlideLayout;'
+ return:
+ type:
+ description: ''
+ - name: getParentSlideLayoutOrNullObject()
+ uid: powerpoint!PowerPoint.Shape#getParentSlideLayoutOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getParentSlideLayoutOrNullObject()
+ summary: >-
+ Returns the parent
+ [PowerPoint.SlideLayout](xref:powerpoint!PowerPoint.SlideLayout:class)
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;'
+ return:
+ type:
+ description: ''
+ - name: getParentSlideMaster()
+ uid: powerpoint!PowerPoint.Shape#getParentSlideMaster:member(1)
+ package: powerpoint!
+ fullName: getParentSlideMaster()
+ summary: >-
+ Returns the parent
+ [PowerPoint.SlideMaster](xref:powerpoint!PowerPoint.SlideMaster:class)
+ object that holds this `Shape`. Throws an exception if this shape
+ does not belong to a `SlideMaster`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentSlideMaster(): PowerPoint.SlideMaster;'
+ return:
+ type:
+ description: ''
+ - name: getParentSlideMasterOrNullObject()
+ uid: powerpoint!PowerPoint.Shape#getParentSlideMasterOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getParentSlideMasterOrNullObject()
+ summary: >-
+ Returns the parent
+ [PowerPoint.SlideMaster](xref:powerpoint!PowerPoint.SlideMaster:class)
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;'
+ return:
+ type:
+ description: ''
+ - name: getParentSlideOrNullObject()
+ uid: powerpoint!PowerPoint.Shape#getParentSlideOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getParentSlideOrNullObject()
+ summary: >-
+ Returns the parent
+ [PowerPoint.Slide](xref:powerpoint!PowerPoint.Slide:class) 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentSlideOrNullObject(): PowerPoint.Slide;'
+ return:
+ type:
+ description: ''
+ - name: getTable()
+ uid: powerpoint!PowerPoint.Shape#getTable:member(1)
+ package: powerpoint!
+ fullName: getTable()
+ summary: Returns the `Table` object if this shape is a table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTable(): PowerPoint.Table;'
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Shape#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ShapeLoadOptions):
+ PowerPoint.Shape;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Shape#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.Shape;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.Shape#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Shape;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: setZOrder(position)
+ uid: powerpoint!PowerPoint.Shape#setZOrder:member(1)
+ package: powerpoint!
+ fullName: setZOrder(position)
+ summary: >-
+ Moves the specified shape up or down the collection's z-order, which
+ shifts it in front of or behind other shapes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setZOrder(position: PowerPoint.ShapeZOrder): void;'
+ parameters:
+ - id: position
+ description: >-
+ Specifies how to move the shape within the z-order stack. Uses the
+ `ShapeZOrder` enum.
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setZOrder(positionString)
+ uid: powerpoint!PowerPoint.Shape#setZOrder:member(2)
+ package: powerpoint!
+ fullName: setZOrder(positionString)
+ summary: >-
+ Moves the specified shape up or down the collection's z-order, which
+ shifts it in front of or behind other shapes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setZOrder(positionString: "BringForward" | "BringToFront" |
+ "SendBackward" | "SendToBack"): void;
+ parameters:
+ - id: positionString
+ description: >-
+ Specifies how to move the shape within the z-order stack. Uses the
+ `ShapeZOrder` enum.
+ type: '"BringForward" | "BringToFront" | "SendBackward" | "SendToBack"'
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Shape#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ShapeData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapeaddoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapeaddoptions.yml
new file mode 100644
index 0000000000..8761f8f8d6
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapeaddoptions.yml
@@ -0,0 +1,121 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeAddOptions
+uid: powerpoint!PowerPoint.ShapeAddOptions:interface
+package: powerpoint!
+fullName: PowerPoint.ShapeAddOptions
+summary: Represents the available options when adding shapes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and adds a hexagon shape to the collection, while specifying its
+
+ // location and size. Then it names the shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ const shapeOptions: PowerPoint.ShapeAddOptions = {
+ left: 100,
+ top: 100,
+ height: 150,
+ width: 150
+ };
+ const hexagon: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.hexagon, shapeOptions);
+ hexagon.name = "Hexagon";
+
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: height
+ uid: powerpoint!PowerPoint.ShapeAddOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: number;'
+ return:
+ type: number
+ - name: left
+ uid: powerpoint!PowerPoint.ShapeAddOptions#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: number;'
+ return:
+ type: number
+ - name: top
+ uid: powerpoint!PowerPoint.ShapeAddOptions#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: number;'
+ return:
+ type: number
+ - name: width
+ uid: powerpoint!PowerPoint.ShapeAddOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapeautosize.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapeautosize.yml
new file mode 100644
index 0000000000..b5f7b7c1b3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapeautosize.yml
@@ -0,0 +1,58 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeAutoSize
+uid: powerpoint!PowerPoint.ShapeAutoSize:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeAutoSize
+summary: Determines the type of automatic sizing allowed.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: autoSizeMixed
+ uid: powerpoint!PowerPoint.ShapeAutoSize.autoSizeMixed:member
+ package: powerpoint!
+ summary: >-
+ A combination of automatic sizing schemes are used.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AutoSizeMixed"'
+ - name: autoSizeNone
+ uid: powerpoint!PowerPoint.ShapeAutoSize.autoSizeNone:member
+ package: powerpoint!
+ summary: >-
+ No autosizing.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AutoSizeNone"'
+ - name: autoSizeShapeToFitText
+ uid: powerpoint!PowerPoint.ShapeAutoSize.autoSizeShapeToFitText:member
+ package: powerpoint!
+ summary: >-
+ The shape is adjusted to fit the text.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AutoSizeShapeToFitText"'
+ - name: autoSizeTextToFitShape
+ uid: powerpoint!PowerPoint.ShapeAutoSize.autoSizeTextToFitShape:member
+ package: powerpoint!
+ summary: >-
+ The text is adjusted to fit the shape.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AutoSizeTextToFitShape"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapecollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapecollection.yml
new file mode 100644
index 0000000000..21a8479471
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapecollection.yml
@@ -0,0 +1,747 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeCollection
+uid: powerpoint!PowerPoint.ShapeCollection:class
+package: powerpoint!
+fullName: PowerPoint.ShapeCollection
+summary: Represents the collection of shapes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the transparency of every geometric shape in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the shape transparency to be halfway transparent.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.geometricShape) {
+ shape.fill.transparency = 0.5;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.ShapeCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.ShapeCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.Shape[];'
+ return:
+ type: []
+methods:
+ - name: addGeometricShape(geometricShapeType, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addGeometricShape:member(1)
+ package: powerpoint!
+ fullName: addGeometricShape(geometricShapeType, options)
+ summary: >-
+ Adds a geometric shape to the slide. Returns a `Shape` object that
+ represents the new shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and adds a hexagon shape to the collection, while specifying its
+
+ // location and size. Then it names the shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ const shapeOptions: PowerPoint.ShapeAddOptions = {
+ left: 100,
+ top: 100,
+ height: 150,
+ width: 150
+ };
+ const hexagon: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.hexagon, shapeOptions);
+ hexagon.name = "Hexagon";
+
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType,
+ options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
+ parameters:
+ - id: geometricShapeType
+ description: >-
+ Specifies the type of the geometric shape. See
+ [PowerPoint.GeometricShapeType](xref:powerpoint!PowerPoint.GeometricShapeType:enum)
+ for details.
+ type:
+ - id: options
+ description: >-
+ An optional parameter to specify the additional options such as the
+ position of the shape.
+ type:
+ return:
+ type:
+ description: The newly inserted shape.
+ - name: addGeometricShape(geometricShapeTypeString, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addGeometricShape:member(2)
+ package: powerpoint!
+ fullName: addGeometricShape(geometricShapeTypeString, options)
+ summary: >-
+ Adds a geometric shape to the slide. Returns a `Shape` object that
+ represents the new shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ 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;
+ parameters:
+ - id: geometricShapeTypeString
+ description: >-
+ Specifies the type of the geometric shape. See
+ [PowerPoint.GeometricShapeType](xref:powerpoint!PowerPoint.GeometricShapeType:enum)
+ for details.
+ type: >-
+ "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"
+ - id: options
+ description: >-
+ An optional parameter to specify the additional options such as the
+ position of the shape.
+ type:
+ return:
+ type:
+ description: The newly inserted shape.
+ - name: addGroup(values)
+ uid: powerpoint!PowerPoint.ShapeCollection#addGroup:member(1)
+ package: powerpoint!
+ fullName: addGroup(values)
+ summary: Create a shape group for several shapes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addGroup(values: Array): PowerPoint.Shape;'
+ parameters:
+ - id: values
+ description: An array of shape IDs or `Shape` objects.
+ type: >-
+ Array<string | >
+ return:
+ type:
+ description: >-
+ A `Shape` object that represents the shape group. Use the
+ `Shape.group` property to access the `ShapeGroup` object for the
+ group.
+ - name: addLine(connectorType, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addLine:member(1)
+ package: powerpoint!
+ fullName: addLine(connectorType, options)
+ summary: >-
+ Adds a line to the slide. Returns a `Shape` object that represents the new
+ line.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and adds a line to the collection, while specifying its
+
+ // start and end points. Then it names the shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+
+ // For a line, left and top are the coordinates of the start point,
+ // while height and width are the coordinates of the end point.
+ const line: PowerPoint.Shape = shapes.addLine(PowerPoint.ConnectorType.straight,
+ {
+ left: 400,
+ top: 200,
+ height: 20,
+ width: 150
+ });
+ line.name = "StraightLine";
+
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addLine(connectorType?: PowerPoint.ConnectorType, options?:
+ PowerPoint.ShapeAddOptions): PowerPoint.Shape;
+ parameters:
+ - id: connectorType
+ description: >-
+ Specifies the connector type of the line. If not provided,
+ `straight` connector type will be used. See
+ [PowerPoint.ConnectorType](xref:powerpoint!PowerPoint.ConnectorType:enum)
+ for details.
+ type:
+ - id: options
+ description: >-
+ An optional parameter to specify the additional options such as the
+ position of the shape object that contains the line.
+ type:
+ return:
+ type:
+ description: The newly inserted shape.
+ - name: addLine(connectorTypeString, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addLine:member(2)
+ package: powerpoint!
+ fullName: addLine(connectorTypeString, options)
+ summary: >-
+ Adds a line to the slide. Returns a `Shape` object that represents the new
+ line.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addLine(connectorTypeString?: "Straight" | "Elbow" | "Curve", options?:
+ PowerPoint.ShapeAddOptions): PowerPoint.Shape;
+ parameters:
+ - id: connectorTypeString
+ description: >-
+ Specifies the connector type of the line. If not provided,
+ `straight` connector type will be used. See
+ [PowerPoint.ConnectorType](xref:powerpoint!PowerPoint.ConnectorType:enum)
+ for details.
+ type: '"Straight" | "Elbow" | "Curve"'
+ - id: options
+ description: >-
+ An optional parameter to specify the additional options such as the
+ position of the shape object that contains the line.
+ type:
+ return:
+ type:
+ description: The newly inserted shape.
+ - name: addTable(rowCount, columnCount, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addTable:member(1)
+ package: powerpoint!
+ fullName: addTable(rowCount, columnCount, options)
+ summary: >-
+ Adds a table to the slide. Returns a `Shape` object that represents the
+ new table. Use the `Shape.table` property to get the `Table` object for
+ the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addTable(rowCount: number, columnCount: number, options?:
+ PowerPoint.TableAddOptions): PowerPoint.Shape;
+ parameters:
+ - id: rowCount
+ description: Number of rows in the table. Must be 1 or greater.
+ type: number
+ - id: columnCount
+ description: Number of columns in the table. Must be 1 or greater.
+ type: number
+ - id: options
+ description: Provides options describing the new table.
+ type:
+ return:
+ type:
+ description: The newly inserted shape.
+ - name: addTextBox(text, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addTextBox:member(1)
+ package: powerpoint!
+ fullName: addTextBox(text, options)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and adds a text box to the collection, while specifying its text,
+
+ // location, and size. Then it names the text box.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ const textbox: PowerPoint.Shape = shapes.addTextBox("Hello!",
+ {
+ left: 100,
+ top: 300,
+ height: 300,
+ width: 450
+ });
+ textbox.name = "Textbox";
+
+ return context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addTextBox(text: string, options?: PowerPoint.ShapeAddOptions):
+ PowerPoint.Shape;
+ parameters:
+ - id: text
+ description: Specifies the text that will be shown in the created text box.
+ type: string
+ - id: options
+ description: >-
+ An optional parameter to specify the additional options such as the
+ position of the text box.
+ type:
+ return:
+ type:
+ description: The newly inserted shape.
+ - name: getCount()
+ uid: powerpoint!PowerPoint.ShapeCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of shapes in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of shapes in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.ShapeCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: >-
+ Gets a shape using its unique ID. An error is thrown if the shape does not
+ exist.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.Shape;'
+ parameters:
+ - id: key
+ description: The ID of the shape.
+ type: string
+ return:
+ type:
+ description: >-
+ The shape with the unique ID. If such a shape does not exist, an error
+ is thrown.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.ShapeCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
+ const shape: PowerPoint.Shape = slide.shapes.getItemAt(0);
+ shape.tags.add("MOUNTAIN", "Denali");
+
+ await context.sync();
+
+ const myShapeTag: PowerPoint.Tag = shape.tags.getItem("MOUNTAIN");
+ myShapeTag.load("key, value");
+
+ await context.sync();
+
+ console.log("Added key " + JSON.stringify(myShapeTag.key) + " with value " + JSON.stringify(myShapeTag.value));
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.Shape;'
+ parameters:
+ - id: index
+ description: The index of the shape in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The shape at the given index. An error is thrown if index is out of
+ range.
+ - name: getItemOrNullObject(id)
+ uid: powerpoint!PowerPoint.ShapeCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.Shape;'
+ parameters:
+ - id: id
+ description: The ID of the shape.
+ type: string
+ return:
+ type:
+ description: >-
+ The shape with the unique ID. If such a shape does not exist, an
+ object with an `isNullObject` property set to true is returned.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.ShapeCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.ShapeCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.ShapeCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: >-
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the transparency of every geometric shape in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the shape transparency to be halfway transparent.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.geometricShape) {
+ shape.fill.transparency = 0.5;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.ShapeCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.ShapeCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ShapeCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ShapeCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefill.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefill.yml
new file mode 100644
index 0000000000..0117f8b95c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefill.yml
@@ -0,0 +1,385 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeFill
+uid: powerpoint!PowerPoint.ShapeFill:class
+package: powerpoint!
+fullName: PowerPoint.ShapeFill
+summary: Represents the fill formatting of a shape object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the transparency of every geometric shape in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the shape transparency to be halfway transparent.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.geometricShape) {
+ shape.fill.transparency = 0.5;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.ShapeFill#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: foregroundColor
+ uid: powerpoint!PowerPoint.ShapeFill#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Creates random shapes on the selected slide.
+
+ await PowerPoint.run(async (context) => {
+ let finalTable = "";
+ const currentSlide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const maxNewShapeWidth = 200;
+ const maxNewShapeHeight = 200;
+ const minNewShapeWidth = 50;
+ const minNewShapeHeight = 50;
+ for (let i = 0; i < 20; i++) {
+ const rectangle: PowerPoint.Shape = currentSlide.shapes.addGeometricShape(PowerPoint.GeometricShapeType.rectangle);
+ rectangle.height = getRandomBetween(minNewShapeWidth, maxNewShapeWidth);
+ rectangle.width = getRandomBetween(minNewShapeHeight, maxNewShapeHeight);
+ rectangle.left = getRandomBetween(0, slideWidth - rectangle.width);
+ rectangle.top = getRandomBetween(0, slideHeight - rectangle.height);
+ rectangle.fill.foregroundColor = generateRandomHexColor();
+ }
+ finalTable += "Done
";
+ const slideTags = document.getElementById("slide-tags");
+ if (slideTags) {
+ slideTags.innerHTML = "";
+ slideTags.innerHTML += finalTable;
+ } else {
+ console.warn('Element with ID "slide-tags" not found.');
+ }
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor: string;'
+ return:
+ type: string
+ - name: transparency
+ uid: powerpoint!PowerPoint.ShapeFill#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the transparency of every geometric shape in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the shape transparency to be halfway transparent.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.geometricShape) {
+ shape.fill.transparency = 0.5;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency: number;'
+ return:
+ type: number
+ - name: type
+ uid: powerpoint!PowerPoint.ShapeFill#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the fill type of the shape. See
+ [PowerPoint.ShapeFillType](xref:powerpoint!PowerPoint.ShapeFillType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" |
+ "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
+ return:
+ type: >-
+ | "NoFill" |
+ "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" |
+ "SlideBackground"
+methods:
+ - name: clear()
+ uid: powerpoint!PowerPoint.ShapeFill#clear:member(1)
+ package: powerpoint!
+ fullName: clear()
+ summary: Clears the fill formatting of this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(): void;'
+ return:
+ type: void
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.ShapeFill#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions):
+ PowerPoint.ShapeFill;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.ShapeFill#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.ShapeFill;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.ShapeFill#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.ShapeFill;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: setImage(base64EncodedImage)
+ uid: powerpoint!PowerPoint.ShapeFill#setImage:member(1)
+ package: powerpoint!
+ fullName: setImage(base64EncodedImage)
+ summary: >-
+ Sets the fill formatting of the shape to an image. This changes the fill
+ type to `PictureAndTexture`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setImage(base64EncodedImage: string): void;'
+ parameters:
+ - id: base64EncodedImage
+ description: A string that is a Base64 encoding of the image data.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setSolidColor(color)
+ uid: powerpoint!PowerPoint.ShapeFill#setSolidColor:member(1)
+ package: powerpoint!
+ fullName: setSolidColor(color)
+ summary: >-
+ Sets the fill formatting of the shape to a uniform color. This changes the
+ fill type to `Solid`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Changes the selected shapes fill color to red.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.fill.setSolidColor("red");
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSolidColor(color: string): void;'
+ parameters:
+ - id: color
+ description: >-
+ 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").
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ShapeFill#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ShapeFillData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefilltype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefilltype.yml
new file mode 100644
index 0000000000..5a147f7bac
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefilltype.yml
@@ -0,0 +1,80 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeFillType
+uid: powerpoint!PowerPoint.ShapeFillType:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeFillType
+summary: Specifies a shape's fill type.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: gradient
+ uid: powerpoint!PowerPoint.ShapeFillType.gradient:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the shape should have gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Gradient"'
+ - name: noFill
+ uid: powerpoint!PowerPoint.ShapeFillType.noFill:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the shape should have no fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NoFill"'
+ - name: pattern
+ uid: powerpoint!PowerPoint.ShapeFillType.pattern:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the shape should have pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Pattern"'
+ - name: pictureAndTexture
+ uid: powerpoint!PowerPoint.ShapeFillType.pictureAndTexture:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the shape should have picture or texture fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"PictureAndTexture"'
+ - name: slideBackground
+ uid: powerpoint!PowerPoint.ShapeFillType.slideBackground:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the shape should have slide background fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SlideBackground"'
+ - name: solid
+ uid: powerpoint!PowerPoint.ShapeFillType.solid:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the shape should have regular solid fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Solid"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefont.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefont.yml
new file mode 100644
index 0000000000..36c0718b5c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefont.yml
@@ -0,0 +1,491 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeFont
+uid: powerpoint!PowerPoint.ShapeFont:class
+package: powerpoint!
+fullName: PowerPoint.ShapeFont
+summary: >-
+ Represents the font attributes, such as font name, font size, and color, for a
+ shape's TextRange object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Sets the color of the selected text range to green.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.font.color = "green";
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: allCaps
+ uid: powerpoint!PowerPoint.ShapeFont#allCaps:member
+ package: powerpoint!
+ fullName: allCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **All
+ Caps** attribute which makes lowercase letters appear as uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **All Caps** attribute.
+
+
+ - `false`: None of the text has the **All Caps** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **All Caps** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'allCaps: boolean | null;'
+ return:
+ type: boolean | null
+ - name: bold
+ uid: powerpoint!PowerPoint.ShapeFont#bold:member
+ package: powerpoint!
+ fullName: bold
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to bold. The possible
+ values are as follows:
+
+
+ - `true`: All the text is bold.
+
+
+ - `false`: None of the text is bold.
+
+
+ - `null`: Returned if some, but not all, of the text is bold.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bold: boolean | null;'
+ return:
+ type: boolean | null
+ - name: color
+ uid: powerpoint!PowerPoint.ShapeFont#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the HTML color code representation of the text color (e.g.,
+ "\#FF0000" represents red). Returns `null` if the `TextRange` contains
+ text fragments with different colors.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Sets the color of the selected text range to green.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.font.color = "green";
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color: string | null;'
+ return:
+ type: string | null
+ - name: context
+ uid: powerpoint!PowerPoint.ShapeFont#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: doubleStrikethrough
+ uid: powerpoint!PowerPoint.ShapeFont#doubleStrikethrough:member
+ package: powerpoint!
+ fullName: doubleStrikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Double
+ strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Double strikethrough**
+ attribute.
+
+
+ - `false`: None of the text has the **Double strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Double strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'doubleStrikethrough: boolean | null;'
+ return:
+ type: boolean | null
+ - name: italic
+ uid: powerpoint!PowerPoint.ShapeFont#italic:member
+ package: powerpoint!
+ fullName: italic
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to italic. The
+ possible values are as follows:
+
+
+ - `true`: All the text is italicized.
+
+
+ - `false`: None of the text is italicized.
+
+
+ - `null`: Returned if some, but not all, of the text is
+ italicized.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'italic: boolean | null;'
+ return:
+ type: boolean | null
+ - name: name
+ uid: powerpoint!PowerPoint.ShapeFont#name:member
+ package: powerpoint!
+ fullName: name
+ summary: >-
+ Specifies the font name (e.g., "Calibri"). If the text is a Complex Script
+ or East Asian language, this is the corresponding font name; otherwise
+ it's the Latin font name. Returns `null` if the `TextRange` contains text
+ fragments with different font names.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'name: string | null;'
+ return:
+ type: string | null
+ - name: size
+ uid: powerpoint!PowerPoint.ShapeFont#size:member
+ package: powerpoint!
+ fullName: size
+ summary: >-
+ Specifies the font size in points (e.g., 11). Returns `null` if the
+ `TextRange` contains text fragments with different font sizes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'size: number | null;'
+ return:
+ type: number | null
+ - name: smallCaps
+ uid: powerpoint!PowerPoint.ShapeFont#smallCaps:member
+ package: powerpoint!
+ fullName: smallCaps
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the **Small
+ Caps** attribute which makes lowercase letters appear as small uppercase
+ letters. The possible values are as follows:
+
+
+ - `true`: All the text has the **Small Caps** attribute.
+
+
+ - `false`: None of the text has the **Small Caps** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Small Caps** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'smallCaps: boolean | null;'
+ return:
+ type: boolean | null
+ - name: strikethrough
+ uid: powerpoint!PowerPoint.ShapeFont#strikethrough:member
+ package: powerpoint!
+ fullName: strikethrough
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Strikethrough** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Strikethrough** attribute.
+
+
+ - `false`: None of the text has the **Strikethrough**
+ attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Strikethrough** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'strikethrough: boolean | null;'
+ return:
+ type: boolean | null
+ - name: subscript
+ uid: powerpoint!PowerPoint.ShapeFont#subscript:member
+ package: powerpoint!
+ fullName: subscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Subscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Subscript** attribute.
+
+
+ - `false`: None of the text has the **Subscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Subscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'subscript: boolean | null;'
+ return:
+ type: boolean | null
+ - name: superscript
+ uid: powerpoint!PowerPoint.ShapeFont#superscript:member
+ package: powerpoint!
+ fullName: superscript
+ summary: >-
+ Specifies whether the text in the `TextRange` is set to use the
+ **Superscript** attribute. The possible values are as follows:
+
+
+ - `true`: All the text has the **Superscript** attribute.
+
+
+ - `false`: None of the text has the **Superscript** attribute.
+
+
+ - `null`: Returned if some, but not all, of the text has the
+ **Superscript** attribute.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'superscript: boolean | null;'
+ return:
+ type: boolean | null
+ - name: underline
+ uid: powerpoint!PowerPoint.ShapeFont#underline:member
+ package: powerpoint!
+ fullName: underline
+ summary: >-
+ Specifies the type of underline applied to the font. Returns `null` if the
+ `TextRange` contains text fragments with different underline styles. See
+ [PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" |
+ "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" |
+ "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash"
+ | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
+ return:
+ type: >-
+ |
+ "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" |
+ "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" |
+ "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" |
+ "WavyHeavy" | "WavyDouble" | null
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.ShapeFont#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions):
+ PowerPoint.ShapeFont;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.ShapeFont#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.ShapeFont;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.ShapeFont#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.ShapeFont;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ShapeFont#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ShapeFontData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefontunderlinestyle.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefontunderlinestyle.yml
new file mode 100644
index 0000000000..718b4e709a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapefontunderlinestyle.yml
@@ -0,0 +1,201 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeFontUnderlineStyle
+uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeFontUnderlineStyle
+summary: The type of underline applied to a font.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: dash
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dash:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a line containing dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Dash"'
+ - name: dashHeavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dashHeavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a thick line containing dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashHeavy"'
+ - name: dashLong
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dashLong:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a line containing long dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashLong"'
+ - name: dashLongHeavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dashLongHeavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a thick line containing long dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashLongHeavy"'
+ - name: dotDash
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dotDash:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a line containing dots and dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DotDash"'
+ - name: dotDashHeavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dotDashHeavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a thick line containing dots and dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DotDashHeavy"'
+ - name: dotDotDash
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dotDotDash:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a line containing double dots and dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DotDotDash"'
+ - name: dotDotDashHeavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dotDotDashHeavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a thick line containing double dots and dashes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DotDotDashHeavy"'
+ - name: dotted
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dotted:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a dotted line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Dotted"'
+ - name: dottedHeavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.dottedHeavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a thick, dotted line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DottedHeavy"'
+ - name: double
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.double:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with double lines.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Double"'
+ - name: heavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.heavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a thick line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Heavy"'
+ - name: none
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.none:member
+ package: powerpoint!
+ summary: >-
+ No underlining.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"None"'
+ - name: single
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.single:member
+ package: powerpoint!
+ summary: >-
+ Regular single line underlining.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Single"'
+ - name: wavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.wavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a wavy line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Wavy"'
+ - name: wavyDouble
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.wavyDouble:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with double wavy lines.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"WavyDouble"'
+ - name: wavyHeavy
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle.wavyHeavy:member
+ package: powerpoint!
+ summary: >-
+ Underlining of text with a thick, wavy line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"WavyHeavy"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapegroup.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapegroup.yml
new file mode 100644
index 0000000000..dd3b7091d4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapegroup.yml
@@ -0,0 +1,202 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeGroup
+uid: powerpoint!PowerPoint.ShapeGroup:class
+package: powerpoint!
+fullName: PowerPoint.ShapeGroup
+summary: >-
+ Represents a shape group inside a presentation. To get the corresponding Shape
+ object, use `ShapeGroup.shape`.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.ShapeGroup#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: id
+ uid: powerpoint!PowerPoint.ShapeGroup#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the shape group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: shape
+ uid: powerpoint!PowerPoint.ShapeGroup#shape:member
+ package: powerpoint!
+ fullName: shape
+ summary: Returns the `Shape` object associated with the group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly shape: PowerPoint.Shape;'
+ return:
+ type:
+ - name: shapes
+ uid: powerpoint!PowerPoint.ShapeGroup#shapes:member
+ package: powerpoint!
+ fullName: shapes
+ summary: Returns the collection of `Shape` objects in the group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly shapes: PowerPoint.ShapeScopedCollection;'
+ return:
+ type:
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.ShapeGroup#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ShapeGroupLoadOptions):
+ PowerPoint.ShapeGroup;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.ShapeGroup#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.ShapeGroup;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.ShapeGroup#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.ShapeGroup;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ShapeGroup#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original `PowerPoint.ShapeGroup`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ShapeGroupData;'
+ return:
+ type: >-
+
+ description: ''
+ - name: ungroup()
+ uid: powerpoint!PowerPoint.ShapeGroup#ungroup:member(1)
+ package: powerpoint!
+ fullName: ungroup()
+ summary: Ungroups any grouped shapes in the specified shape group.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'ungroup(): void;'
+ return:
+ type: void
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelinedashstyle.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelinedashstyle.yml
new file mode 100644
index 0000000000..c1d4801bf2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelinedashstyle.yml
@@ -0,0 +1,175 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeLineDashStyle
+uid: powerpoint!PowerPoint.ShapeLineDashStyle:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeLineDashStyle
+summary: Specifies the dash style for a line.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the dash style of every line in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the dash style for shapes of the type `line`.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.line) {
+ shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: dash
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.dash:member
+ package: powerpoint!
+ summary: >-
+ The dash line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Dash"'
+ - name: dashDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.dashDot:member
+ package: powerpoint!
+ summary: >-
+ The dash-dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashDot"'
+ - name: dashDotDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.dashDotDot:member
+ package: powerpoint!
+ summary: >-
+ The dash-dot-dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashDotDot"'
+ - name: longDash
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.longDash:member
+ package: powerpoint!
+ summary: >-
+ The long dash line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LongDash"'
+ - name: longDashDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.longDashDot:member
+ package: powerpoint!
+ summary: >-
+ The long dash-dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LongDashDot"'
+ - name: longDashDotDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.longDashDotDot:member
+ package: powerpoint!
+ summary: >-
+ The long dash-dot-dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LongDashDotDot"'
+ - name: roundDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.roundDot:member
+ package: powerpoint!
+ summary: >-
+ The round dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RoundDot"'
+ - name: solid
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.solid:member
+ package: powerpoint!
+ summary: >-
+ The solid line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Solid"'
+ - name: squareDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.squareDot:member
+ package: powerpoint!
+ summary: >-
+ The square dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SquareDot"'
+ - name: systemDash
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.systemDash:member
+ package: powerpoint!
+ summary: >-
+ The system dash line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SystemDash"'
+ - name: systemDashDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.systemDashDot:member
+ package: powerpoint!
+ summary: >-
+ The system dash-dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SystemDashDot"'
+ - name: systemDot
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle.systemDot:member
+ package: powerpoint!
+ summary: >-
+ The system dot line pattern.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SystemDot"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelineformat.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelineformat.yml
new file mode 100644
index 0000000000..9865556cd6
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelineformat.yml
@@ -0,0 +1,319 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeLineFormat
+uid: powerpoint!PowerPoint.ShapeLineFormat:class
+package: powerpoint!
+fullName: PowerPoint.ShapeLineFormat
+summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the dash style of every line in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the dash style for shapes of the type `line`.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.line) {
+ shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.ShapeLineFormat#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color: string;'
+ return:
+ type: string
+ - name: context
+ uid: powerpoint!PowerPoint.ShapeLineFormat#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: dashStyle
+ uid: powerpoint!PowerPoint.ShapeLineFormat#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the dash style of every line in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the dash style for shapes of the type `line`.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.line) {
+ shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" |
+ "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" |
+ "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" |
+ "SystemDashDot";
+ return:
+ type: >-
+ | "Dash"
+ | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" |
+ "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot"
+ | "SystemDashDot"
+ - name: style
+ uid: powerpoint!PowerPoint.ShapeLineFormat#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" |
+ "ThickThin" | "ThinThick" | "ThinThin";
+ return:
+ type: >-
+ | "Single" |
+ "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
+ - name: transparency
+ uid: powerpoint!PowerPoint.ShapeLineFormat#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency: number;'
+ return:
+ type: number
+ - name: visible
+ uid: powerpoint!PowerPoint.ShapeLineFormat#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible: boolean;'
+ return:
+ type: boolean
+ - name: weight
+ uid: powerpoint!PowerPoint.ShapeLineFormat#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'weight: number;'
+ return:
+ type: number
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.ShapeLineFormat#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions):
+ PowerPoint.ShapeLineFormat;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.ShapeLineFormat#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.ShapeLineFormat#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.ShapeLineFormat;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ShapeLineFormat#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelinestyle.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelinestyle.yml
new file mode 100644
index 0000000000..fec7a20d67
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapelinestyle.yml
@@ -0,0 +1,73 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeLineStyle
+uid: powerpoint!PowerPoint.ShapeLineStyle:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeLineStyle
+summary: Specifies the style for a line.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: single
+ uid: powerpoint!PowerPoint.ShapeLineStyle.single:member
+ package: powerpoint!
+ summary: >-
+ Single line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Single"'
+ - name: thickBetweenThin
+ uid: powerpoint!PowerPoint.ShapeLineStyle.thickBetweenThin:member
+ package: powerpoint!
+ summary: >-
+ Thick line with a thin line on each side.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThickBetweenThin"'
+ - name: thickThin
+ uid: powerpoint!PowerPoint.ShapeLineStyle.thickThin:member
+ package: powerpoint!
+ summary: >-
+ 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.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThickThin"'
+ - name: thinThick
+ uid: powerpoint!PowerPoint.ShapeLineStyle.thinThick:member
+ package: powerpoint!
+ summary: >-
+ 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.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThinThick"'
+ - name: thinThin
+ uid: powerpoint!PowerPoint.ShapeLineStyle.thinThin:member
+ package: powerpoint!
+ summary: >-
+ Two thin lines.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThinThin"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapescopedcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapescopedcollection.yml
new file mode 100644
index 0000000000..494fb29952
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapescopedcollection.yml
@@ -0,0 +1,322 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeScopedCollection
+uid: powerpoint!PowerPoint.ShapeScopedCollection:class
+package: powerpoint!
+fullName: PowerPoint.ShapeScopedCollection
+summary: Represents a collection of shapes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Changes the selected shapes fill color to red.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ shapes.items.map((shape) => {
+ shape.fill.setSolidColor("red");
+ });
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.Shape[];'
+ return:
+ type: []
+methods:
+ - name: getCount()
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of shapes in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Gets the shapes you selected on the slide and displays their IDs on the
+ task pane.
+
+ await PowerPoint.run(async (context) => {
+ let finalTable = "";
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ await context.sync();
+ finalTable += "
getSelectedShapes.getCount returned:" + shapeCount.value + "
";
+ finalTable +=
+ "
Index | Id |
";
+ shapes.load("items");
+ await context.sync();
+ shapes.items.map((shape, index) => {
+ finalTable += "" + index + " | " + shape.id + " |
";
+ });
+ finalTable += "
";
+ const outputSpan = document.getElementById("outputSpan");
+ outputSpan.innerHTML = "";
+ outputSpan.innerHTML += finalTable;
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of shapes in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: >-
+ Gets a shape using its unique ID. An error is thrown if the shape does not
+ exist.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.Shape;'
+ parameters:
+ - id: key
+ description: The ID of the shape.
+ type: string
+ return:
+ type:
+ description: >-
+ The shape with the unique ID. If such a shape does not exist, an error
+ is thrown.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.Shape;'
+ parameters:
+ - id: index
+ description: The index of the shape in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The shape at the given index. An error is thrown if index is out of
+ range.
+ - name: getItemOrNullObject(id)
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.Shape;'
+ parameters:
+ - id: id
+ description: The ID of the shape.
+ type: string
+ return:
+ type:
+ description: >-
+ The shape with the unique ID. If such a shape does not exist, an
+ object with an `isNullObject` property set to true is returned.
+ - name: group()
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#group:member(1)
+ package: powerpoint!
+ fullName: group()
+ summary: >-
+ Groups all shapes in this collection into a single shape. If the
+ collection contains fewer than two shapes, then this method returns the
+ `GeneralException` error.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'group(): PowerPoint.Shape;'
+ return:
+ type:
+ description: >-
+ The newly created grouped shape as a
+ [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class).
+ - name: load(options)
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.ShapeScopedCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNames?: string | string[]):
+ PowerPoint.ShapeScopedCollection;
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.ShapeScopedCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ShapeScopedCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapetype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapetype.yml
new file mode 100644
index 0000000000..40de3c8aeb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapetype.yml
@@ -0,0 +1,252 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeType
+uid: powerpoint!PowerPoint.ShapeType:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeType
+summary: Specifies the type of a shape.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Changes the dash style of every line in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get the type of shape for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type");
+ await context.sync();
+
+ // Change the dash style for shapes of the type `line`.
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.line) {
+ shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: callout
+ uid: powerpoint!PowerPoint.ShapeType.callout:member
+ package: powerpoint!
+ summary: >-
+ The shape is a callout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Callout"'
+ - name: chart
+ uid: powerpoint!PowerPoint.ShapeType.chart:member
+ package: powerpoint!
+ summary: >-
+ The shape is a chart.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Chart"'
+ - name: contentApp
+ uid: powerpoint!PowerPoint.ShapeType.contentApp:member
+ package: powerpoint!
+ summary: >-
+ The shape is a content Office Add-in.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ContentApp"'
+ - name: diagram
+ uid: powerpoint!PowerPoint.ShapeType.diagram:member
+ package: powerpoint!
+ summary: >-
+ The shape is a diagram.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Diagram"'
+ - name: freeform
+ uid: powerpoint!PowerPoint.ShapeType.freeform:member
+ package: powerpoint!
+ summary: >-
+ The shape is a freeform object.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Freeform"'
+ - name: geometricShape
+ uid: powerpoint!PowerPoint.ShapeType.geometricShape:member
+ package: powerpoint!
+ summary: >-
+ The shape is a geometric shape such as rectangle.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"GeometricShape"'
+ - name: graphic
+ uid: powerpoint!PowerPoint.ShapeType.graphic:member
+ package: powerpoint!
+ summary: >-
+ The shape is a graphic.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Graphic"'
+ - name: group
+ uid: powerpoint!PowerPoint.ShapeType.group:member
+ package: powerpoint!
+ summary: >-
+ The shape is a group shape which contains sub-shapes.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Group"'
+ - name: image
+ uid: powerpoint!PowerPoint.ShapeType.image:member
+ package: powerpoint!
+ summary: >-
+ The shape is an image.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Image"'
+ - name: ink
+ uid: powerpoint!PowerPoint.ShapeType.ink:member
+ package: powerpoint!
+ summary: >-
+ The shape is an ink object.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Ink"'
+ - name: line
+ uid: powerpoint!PowerPoint.ShapeType.line:member
+ package: powerpoint!
+ summary: >-
+ The shape is a line.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Line"'
+ - name: media
+ uid: powerpoint!PowerPoint.ShapeType.media:member
+ package: powerpoint!
+ summary: >-
+ The shape is a media object.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Media"'
+ - name: model3D
+ uid: powerpoint!PowerPoint.ShapeType.model3D:member
+ package: powerpoint!
+ summary: >-
+ The shape is a 3D model.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Model3D"'
+ - name: ole
+ uid: powerpoint!PowerPoint.ShapeType.ole:member
+ package: powerpoint!
+ summary: >-
+ The shape is an OLE (Object Linking and Embedding) object.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Ole"'
+ - name: placeholder
+ uid: powerpoint!PowerPoint.ShapeType.placeholder:member
+ package: powerpoint!
+ summary: >-
+ The shape is a placeholder.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Placeholder"'
+ - name: smartArt
+ uid: powerpoint!PowerPoint.ShapeType.smartArt:member
+ package: powerpoint!
+ summary: >-
+ The shape is a SmartArt graphic.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SmartArt"'
+ - name: table
+ uid: powerpoint!PowerPoint.ShapeType.table:member
+ package: powerpoint!
+ summary: >-
+ The shape is a table.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Table"'
+ - name: textBox
+ uid: powerpoint!PowerPoint.ShapeType.textBox:member
+ package: powerpoint!
+ summary: >-
+ The shape is a text box.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextBox"'
+ - name: unsupported
+ uid: powerpoint!PowerPoint.ShapeType.unsupported:member
+ package: powerpoint!
+ summary: >-
+ The given shape's type is unsupported.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapezorder.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapezorder.yml
new file mode 100644
index 0000000000..b159f78a6f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.shapezorder.yml
@@ -0,0 +1,60 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeZOrder
+uid: powerpoint!PowerPoint.ShapeZOrder:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeZOrder
+summary: >-
+ Use with `setZOrder` to move the specified shape up or down the collection's
+ z-order, which shifts it in front of or behind other shapes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bringForward
+ uid: powerpoint!PowerPoint.ShapeZOrder.bringForward:member
+ package: powerpoint!
+ summary: >-
+ Brings the shape forward one spot in the z-order.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BringForward"'
+ - name: bringToFront
+ uid: powerpoint!PowerPoint.ShapeZOrder.bringToFront:member
+ package: powerpoint!
+ summary: >-
+ Brings the shape to the front of the z-order.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BringToFront"'
+ - name: sendBackward
+ uid: powerpoint!PowerPoint.ShapeZOrder.sendBackward:member
+ package: powerpoint!
+ summary: >-
+ Sends the shape backward one spot in the z-order.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SendBackward"'
+ - name: sendToBack
+ uid: powerpoint!PowerPoint.ShapeZOrder.sendToBack:member
+ package: powerpoint!
+ summary: >-
+ Sends the shape to the back of the z-order.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SendToBack"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slide.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slide.yml
new file mode 100644
index 0000000000..10c8471b41
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slide.yml
@@ -0,0 +1,487 @@
+### YamlMime:TSType
+name: PowerPoint.Slide
+uid: powerpoint!PowerPoint.Slide:class
+package: powerpoint!
+fullName: PowerPoint.Slide
+summary: Represents a single slide of a presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Reselects shapes that were saved previously.
+
+ await PowerPoint.run(async (context) => {
+ const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
+ await context.sync();
+ slide1.setSelectedShapes(savedShapeSelection);
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.Slide#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: customXmlParts
+ uid: powerpoint!PowerPoint.Slide#customXmlParts:member
+ package: powerpoint!
+ fullName: customXmlParts
+ summary: Returns a collection of custom XML parts in the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly customXmlParts: PowerPoint.CustomXmlPartCollection;'
+ return:
+ type:
+ - name: hyperlinks
+ uid: powerpoint!PowerPoint.Slide#hyperlinks:member
+ package: powerpoint!
+ fullName: hyperlinks
+ summary: Returns a collection of hyperlinks in the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly hyperlinks: PowerPoint.HyperlinkCollection;'
+ return:
+ type:
+ - name: id
+ uid: powerpoint!PowerPoint.Slide#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: index
+ uid: powerpoint!PowerPoint.Slide#index:member
+ package: powerpoint!
+ fullName: index
+ summary: >-
+ Returns the zero-based index of the slide representing its position in the
+ presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly index: number;'
+ return:
+ type: number
+ - name: layout
+ uid: powerpoint!PowerPoint.Slide#layout:member
+ package: powerpoint!
+ fullName: layout
+ summary: Gets the layout of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly layout: PowerPoint.SlideLayout;'
+ return:
+ type:
+ - name: shapes
+ uid: powerpoint!PowerPoint.Slide#shapes:member
+ package: powerpoint!
+ fullName: shapes
+ summary: Returns a collection of shapes in the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly shapes: PowerPoint.ShapeCollection;'
+ return:
+ type:
+ - name: slideMaster
+ uid: powerpoint!PowerPoint.Slide#slideMaster:member
+ package: powerpoint!
+ fullName: slideMaster
+ summary: Gets the `SlideMaster` object that represents the slide's default content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly slideMaster: PowerPoint.SlideMaster;'
+ return:
+ type:
+ - name: tags
+ uid: powerpoint!PowerPoint.Slide#tags:member
+ package: powerpoint!
+ fullName: tags
+ summary: Returns a collection of tags in the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly tags: PowerPoint.TagCollection;'
+ return:
+ type:
+methods:
+ - name: applyLayout(slideLayout)
+ uid: powerpoint!PowerPoint.Slide#applyLayout:member(1)
+ package: powerpoint!
+ fullName: applyLayout(slideLayout)
+ summary: >-
+ Applies the specified layout to the slide, changing its design and
+ structure according to the chosen layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'applyLayout(slideLayout: PowerPoint.SlideLayout): void;'
+ parameters:
+ - id: slideLayout
+ description: >-
+ The layout to be applied to the slide. This is typically an instance
+ of a predefined layout from the slide master.
+ type:
+ return:
+ type: void
+ description: ''
+ - name: delete()
+ uid: powerpoint!PowerPoint.Slide#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: >-
+ Deletes the slide from the presentation. Does nothing if the slide does
+ not exist.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml
+
+
+ // Deletes the selected slides.
+
+ await PowerPoint.run(async (context) => {
+ context.presentation.load("slides");
+ await context.sync();
+ const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
+ const slideCount = slides.getCount();
+ slides.load("items");
+ await context.sync();
+ slides.items.map((slide) => {
+ slide.delete();
+ });
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: exportAsBase64()
+ uid: powerpoint!PowerPoint.Slide#exportAsBase64:member(1)
+ package: powerpoint!
+ fullName: exportAsBase64()
+ summary: >-
+ Exports the slide to its own presentation file, returned as Base64-encoded
+ data.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'exportAsBase64(): OfficeExtension.ClientResult;'
+ return:
+ type: <string>
+ description: ''
+ - name: getImageAsBase64(options)
+ uid: powerpoint!PowerPoint.Slide#getImageAsBase64:member(1)
+ package: powerpoint!
+ fullName: getImageAsBase64(options)
+ summary: >-
+ Renders an image of the slide. The image is scaled to fit into the desired
+ dimensions. If width and height aren't specified, the true size of the
+ slide is used. If only one of either width or height is specified, the
+ other will be calculated to preserve aspect ratio.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getImageAsBase64(options?: PowerPoint.SlideGetImageOptions):
+ OfficeExtension.ClientResult;
+ parameters:
+ - id: options
+ description: Optional. Options to specify the desired size of the slide image.
+ type:
+ return:
+ type: <string>
+ description: A Base64 string of the slide image in PNG format.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Slide#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.SlideLoadOptions):
+ PowerPoint.Slide;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Slide#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.Slide;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.Slide#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Slide;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: moveTo(slideIndex)
+ uid: powerpoint!PowerPoint.Slide#moveTo:member(1)
+ package: powerpoint!
+ fullName: moveTo(slideIndex)
+ summary: Moves the slide to a new position within the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'moveTo(slideIndex: number): void;'
+ parameters:
+ - id: slideIndex
+ description: The zero-based index where the slide should be moved.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setSelectedShapes(shapeIds)
+ uid: powerpoint!PowerPoint.Slide#setSelectedShapes:member(1)
+ package: powerpoint!
+ fullName: setSelectedShapes(shapeIds)
+ summary: >-
+ Selects the specified shapes. Existing shape selection is replaced with
+ the new selection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Reselects shapes that were saved previously.
+
+ await PowerPoint.run(async (context) => {
+ const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
+ await context.sync();
+ slide1.setSelectedShapes(savedShapeSelection);
+ await context.sync();
+ });
+
+
+ ...
+
+
+ // Selects the first two shapes on slide 1.
+
+ await PowerPoint.run(async (context) => {
+ context.presentation.load("slides");
+ await context.sync();
+ const slide1 = context.presentation.slides.getItemAt(0);
+ slide1.load("shapes");
+ await context.sync();
+ const shapes: PowerPoint.ShapeCollection = slide1.shapes;
+ const shape1: PowerPoint.Shape = shapes.getItemAt(0);
+ const shape2: PowerPoint.Shape = shapes.getItemAt(1);
+ shape1.load("id");
+ shape2.load("id");
+ await context.sync();
+ slide1.setSelectedShapes([shape1.id, shape2.id]);
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSelectedShapes(shapeIds: string[]): void;'
+ parameters:
+ - id: shapeIds
+ description: >-
+ List of shape IDs to select in the slide. If the list is empty, the
+ selection is cleared.
+ type: string[]
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Slide#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidecollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidecollection.yml
new file mode 100644
index 0000000000..334c8c4b50
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidecollection.yml
@@ -0,0 +1,351 @@
+### YamlMime:TSType
+name: PowerPoint.SlideCollection
+uid: powerpoint!PowerPoint.SlideCollection:class
+package: powerpoint!
+fullName: PowerPoint.SlideCollection
+summary: Represents the collection of slides in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ const chosenMaster = (document.getElementById("master-id") as
+ HTMLInputElement).value;
+
+ const chosenLayout = (document.getElementById("layout-id") as
+ HTMLInputElement).value;
+
+
+ await PowerPoint.run(async function(context) {
+ // Create a new slide using an existing master slide and layout.
+ const newSlideOptions: PowerPoint.AddSlideOptions = {
+ slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
+ layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
+ };
+ context.presentation.slides.add(newSlideOptions);
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.SlideCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.Slide[];'
+ return:
+ type: []
+methods:
+ - name: add(options)
+ uid: powerpoint!PowerPoint.SlideCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(options)
+ summary: Adds a new slide at the end of the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ const chosenMaster = (document.getElementById("master-id") as
+ HTMLInputElement).value;
+
+ const chosenLayout = (document.getElementById("layout-id") as
+ HTMLInputElement).value;
+
+
+ await PowerPoint.run(async function(context) {
+ // Create a new slide using an existing master slide and layout.
+ const newSlideOptions: PowerPoint.AddSlideOptions = {
+ slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
+ layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
+ };
+ context.presentation.slides.add(newSlideOptions);
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'add(options?: PowerPoint.AddSlideOptions): void;'
+ parameters:
+ - id: options
+ description: The options that define the theme of the new slide.
+ type:
+ return:
+ type: void
+ description: ''
+ - name: getCount()
+ uid: powerpoint!PowerPoint.SlideCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of slides in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of slides in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.SlideCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: Gets a slide using its unique ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.Slide;'
+ parameters:
+ - id: key
+ description: The ID of the slide.
+ type: string
+ return:
+ type:
+ description: >-
+ The slide with the unique ID. If such a slide does not exist, an error
+ is thrown.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.SlideCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml
+
+
+ // Selects slides 2, 4, and 5.
+
+ await PowerPoint.run(async (context) => {
+ context.presentation.load("slides");
+ await context.sync();
+ const slide2: PowerPoint.Slide = context.presentation.slides.getItemAt(1);
+ const slide4: PowerPoint.Slide = context.presentation.slides.getItemAt(3);
+ const slide5: PowerPoint.Slide = context.presentation.slides.getItemAt(4);
+ slide2.load("id");
+ slide4.load("id");
+ slide5.load("id");
+ try {
+ await context.sync();
+ } catch (error) {
+ console.warn("This action requires at least 5 slides in the presentation.");
+ return;
+ }
+ await context.sync();
+ context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.Slide;'
+ parameters:
+ - id: index
+ description: The index of the slide in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The slide at the given index. An error is thrown if index is out of
+ range.
+ - name: getItemOrNullObject(id)
+ uid: powerpoint!PowerPoint.SlideCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ 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 [*OrNullObject methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.2](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.Slide;'
+ parameters:
+ - id: id
+ description: The ID of the slide.
+ type: string
+ return:
+ type:
+ description: The slide with the unique ID.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.SlideCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.SlideCollection;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.SlideCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.SlideCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidegetimageoptions.yml
new file mode 100644
index 0000000000..a473d8a899
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidegetimageoptions.yml
@@ -0,0 +1,47 @@
+### YamlMime:TSType
+name: PowerPoint.SlideGetImageOptions
+uid: powerpoint!PowerPoint.SlideGetImageOptions:interface
+package: powerpoint!
+fullName: PowerPoint.SlideGetImageOptions
+summary: Represents the available options when getting an image of a slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: height
+ uid: powerpoint!PowerPoint.SlideGetImageOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: The desired height of the resulting image in pixels.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: number;'
+ return:
+ type: number
+ - name: width
+ uid: powerpoint!PowerPoint.SlideGetImageOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: The desired width of the resulting image in pixels.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayout.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayout.yml
new file mode 100644
index 0000000000..6f60caeca7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayout.yml
@@ -0,0 +1,297 @@
+### YamlMime:TSType
+name: PowerPoint.SlideLayout
+uid: powerpoint!PowerPoint.SlideLayout:class
+package: powerpoint!
+fullName: PowerPoint.SlideLayout
+summary: Represents the layout of a slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideLayout#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: customXmlParts
+ uid: powerpoint!PowerPoint.SlideLayout#customXmlParts:member
+ package: powerpoint!
+ fullName: customXmlParts
+ summary: Returns a collection of custom XML parts in the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly customXmlParts: PowerPoint.CustomXmlPartCollection;'
+ return:
+ type:
+ - name: id
+ uid: powerpoint!PowerPoint.SlideLayout#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: name
+ uid: powerpoint!PowerPoint.SlideLayout#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Gets the name of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly name: string;'
+ return:
+ type: string
+ - name: shapes
+ uid: powerpoint!PowerPoint.SlideLayout#shapes:member
+ package: powerpoint!
+ fullName: shapes
+ summary: Returns a collection of shapes in the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly shapes: PowerPoint.ShapeCollection;'
+ return:
+ type:
+ - name: type
+ uid: powerpoint!PowerPoint.SlideLayout#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Returns the type of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" |
+ "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" |
+ "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" |
+ "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" |
+ "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" |
+ "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" |
+ "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" |
+ "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" |
+ "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" |
+ "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" |
+ "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
+ return:
+ type: >-
+ | "Blank" |
+ "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText"
+ | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" |
+ "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" |
+ "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" |
+ "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table"
+ | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" |
+ "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" |
+ "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" |
+ "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" |
+ "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideLayout#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions):
+ PowerPoint.SlideLayout;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideLayout#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.SlideLayout;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.SlideLayout#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideLayout;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideLayout#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideLayoutData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayoutcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayoutcollection.yml
new file mode 100644
index 0000000000..496931a66b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayoutcollection.yml
@@ -0,0 +1,298 @@
+### YamlMime:TSType
+name: PowerPoint.SlideLayoutCollection
+uid: powerpoint!PowerPoint.SlideLayoutCollection:class
+package: powerpoint!
+fullName: PowerPoint.SlideLayoutCollection
+summary: Represents the collection of layouts provided by the Slide Master for slides.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.SlideLayout[];'
+ return:
+ type: []
+methods:
+ - name: getCount()
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of layouts in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of layouts in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: Gets a layout using its unique ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.SlideLayout;'
+ parameters:
+ - id: key
+ description: The ID of the layout.
+ type: string
+ return:
+ type:
+ description: >-
+ The layout with the unique ID. If such a layout does not exist, an
+ error is thrown.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: Gets a layout using its zero-based index in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.SlideLayout;'
+ parameters:
+ - id: index
+ description: The index of the layout in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The layout at the given index. An error is thrown if index is out of
+ range.
+ - name: getItemOrNullObject(id)
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ 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 [*OrNullObject methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.SlideLayout;'
+ parameters:
+ - id: id
+ description: The ID of the layout.
+ type: string
+ return:
+ type:
+ description: The layout with the unique ID.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.SlideLayoutCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNames?: string | string[]):
+ PowerPoint.SlideLayoutCollection;
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: >-
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.SlideLayoutCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideLayoutCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayouttype.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayouttype.yml
new file mode 100644
index 0000000000..88169ff1ff
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidelayouttype.yml
@@ -0,0 +1,421 @@
+### YamlMime:TSEnum
+name: PowerPoint.SlideLayoutType
+uid: powerpoint!PowerPoint.SlideLayoutType:enum
+package: powerpoint!
+fullName: PowerPoint.SlideLayoutType
+summary: Specifies the type of a slide layout.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: blank
+ uid: powerpoint!PowerPoint.SlideLayoutType.blank:member
+ package: powerpoint!
+ summary: >-
+ Blank layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Blank"'
+ - name: chart
+ uid: powerpoint!PowerPoint.SlideLayoutType.chart:member
+ package: powerpoint!
+ summary: >-
+ Chart layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Chart"'
+ - name: chartAndText
+ uid: powerpoint!PowerPoint.SlideLayoutType.chartAndText:member
+ package: powerpoint!
+ summary: >-
+ Chart and text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ChartAndText"'
+ - name: clipArtAndText
+ uid: powerpoint!PowerPoint.SlideLayoutType.clipArtAndText:member
+ package: powerpoint!
+ summary: >-
+ ClipArt and text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ClipArtAndText"'
+ - name: clipArtAndVerticalText
+ uid: powerpoint!PowerPoint.SlideLayoutType.clipArtAndVerticalText:member
+ package: powerpoint!
+ summary: >-
+ ClipArt and vertical text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ClipArtAndVerticalText"'
+ - name: comparison
+ uid: powerpoint!PowerPoint.SlideLayoutType.comparison:member
+ package: powerpoint!
+ summary: >-
+ Comparison layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Comparison"'
+ - name: contentWithCaption
+ uid: powerpoint!PowerPoint.SlideLayoutType.contentWithCaption:member
+ package: powerpoint!
+ summary: >-
+ Content with caption layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ContentWithCaption"'
+ - name: custom
+ uid: powerpoint!PowerPoint.SlideLayoutType.custom:member
+ package: powerpoint!
+ summary: >-
+ Custom layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Custom"'
+ - name: fourObjects
+ uid: powerpoint!PowerPoint.SlideLayoutType.fourObjects:member
+ package: powerpoint!
+ summary: >-
+ Four objects layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FourObjects"'
+ - name: largeObject
+ uid: powerpoint!PowerPoint.SlideLayoutType.largeObject:member
+ package: powerpoint!
+ summary: >-
+ Large object layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LargeObject"'
+ - name: mediaClipAndText
+ uid: powerpoint!PowerPoint.SlideLayoutType.mediaClipAndText:member
+ package: powerpoint!
+ summary: >-
+ MediaClip and text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediaClipAndText"'
+ - name: mixed
+ uid: powerpoint!PowerPoint.SlideLayoutType.mixed:member
+ package: powerpoint!
+ summary: >-
+ Mixed layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Mixed"'
+ - name: object
+ uid: powerpoint!PowerPoint.SlideLayoutType.object:member
+ package: powerpoint!
+ summary: >-
+ Object layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Object"'
+ - name: objectAndText
+ uid: powerpoint!PowerPoint.SlideLayoutType.objectAndText:member
+ package: powerpoint!
+ summary: >-
+ Object and text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ObjectAndText"'
+ - name: objectAndTwoObjects
+ uid: powerpoint!PowerPoint.SlideLayoutType.objectAndTwoObjects:member
+ package: powerpoint!
+ summary: >-
+ Object and two objects layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ObjectAndTwoObjects"'
+ - name: objectOverText
+ uid: powerpoint!PowerPoint.SlideLayoutType.objectOverText:member
+ package: powerpoint!
+ summary: >-
+ Object over text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ObjectOverText"'
+ - name: organizationChart
+ uid: powerpoint!PowerPoint.SlideLayoutType.organizationChart:member
+ package: powerpoint!
+ summary: >-
+ Organization chart layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"OrganizationChart"'
+ - name: pictureWithCaption
+ uid: powerpoint!PowerPoint.SlideLayoutType.pictureWithCaption:member
+ package: powerpoint!
+ summary: >-
+ Picture with caption layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"PictureWithCaption"'
+ - name: sectionHeader
+ uid: powerpoint!PowerPoint.SlideLayoutType.sectionHeader:member
+ package: powerpoint!
+ summary: >-
+ Section header layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SectionHeader"'
+ - name: table
+ uid: powerpoint!PowerPoint.SlideLayoutType.table:member
+ package: powerpoint!
+ summary: >-
+ Table layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Table"'
+ - name: text
+ uid: powerpoint!PowerPoint.SlideLayoutType.text:member
+ package: powerpoint!
+ summary: >-
+ Text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Text"'
+ - name: textAndChart
+ uid: powerpoint!PowerPoint.SlideLayoutType.textAndChart:member
+ package: powerpoint!
+ summary: >-
+ Text and chart layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextAndChart"'
+ - name: textAndClipArt
+ uid: powerpoint!PowerPoint.SlideLayoutType.textAndClipArt:member
+ package: powerpoint!
+ summary: >-
+ Text and ClipArt layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextAndClipArt"'
+ - name: textAndMediaClip
+ uid: powerpoint!PowerPoint.SlideLayoutType.textAndMediaClip:member
+ package: powerpoint!
+ summary: >-
+ Text and MediaClip layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextAndMediaClip"'
+ - name: textAndObject
+ uid: powerpoint!PowerPoint.SlideLayoutType.textAndObject:member
+ package: powerpoint!
+ summary: >-
+ Text and object layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextAndObject"'
+ - name: textAndTwoObjects
+ uid: powerpoint!PowerPoint.SlideLayoutType.textAndTwoObjects:member
+ package: powerpoint!
+ summary: >-
+ Text and two objects layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextAndTwoObjects"'
+ - name: textOverObject
+ uid: powerpoint!PowerPoint.SlideLayoutType.textOverObject:member
+ package: powerpoint!
+ summary: >-
+ Text over object layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextOverObject"'
+ - name: title
+ uid: powerpoint!PowerPoint.SlideLayoutType.title:member
+ package: powerpoint!
+ summary: >-
+ Title layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Title"'
+ - name: titleOnly
+ uid: powerpoint!PowerPoint.SlideLayoutType.titleOnly:member
+ package: powerpoint!
+ summary: >-
+ Title only layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TitleOnly"'
+ - name: twoColumnText
+ uid: powerpoint!PowerPoint.SlideLayoutType.twoColumnText:member
+ package: powerpoint!
+ summary: >-
+ Two-column text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TwoColumnText"'
+ - name: twoObjects
+ uid: powerpoint!PowerPoint.SlideLayoutType.twoObjects:member
+ package: powerpoint!
+ summary: >-
+ Two objects layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TwoObjects"'
+ - name: twoObjectsAndObject
+ uid: powerpoint!PowerPoint.SlideLayoutType.twoObjectsAndObject:member
+ package: powerpoint!
+ summary: >-
+ Two objects and object layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TwoObjectsAndObject"'
+ - name: twoObjectsAndText
+ uid: powerpoint!PowerPoint.SlideLayoutType.twoObjectsAndText:member
+ package: powerpoint!
+ summary: >-
+ Two objects and text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TwoObjectsAndText"'
+ - name: twoObjectsOverText
+ uid: powerpoint!PowerPoint.SlideLayoutType.twoObjectsOverText:member
+ package: powerpoint!
+ summary: >-
+ Two objects over text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TwoObjectsOverText"'
+ - name: verticalText
+ uid: powerpoint!PowerPoint.SlideLayoutType.verticalText:member
+ package: powerpoint!
+ summary: >-
+ Vertical text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"VerticalText"'
+ - name: verticalTitleAndText
+ uid: powerpoint!PowerPoint.SlideLayoutType.verticalTitleAndText:member
+ package: powerpoint!
+ summary: >-
+ Vertical title and text layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"VerticalTitleAndText"'
+ - name: verticalTitleAndTextOverChart
+ uid: powerpoint!PowerPoint.SlideLayoutType.verticalTitleAndTextOverChart:member
+ package: powerpoint!
+ summary: >-
+ Vertical title and text over chart layout.
+
+
+ * \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"VerticalTitleAndTextOverChart"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidemaster.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidemaster.yml
new file mode 100644
index 0000000000..14504b0c41
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidemaster.yml
@@ -0,0 +1,275 @@
+### YamlMime:TSType
+name: PowerPoint.SlideMaster
+uid: powerpoint!PowerPoint.SlideMaster:class
+package: powerpoint!
+fullName: PowerPoint.SlideMaster
+summary: Represents the Slide Master of a slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideMaster#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: customXmlParts
+ uid: powerpoint!PowerPoint.SlideMaster#customXmlParts:member
+ package: powerpoint!
+ fullName: customXmlParts
+ summary: Returns a collection of custom XML parts in the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.7](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly customXmlParts: PowerPoint.CustomXmlPartCollection;'
+ return:
+ type:
+ - name: id
+ uid: powerpoint!PowerPoint.SlideMaster#id:member
+ package: powerpoint!
+ fullName: id
+ summary: Gets the unique ID of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly id: string;'
+ return:
+ type: string
+ - name: layouts
+ uid: powerpoint!PowerPoint.SlideMaster#layouts:member
+ package: powerpoint!
+ fullName: layouts
+ summary: Gets the collection of layouts provided by the Slide Master for slides.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly layouts: PowerPoint.SlideLayoutCollection;'
+ return:
+ type:
+ - name: name
+ uid: powerpoint!PowerPoint.SlideMaster#name:member
+ package: powerpoint!
+ fullName: name
+ summary: Gets the unique name of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly name: string;'
+ return:
+ type: string
+ - name: shapes
+ uid: powerpoint!PowerPoint.SlideMaster#shapes:member
+ package: powerpoint!
+ fullName: shapes
+ summary: Returns a collection of shapes in the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly shapes: PowerPoint.ShapeCollection;'
+ return:
+ type:
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideMaster#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions):
+ PowerPoint.SlideMaster;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideMaster#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.SlideMaster;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.SlideMaster#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideMaster;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideMaster#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideMasterData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidemastercollection.yml
new file mode 100644
index 0000000000..0b7af1f7ff
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidemastercollection.yml
@@ -0,0 +1,298 @@
+### YamlMime:TSType
+name: PowerPoint.SlideMasterCollection
+uid: powerpoint!PowerPoint.SlideMasterCollection:class
+package: powerpoint!
+fullName: PowerPoint.SlideMasterCollection
+summary: Represents the collection of Slide Masters in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideMasterCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.SlideMasterCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.SlideMaster[];'
+ return:
+ type: []
+methods:
+ - name: getCount()
+ uid: powerpoint!PowerPoint.SlideMasterCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of Slide Masters in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of Slide Masters in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.SlideMasterCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: Gets a Slide Master using its unique ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.SlideMaster;'
+ parameters:
+ - id: key
+ description: The ID of the Slide Master.
+ type: string
+ return:
+ type:
+ description: >-
+ The Slide Master with the unique ID. If such a Slide Master does not
+ exist, an error is thrown.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.SlideMasterCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: Gets a Slide Master using its zero-based index in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.SlideMaster;'
+ parameters:
+ - id: index
+ description: The index of the Slide Master in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The Slide Master at the given index. An error is thrown if index is
+ out of range.
+ - name: getItemOrNullObject(id)
+ uid: powerpoint!PowerPoint.SlideMasterCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ 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 [*OrNullObject methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.SlideMaster;'
+ parameters:
+ - id: id
+ description: The ID of the Slide Master.
+ type: string
+ return:
+ type:
+ description: The Slide Master with the unique ID.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideMasterCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.SlideMasterCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.SlideMasterCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideMasterCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNames?: string | string[]):
+ PowerPoint.SlideMasterCollection;
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: >-
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ // Load information about all the slide masters and associated layouts.
+ const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
+ await context.sync();
+
+ // Log the name and ID of each slide master.
+ for (let i = 0; i < slideMasters.items.length; i++) {
+ console.log("Master name: " + slideMasters.items[i].name);
+ console.log("Master ID: " + slideMasters.items[i].id);
+
+ // Log the name and ID of each slide layout in the slide master.
+ const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
+ for (let j = 0; j < layoutsInMaster.items.length; j++) {
+ console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
+ }
+ }
+ });
+
+ ```
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.SlideMasterCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.SlideMasterCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideMasterCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidescopedcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidescopedcollection.yml
new file mode 100644
index 0000000000..be11d8a2ea
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidescopedcollection.yml
@@ -0,0 +1,272 @@
+### YamlMime:TSType
+name: PowerPoint.SlideScopedCollection
+uid: powerpoint!PowerPoint.SlideScopedCollection:class
+package: powerpoint!
+fullName: PowerPoint.SlideScopedCollection
+summary: Represents a collection of slides in the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
+
+
+ // Saves which shapes are selected so that they can be reselected later.
+
+ await PowerPoint.run(async (context) => {
+ context.presentation.load("slides");
+ await context.sync();
+ const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
+ const slideCount = slides.getCount();
+ slides.load("items");
+ await context.sync();
+ savedSlideSelection = [];
+ slides.items.map((slide) => {
+ savedSlideSelection.push(slide.id);
+ });
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+ shapes.items.map((shape) => {
+ savedShapeSelection.push(shape.id);
+ });
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideScopedCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.SlideScopedCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.Slide[];'
+ return:
+ type: []
+methods:
+ - name: getCount()
+ uid: powerpoint!PowerPoint.SlideScopedCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of slides in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of slides in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.SlideScopedCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: Gets a slide using its unique ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.Slide;'
+ parameters:
+ - id: key
+ description: The ID of the slide.
+ type: string
+ return:
+ type:
+ description: >-
+ The slide with the unique ID. If such a slide does not exist, an error
+ is thrown.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.SlideScopedCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: Gets a slide using its zero-based index in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.Slide;'
+ parameters:
+ - id: index
+ description: The index of the slide in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The slide at the given index. An error is thrown if index is out of
+ range.
+ - name: getItemOrNullObject(id)
+ uid: powerpoint!PowerPoint.SlideScopedCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(id)
+ summary: >-
+ 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 [*OrNullObject methods and
+ properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(id: string): PowerPoint.Slide;'
+ parameters:
+ - id: id
+ description: The ID of the slide.
+ type: string
+ return:
+ type:
+ description: The slide with the unique ID.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideScopedCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.SlideScopedCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideScopedCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNames?: string | string[]):
+ PowerPoint.SlideScopedCollection;
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.SlideScopedCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.SlideScopedCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideScopedCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.table.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.table.yml
new file mode 100644
index 0000000000..9569038a47
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.table.yml
@@ -0,0 +1,244 @@
+### YamlMime:TSType
+name: PowerPoint.Table
+uid: powerpoint!PowerPoint.Table:class
+package: powerpoint!
+fullName: PowerPoint.Table
+summary: Represents a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: columnCount
+ uid: powerpoint!PowerPoint.Table#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: Gets the number of columns in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly columnCount: number;'
+ return:
+ type: number
+ - name: context
+ uid: powerpoint!PowerPoint.Table#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: rowCount
+ uid: powerpoint!PowerPoint.Table#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: Gets the number of rows in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly rowCount: number;'
+ return:
+ type: number
+ - name: values
+ uid: powerpoint!PowerPoint.Table#values:member
+ package: powerpoint!
+ fullName: values
+ summary: Gets all of the values in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly values: string[][];'
+ return:
+ type: string[][]
+methods:
+ - name: getCellOrNullObject(rowIndex, columnIndex)
+ uid: powerpoint!PowerPoint.Table#getCellOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getCellOrNullObject(rowIndex, columnIndex)
+ summary: Gets the cell at the specified `rowIndex` and `columnIndex`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getCellOrNullObject(rowIndex: number, columnIndex: number):
+ PowerPoint.TableCell;
+ parameters:
+ - id: rowIndex
+ description: The zero-based row index of the cell.
+ type: number
+ - id: columnIndex
+ description: The zero-based column index of the cell.
+ type: number
+ return:
+ type:
+ description: >-
+ The cell at the specified row and column. If the cell is part of a
+ merged area and not the top left cell of the merged area, an object
+ with the `isNullObject` property set to `true` is returned.
+ - name: getMergedAreas()
+ uid: powerpoint!PowerPoint.Table#getMergedAreas:member(1)
+ package: powerpoint!
+ fullName: getMergedAreas()
+ summary: Gets a collection of cells that represent the merged areas of the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMergedAreas(): PowerPoint.TableCellCollection;'
+ return:
+ type:
+ description: >-
+ a `TableCellCollection` with cells that represent the merged areas of
+ the table.
+ - name: getShape()
+ uid: powerpoint!PowerPoint.Table#getShape:member(1)
+ package: powerpoint!
+ fullName: getShape()
+ summary: Gets the shape object for the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShape(): PowerPoint.Shape;'
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Table#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.TableLoadOptions):
+ PowerPoint.Table;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Table#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.Table;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.Table#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Table;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Table#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original `PowerPoint.Table`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.TableData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TableData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tableaddoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tableaddoptions.yml
new file mode 100644
index 0000000000..f72f369e5d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tableaddoptions.yml
@@ -0,0 +1,227 @@
+### YamlMime:TSType
+name: PowerPoint.TableAddOptions
+uid: powerpoint!PowerPoint.TableAddOptions:interface
+package: powerpoint!
+fullName: PowerPoint.TableAddOptions
+summary: Represents the available options when adding a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: columns
+ uid: powerpoint!PowerPoint.TableAddOptions#columns:member
+ package: powerpoint!
+ fullName: columns
+ summary: >-
+ If provided, specifies properties for each column in the table. The array
+ length must be equal to the number of columns in the table. Specify an
+ empty object for columns that should use the default formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columns?: PowerPoint.TableColumnProperties[];'
+ return:
+ type: []
+ - name: height
+ uid: powerpoint!PowerPoint.TableAddOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height, in points, of the table. A default value is used
+ when this parameter is not provided. Throws an `InvalidArgument` exception
+ when set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: left
+ uid: powerpoint!PowerPoint.TableAddOptions#left:member
+ package: powerpoint!
+ fullName: left
+ summary: >-
+ Specifies the distance, in points, from the left side of the table to the
+ left side of the slide. The table is centered horizontally when this
+ parameter is not provided.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: mergedAreas
+ uid: powerpoint!PowerPoint.TableAddOptions#mergedAreas:member
+ package: powerpoint!
+ fullName: mergedAreas
+ summary: >-
+ If specified, represents an rectangular area where multiple cells appear
+ as a single cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'mergedAreas?: PowerPoint.TableMergedAreaProperties[];'
+ return:
+ type: >-
+ []
+ - name: rows
+ uid: powerpoint!PowerPoint.TableAddOptions#rows:member
+ package: powerpoint!
+ fullName: rows
+ summary: >-
+ If provided, specifies properties for each row in the table. The array
+ length must be equal to the number of rows in the table. Specify an empty
+ object for rows that should use the default formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rows?: PowerPoint.TableRowProperties[];'
+ return:
+ type: []
+ - name: specificCellProperties
+ uid: powerpoint!PowerPoint.TableAddOptions#specificCellProperties:member
+ package: powerpoint!
+ fullName: specificCellProperties
+ summary: >-
+ If provided, specifies properties for each cell in the table.
+
+
+ This should be an 2D array with the same number of rows and columns as the
+ table. If a cell does not require specific formatting, specify an empty
+ object for that cell. Only the top left cell of a merged are can have
+ properties specified, which will be applied to the entire merged area. For
+ the other cells in the merged area, an empty object should be provided.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'specificCellProperties?: PowerPoint.TableCellProperties[][];'
+ return:
+ type: [][]
+ - name: top
+ uid: powerpoint!PowerPoint.TableAddOptions#top:member
+ package: powerpoint!
+ fullName: top
+ summary: >-
+ Specifies the distance, in points, from the top edge of the table to the
+ top edge of the slide. A default value is used when this parameter is not
+ provided.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: uniformCellProperties
+ uid: powerpoint!PowerPoint.TableAddOptions#uniformCellProperties:member
+ package: powerpoint!
+ fullName: uniformCellProperties
+ summary: >-
+ Specifies the formatting which applies uniformly to all of the table
+ cells.
+
+
+ To apply specific formatting to individual cells, use
+ specificCellProperties.
+
+
+ If both uniformCellProperties and specificCellProperties are undefined,
+ the default formatting will be used, and the default table style will be
+ applied. The table will have the same appearance as when the user adds a
+ table through the PowerPoint UI.
+
+
+ To provide a plain appearance for the table, set this property to an empty
+ object and do not specify specificCellProperties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'uniformCellProperties?: PowerPoint.TableCellProperties;'
+ return:
+ type:
+ - name: values
+ uid: powerpoint!PowerPoint.TableAddOptions#values:member
+ package: powerpoint!
+ fullName: values
+ summary: >-
+ If provided, specifies the values for the table.
+
+
+ When the table contains areas of merged cells, only the top left cell of
+ each merged area can have a non-empty string value. The other cells in the
+ merged area must be an empty string.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'values?: string[][];'
+ return:
+ type: string[][]
+ - name: width
+ uid: powerpoint!PowerPoint.TableAddOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Specifies the width, in points, of the table. A default value is used when
+ this parameter is not provided. Throws an `InvalidArgument` exception when
+ set with a negative value.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecell.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecell.yml
new file mode 100644
index 0000000000..7d3035cd64
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecell.yml
@@ -0,0 +1,219 @@
+### YamlMime:TSType
+name: PowerPoint.TableCell
+uid: powerpoint!PowerPoint.TableCell:class
+package: powerpoint!
+fullName: PowerPoint.TableCell
+summary: Represents a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: columnCount
+ uid: powerpoint!PowerPoint.TableCell#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: >-
+ Gets the number of table columns this cell spans across. Will be greater
+ than or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly columnCount: number;'
+ return:
+ type: number
+ - name: columnIndex
+ uid: powerpoint!PowerPoint.TableCell#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: Gets the zero-based column index of the cell within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly columnIndex: number;'
+ return:
+ type: number
+ - name: context
+ uid: powerpoint!PowerPoint.TableCell#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: rowCount
+ uid: powerpoint!PowerPoint.TableCell#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: >-
+ Gets the number of table rows this cell spans across. Will be greater than
+ or equal to 1.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly rowCount: number;'
+ return:
+ type: number
+ - name: rowIndex
+ uid: powerpoint!PowerPoint.TableCell#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: Gets the zero-based row index of the cell within the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly rowIndex: number;'
+ return:
+ type: number
+ - name: text
+ uid: powerpoint!PowerPoint.TableCell#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Specifies the text content of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text: string;'
+ return:
+ type: string
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TableCell#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.TableCellLoadOptions):
+ PowerPoint.TableCell;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TableCell#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.TableCell;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.TableCell#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.TableCell;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.TableCell#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original `PowerPoint.TableCell`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.TableCellData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TableCellData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellborders.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellborders.yml
new file mode 100644
index 0000000000..595fa52a23
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellborders.yml
@@ -0,0 +1,111 @@
+### YamlMime:TSType
+name: PowerPoint.TableCellBorders
+uid: powerpoint!PowerPoint.TableCellBorders:interface
+package: powerpoint!
+fullName: PowerPoint.TableCellBorders
+summary: Represents the borders of a table cell.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: bottom
+ uid: powerpoint!PowerPoint.TableCellBorders#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Represents the bottom border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottom?: PowerPoint.BorderProperties;'
+ return:
+ type:
+ - name: diagonalDown
+ uid: powerpoint!PowerPoint.TableCellBorders#diagonalDown:member
+ package: powerpoint!
+ fullName: diagonalDown
+ summary: Represents the diagonal border (top-left to bottom-right).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'diagonalDown?: PowerPoint.BorderProperties;'
+ return:
+ type:
+ - name: diagonalUp
+ uid: powerpoint!PowerPoint.TableCellBorders#diagonalUp:member
+ package: powerpoint!
+ fullName: diagonalUp
+ summary: Represents the diagonal border (bottom-left to top-right).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'diagonalUp?: PowerPoint.BorderProperties;'
+ return:
+ type:
+ - name: left
+ uid: powerpoint!PowerPoint.TableCellBorders#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Represents the left border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: PowerPoint.BorderProperties;'
+ return:
+ type:
+ - name: right
+ uid: powerpoint!PowerPoint.TableCellBorders#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Represents the right border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'right?: PowerPoint.BorderProperties;'
+ return:
+ type:
+ - name: top
+ uid: powerpoint!PowerPoint.TableCellBorders#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Represents the top border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: PowerPoint.BorderProperties;'
+ return:
+ type:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellcollection.yml
new file mode 100644
index 0000000000..e8c75af482
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellcollection.yml
@@ -0,0 +1,198 @@
+### YamlMime:TSType
+name: PowerPoint.TableCellCollection
+uid: powerpoint!PowerPoint.TableCellCollection:class
+package: powerpoint!
+fullName: PowerPoint.TableCellCollection
+summary: Represents a collection of table cells.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.TableCellCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.TableCellCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.TableCell[];'
+ return:
+ type: []
+methods:
+ - name: getCount()
+ uid: powerpoint!PowerPoint.TableCellCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of table cells in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of table cells in the collection.
+ - name: getItemAtOrNullObject(row, column)
+ uid: powerpoint!PowerPoint.TableCellCollection#getItemAtOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemAtOrNullObject(row, column)
+ summary: >-
+ Gets the table cell using its zero-based index in the collection. If the
+ `TableCell` does not exist, then this method returns an object with its
+ `isNullObject` property set to `true`. For further information,
+ see .
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getItemAtOrNullObject(row: number, column: number):
+ PowerPoint.TableCell;
+ parameters:
+ - id: row
+ description: >-
+ Row index value of the table cell to be retrieved, as a zero-based
+ index.
+ type: number
+ - id: column
+ description: >-
+ Column index value of the table cell to be retrieved, as a
+ zero-based index.
+ type: number
+ return:
+ type:
+ description: The `TableCell` object.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TableCellCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.TableCellCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.TableCellCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TableCellCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.TableCellCollection;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.TableCellCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.TableCellCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.TableCellCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's passed to it.) Whereas the original
+ `PowerPoint.TableCellCollection` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.TableCellCollectionData`) that contains an
+ "items" array with shallow copies of any loaded properties from the
+ collection's items.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TableCellCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellmargins.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellmargins.yml
new file mode 100644
index 0000000000..c8181d43c9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellmargins.yml
@@ -0,0 +1,79 @@
+### YamlMime:TSType
+name: PowerPoint.TableCellMargins
+uid: powerpoint!PowerPoint.TableCellMargins:interface
+package: powerpoint!
+fullName: PowerPoint.TableCellMargins
+summary: Represents the margins of a table cell.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: bottom
+ uid: powerpoint!PowerPoint.TableCellMargins#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Specifies the bottom margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottom?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: left
+ uid: powerpoint!PowerPoint.TableCellMargins#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Specifies the left margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: right
+ uid: powerpoint!PowerPoint.TableCellMargins#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Specifies the right margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'right?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: top
+ uid: powerpoint!PowerPoint.TableCellMargins#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Specifies the top margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellproperties.yml
new file mode 100644
index 0000000000..f6aadb8ee8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecellproperties.yml
@@ -0,0 +1,179 @@
+### YamlMime:TSType
+name: PowerPoint.TableCellProperties
+uid: powerpoint!PowerPoint.TableCellProperties:interface
+package: powerpoint!
+fullName: PowerPoint.TableCellProperties
+summary: Represents the table cell properties to update.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: borders
+ uid: powerpoint!PowerPoint.TableCellProperties#borders:member
+ package: powerpoint!
+ fullName: borders
+ summary: Specifies the border formatting of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'borders?: PowerPoint.TableCellBorders;'
+ return:
+ type:
+ - name: fill
+ uid: powerpoint!PowerPoint.TableCellProperties#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Specifies the fill formatting of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.FillProperties;'
+ return:
+ type:
+ - name: font
+ uid: powerpoint!PowerPoint.TableCellProperties#font:member
+ package: powerpoint!
+ fullName: font
+ summary: Specifies the font formatting of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'font?: PowerPoint.FontProperties;'
+ return:
+ type:
+ - name: horizontalAlignment
+ uid: powerpoint!PowerPoint.TableCellProperties#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: Represents the horizontal alignment of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" |
+ "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" |
+ "ThaiDistributed" | undefined;
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed" | undefined
+ - name: indentLevel
+ uid: powerpoint!PowerPoint.TableCellProperties#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: Represents the indent level of the text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: number | undefined;'
+ return:
+ type: number | undefined
+ - name: margins
+ uid: powerpoint!PowerPoint.TableCellProperties#margins:member
+ package: powerpoint!
+ fullName: margins
+ summary: Specifies the margin settings in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'margins?: PowerPoint.TableCellMargins;'
+ return:
+ type:
+ - name: text
+ uid: powerpoint!PowerPoint.TableCellProperties#text:member
+ package: powerpoint!
+ fullName: text
+ summary: >-
+ Specifies the text content of the table cell.
+
+
+ If a portion of the text requires different formatting, use the `textRuns`
+ property instead.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text?: string;'
+ return:
+ type: string
+ - name: textRuns
+ uid: powerpoint!PowerPoint.TableCellProperties#textRuns:member
+ package: powerpoint!
+ fullName: textRuns
+ summary: >-
+ Specifies the contents of the table cell as an array of objects. Each
+ `TextRun` object represents a sequence of one or more characters that
+ share the same font attributes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textRuns?: PowerPoint.TextRun[];'
+ return:
+ type: []
+ - name: verticalAlignment
+ uid: powerpoint!PowerPoint.TableCellProperties#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: Represents the vertical alignment of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle"
+ | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" |
+ undefined;
+ return:
+ type: >-
+ |
+ "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" |
+ "BottomCentered" | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecolumnproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecolumnproperties.yml
new file mode 100644
index 0000000000..c400c2cbe8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablecolumnproperties.yml
@@ -0,0 +1,38 @@
+### YamlMime:TSType
+name: PowerPoint.TableColumnProperties
+uid: powerpoint!PowerPoint.TableColumnProperties:interface
+package: powerpoint!
+fullName: PowerPoint.TableColumnProperties
+summary: Provides the table column properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: columnWidth
+ uid: powerpoint!PowerPoint.TableColumnProperties#columnWidth:member
+ package: powerpoint!
+ fullName: columnWidth
+ summary: >-
+ Represents the desired width of each column in points, or is undefined.
+
+
+ When a table is being added, for columns whose width is undefined, the
+ column width will be calculated by evenly dividing the remaining width of
+ the table amongst those columns. If the table does not have a defined
+ width, a default column width will be used.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnWidth?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablemergedareaproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablemergedareaproperties.yml
new file mode 100644
index 0000000000..e724763572
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablemergedareaproperties.yml
@@ -0,0 +1,87 @@
+### YamlMime:TSType
+name: PowerPoint.TableMergedAreaProperties
+uid: powerpoint!PowerPoint.TableMergedAreaProperties:interface
+package: powerpoint!
+fullName: PowerPoint.TableMergedAreaProperties
+summary: Represents the properties of a merged area of cells in a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: columnCount
+ uid: powerpoint!PowerPoint.TableMergedAreaProperties#columnCount:member
+ package: powerpoint!
+ fullName: columnCount
+ summary: >-
+ Specifies the number of columns for the merged cells area. Must be 1 or
+ greater.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnCount: number;'
+ return:
+ type: number
+ - name: columnIndex
+ uid: powerpoint!PowerPoint.TableMergedAreaProperties#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: >-
+ Specifies the zero-based index of the column of the top left cell of the
+ merged area.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnIndex: number;'
+ return:
+ type: number
+ - name: rowCount
+ uid: powerpoint!PowerPoint.TableMergedAreaProperties#rowCount:member
+ package: powerpoint!
+ fullName: rowCount
+ summary: >-
+ Specifies the number of rows for the merged cells area. Must be 1 or
+ greater.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowCount: number;'
+ return:
+ type: number
+ - name: rowIndex
+ uid: powerpoint!PowerPoint.TableMergedAreaProperties#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: >-
+ Specifies the zero-based index of the row of the top left cell of the
+ merged area.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowIndex: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablerowproperties.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablerowproperties.yml
new file mode 100644
index 0000000000..3099aee473
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tablerowproperties.yml
@@ -0,0 +1,38 @@
+### YamlMime:TSType
+name: PowerPoint.TableRowProperties
+uid: powerpoint!PowerPoint.TableRowProperties:interface
+package: powerpoint!
+fullName: PowerPoint.TableRowProperties
+summary: Provides the table row properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: rowHeight
+ uid: powerpoint!PowerPoint.TableRowProperties#rowHeight:member
+ package: powerpoint!
+ fullName: rowHeight
+ summary: >-
+ Represents the desired height of each row in points, or is undefined.
+
+
+ When a table is being added, for rows whose height is undefined, the row
+ height will be calculated by evenly dividing the remaining height of the
+ table amongst those rows. If the table does not have a defined height, a
+ default row height will be used.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowHeight?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tag.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tag.yml
new file mode 100644
index 0000000000..711c4e840c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tag.yml
@@ -0,0 +1,190 @@
+### YamlMime:TSType
+name: PowerPoint.Tag
+uid: powerpoint!PowerPoint.Tag:class
+package: powerpoint!
+fullName: PowerPoint.Tag
+summary: Represents a single tag in the slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml
+
+
+ await PowerPoint.run(async function (context) {
+ let presentationTags: PowerPoint.TagCollection = context.presentation.tags;
+ presentationTags.add("COLOR", "blue");
+
+ await context.sync();
+
+ const tag: PowerPoint.Tag = presentationTags.getItem("COLOR");
+ tag.load("key, value");
+
+ await context.sync();
+
+ console.log("Added key " + JSON.stringify(tag.key) + " with value " + JSON.stringify(tag.value));
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.Tag#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: key
+ uid: powerpoint!PowerPoint.Tag#key:member
+ package: powerpoint!
+ fullName: key
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly key: string;'
+ return:
+ type: string
+ - name: value
+ uid: powerpoint!PowerPoint.Tag#value:member
+ package: powerpoint!
+ fullName: value
+ summary: Gets the value of the tag.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'value: string;'
+ return:
+ type: string
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Tag#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(options?: PowerPoint.Interfaces.TagLoadOptions): PowerPoint.Tag;'
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Tag#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.Tag;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.Tag#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Tag;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Tag#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TagData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tagcollection.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tagcollection.yml
new file mode 100644
index 0000000000..210ee0d154
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.tagcollection.yml
@@ -0,0 +1,405 @@
+### YamlMime:TSType
+name: PowerPoint.TagCollection
+uid: powerpoint!PowerPoint.TagCollection:class
+package: powerpoint!
+fullName: PowerPoint.TagCollection
+summary: Represents the collection of tags.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ let selectedSlideIndex = await getSelectedSlideIndex();
+
+ // Decrement because the getSelectedSlideByIndex method is 1-based,
+ // but the getItemAt method is 0-based.
+ selectedSlideIndex = selectedSlideIndex - 1;
+ const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(selectedSlideIndex);
+ slide.tags.add("CUSTOMER_TYPE", "Premium");
+
+ await context.sync();
+
+ const audienceTag: PowerPoint.Tag = slide.tags.getItem("CUSTOMER_TYPE");
+ audienceTag.load("key, value");
+
+ await context.sync();
+
+ console.log("Added key " + JSON.stringify(audienceTag.key) + " with value " + JSON.stringify(audienceTag.value));
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.TagCollection#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: items
+ uid: powerpoint!PowerPoint.TagCollection#items:member
+ package: powerpoint!
+ fullName: items
+ summary: Gets the loaded child items in this collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly items: PowerPoint.Tag[];'
+ return:
+ type: []
+methods:
+ - name: add(key, value)
+ uid: powerpoint!PowerPoint.TagCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(key, value)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
+ slide.tags.add("OCEAN", "Indian");
+ slide.tags.add("PLANET", "Jupiter");
+ slide.tags.add("CONTINENT", "Antarctica");
+
+ await context.sync();
+
+ slide.tags.load("key, value");
+
+ await context.sync();
+
+ for (let i = 0; i < slide.tags.items.length; i++) {
+ console.log("Added key " + JSON.stringify(slide.tags.items[i].key) + " with value " + JSON.stringify(slide.tags.items[i].value));
+ }
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'add(key: string, value: string): void;'
+ parameters:
+ - id: key
+ description: >-
+ 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.
+ type: string
+ - id: value
+ description: The value of the tag.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: delete(key)
+ uid: powerpoint!PowerPoint.TagCollection#delete:member(1)
+ package: powerpoint!
+ fullName: delete(key)
+ summary: >-
+ Deletes the tag with the given `key` in this collection. Does nothing if
+ the `key` does not exist.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml
+
+
+ await PowerPoint.run(async function (context) {
+ let presentationTags: PowerPoint.TagCollection = context.presentation.tags;
+
+ presentationTags.delete("COLOR");
+
+ await context.sync();
+
+ console.log(JSON.stringify(presentationTags));
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(key: string): void;'
+ parameters:
+ - id: key
+ description: >-
+ The unique ID of a tag, which is unique within this
+ `TagCollection`. `key` parameter is case-insensitive.
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: getCount()
+ uid: powerpoint!PowerPoint.TagCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of tags in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getCount(): OfficeExtension.ClientResult;'
+ return:
+ type: <number>
+ description: The number of tags in the collection.
+ - name: getItem(key)
+ uid: powerpoint!PowerPoint.TagCollection#getItem:member(1)
+ package: powerpoint!
+ fullName: getItem(key)
+ summary: >-
+ Gets a tag using its unique ID. An error is thrown if the tag does not
+ exist.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/tags/tags.yaml
+
+
+ await PowerPoint.run(async function(context) {
+ let selectedSlideIndex = await getSelectedSlideIndex();
+
+ // Decrement because the getSelectedSlideByIndex method is 1-based,
+ // but the getItemAt method is 0-based.
+ selectedSlideIndex = selectedSlideIndex - 1;
+ const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(selectedSlideIndex);
+ slide.tags.add("CUSTOMER_TYPE", "Premium");
+
+ await context.sync();
+
+ const audienceTag: PowerPoint.Tag = slide.tags.getItem("CUSTOMER_TYPE");
+ audienceTag.load("key, value");
+
+ await context.sync();
+
+ console.log("Added key " + JSON.stringify(audienceTag.key) + " with value " + JSON.stringify(audienceTag.value));
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItem(key: string): PowerPoint.Tag;'
+ parameters:
+ - id: key
+ description: The ID of the tag.
+ type: string
+ return:
+ type:
+ description: >-
+ The tag with the unique ID. If such a tag does not exist, an error is
+ thrown.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.TagCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.Tag;'
+ parameters:
+ - id: index
+ description: The index of the tag in the collection.
+ type: number
+ return:
+ type:
+ description: >-
+ The tag at the given index. An error is thrown if index is out of
+ range.
+ - name: getItemOrNullObject(key)
+ uid: powerpoint!PowerPoint.TagCollection#getItemOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getItemOrNullObject(key)
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemOrNullObject(key: string): PowerPoint.Tag;'
+ parameters:
+ - id: key
+ description: The ID of the tag.
+ type: string
+ return:
+ type:
+ description: >-
+ The tag with the unique ID. If such a tag does not exist, an object
+ with an `isNullObject` property set to true is returned.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TagCollection#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TagCollection#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.TagCollection;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.TagCollection#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption):
+ PowerPoint.TagCollection;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type:
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.TagCollection#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TagCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textframe.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textframe.yml
new file mode 100644
index 0000000000..ff73287cdb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textframe.yml
@@ -0,0 +1,377 @@
+### YamlMime:TSType
+name: PowerPoint.TextFrame
+uid: powerpoint!PowerPoint.TextFrame:class
+package: powerpoint!
+fullName: PowerPoint.TextFrame
+summary: Represents the text frame of a shape object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Selects the first 10 characters of the selected shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ await context.sync();
+ if (shapeCount.value !== 1) {
+ console.warn("You must select only one shape with text in it.");
+ return;
+ }
+ const shape: PowerPoint.Shape = shapes.getItemAt(0);
+ const textFrame: PowerPoint.TextFrame = shape.textFrame.load("textRange,hasText");
+ await context.sync();
+ if (textFrame.hasText != true) {
+ console.warn("You must select only one shape with text in it.");
+ return;
+ }
+ const textRange: PowerPoint.TextRange = textFrame.textRange;
+ textRange.load("text");
+ await context.sync();
+ if (textRange.text.length < 10) {
+ console.warn("You must select only one shape with at least 10 characters in it.");
+ return;
+ }
+ const textRange10 = textRange.getSubstring(0, 10);
+ textRange10.setSelected();
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: autoSizeSetting
+ uid: powerpoint!PowerPoint.TextFrame#autoSizeSetting:member
+ package: powerpoint!
+ fullName: autoSizeSetting
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" |
+ "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
+ return:
+ type: >-
+ |
+ "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" |
+ "AutoSizeMixed"
+ - name: bottomMargin
+ uid: powerpoint!PowerPoint.TextFrame#bottomMargin:member
+ package: powerpoint!
+ fullName: bottomMargin
+ summary: Represents the bottom margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottomMargin: number;'
+ return:
+ type: number
+ - name: context
+ uid: powerpoint!PowerPoint.TextFrame#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: hasText
+ uid: powerpoint!PowerPoint.TextFrame#hasText:member
+ package: powerpoint!
+ fullName: hasText
+ summary: Specifies if the text frame contains text.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly hasText: boolean;'
+ return:
+ type: boolean
+ - name: leftMargin
+ uid: powerpoint!PowerPoint.TextFrame#leftMargin:member
+ package: powerpoint!
+ fullName: leftMargin
+ summary: Represents the left margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'leftMargin: number;'
+ return:
+ type: number
+ - name: rightMargin
+ uid: powerpoint!PowerPoint.TextFrame#rightMargin:member
+ package: powerpoint!
+ fullName: rightMargin
+ summary: Represents the right margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rightMargin: number;'
+ return:
+ type: number
+ - name: textRange
+ uid: powerpoint!PowerPoint.TextFrame#textRange:member
+ package: powerpoint!
+ fullName: textRange
+ summary: >-
+ Represents the text that is attached to a shape in the text frame, and
+ properties and methods for manipulating the text. See
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class) for
+ details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly textRange: PowerPoint.TextRange;'
+ return:
+ type:
+ - name: topMargin
+ uid: powerpoint!PowerPoint.TextFrame#topMargin:member
+ package: powerpoint!
+ fullName: topMargin
+ summary: Represents the top margin, in points, of the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'topMargin: number;'
+ return:
+ type: number
+ - name: verticalAlignment
+ uid: powerpoint!PowerPoint.TextFrame#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: >-
+ Represents the vertical alignment of the text frame. See
+ [PowerPoint.TextVerticalAlignment](xref:powerpoint!PowerPoint.TextVerticalAlignment:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" |
+ "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ return:
+ type: >-
+ |
+ "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" |
+ "BottomCentered"
+ - name: wordWrap
+ uid: powerpoint!PowerPoint.TextFrame#wordWrap:member
+ package: powerpoint!
+ fullName: wordWrap
+ summary: Determines whether lines break automatically to fit text inside the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'wordWrap: boolean;'
+ return:
+ type: boolean
+methods:
+ - name: deleteText()
+ uid: powerpoint!PowerPoint.TextFrame#deleteText:member(1)
+ package: powerpoint!
+ fullName: deleteText()
+ summary: Deletes all the text in the text frame.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'deleteText(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getParentShape()
+ uid: powerpoint!PowerPoint.TextFrame#getParentShape:member(1)
+ package: powerpoint!
+ fullName: getParentShape()
+ summary: >-
+ Returns the parent
+ [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class) object that
+ holds this `TextFrame`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentShape(): PowerPoint.Shape;'
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TextFrame#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.TextFrameLoadOptions):
+ PowerPoint.TextFrame;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TextFrame#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.TextFrame;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.TextFrame#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.TextFrame;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.TextFrame#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TextFrameData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textrange.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textrange.yml
new file mode 100644
index 0000000000..05b90f7f60
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textrange.yml
@@ -0,0 +1,391 @@
+### YamlMime:TSType
+name: PowerPoint.TextRange
+uid: powerpoint!PowerPoint.TextRange:class
+package: powerpoint!
+fullName: PowerPoint.TextRange
+summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Sets the color of the selected text range to green.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.font.color = "green";
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.TextRange#context:member
+ package: powerpoint!
+ fullName: context
+ summary: >-
+ The request context associated with the object. This connects the add-in's
+ process to the Office host application's process.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'context: RequestContext;'
+ return:
+ type:
+ - name: font
+ uid: powerpoint!PowerPoint.TextRange#font:member
+ package: powerpoint!
+ fullName: font
+ summary: >-
+ Returns a `ShapeFont` object that represents the font attributes for the
+ text range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Sets the color of the selected text range to green.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.font.color = "green";
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly font: PowerPoint.ShapeFont;'
+ return:
+ type:
+ - name: length
+ uid: powerpoint!PowerPoint.TextRange#length:member
+ package: powerpoint!
+ fullName: length
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'length: number;'
+ return:
+ type: number
+ - name: paragraphFormat
+ uid: powerpoint!PowerPoint.TextRange#paragraphFormat:member
+ package: powerpoint!
+ fullName: paragraphFormat
+ summary: >-
+ Represents the paragraph format of the text range. See
+ [PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly paragraphFormat: PowerPoint.ParagraphFormat;'
+ return:
+ type:
+ - name: start
+ uid: powerpoint!PowerPoint.TextRange#start:member
+ package: powerpoint!
+ fullName: start
+ summary: >-
+ 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](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'start: number;'
+ return:
+ type: number
+ - name: text
+ uid: powerpoint!PowerPoint.TextRange#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Represents the plain text content of the text range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text: string;'
+ return:
+ type: string
+methods:
+ - name: getParentTextFrame()
+ uid: powerpoint!PowerPoint.TextRange#getParentTextFrame:member(1)
+ package: powerpoint!
+ fullName: getParentTextFrame()
+ summary: >-
+ Returns the parent
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) object
+ that holds this `TextRange`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentTextFrame(): PowerPoint.TextFrame;'
+ return:
+ type:
+ description: ''
+ - name: getSubstring(start, length)
+ uid: powerpoint!PowerPoint.TextRange#getSubstring:member(1)
+ package: powerpoint!
+ fullName: getSubstring(start, length)
+ summary: Returns a `TextRange` object for the substring in the given range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSubstring(start: number, length?: number): PowerPoint.TextRange;'
+ parameters:
+ - id: start
+ description: >-
+ The zero-based index of the first character to get from the text
+ range.
+ type: number
+ - id: length
+ description: >-
+ 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.
+ type: number
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TextRange#load:member(1)
+ package: powerpoint!
+ fullName: load(options)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ load(options?: PowerPoint.Interfaces.TextRangeLoadOptions):
+ PowerPoint.TextRange;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TextRange#load:member(2)
+ package: powerpoint!
+ fullName: load(propertyNames)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'load(propertyNames?: string | string[]): PowerPoint.TextRange;'
+ parameters:
+ - id: propertyNames
+ description: >-
+ A comma-delimited string or an array of strings that specify the
+ properties to load.
+ type: string | string[]
+ return:
+ type:
+ description: ''
+ - name: load(propertyNamesAndPaths)
+ uid: powerpoint!PowerPoint.TextRange#load:member(3)
+ package: powerpoint!
+ fullName: load(propertyNamesAndPaths)
+ summary: >-
+ Queues up a command to load the specified properties of the object. You
+ must call `context.sync()` before reading the properties.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.TextRange;
+ parameters:
+ - id: propertyNamesAndPaths
+ description: >-
+ `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.
+ type: |-
+ {
+ select?: string;
+ expand?: string;
+ }
+ return:
+ type:
+ description: ''
+ - name: setSelected()
+ uid: powerpoint!PowerPoint.TextRange#setSelected:member(1)
+ package: powerpoint!
+ fullName: setSelected()
+ summary: Selects this `TextRange` in the current view.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Selects the first 10 characters of the selected shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ await context.sync();
+ if (shapeCount.value !== 1) {
+ console.warn("You must select only one shape with text in it.");
+ return;
+ }
+ const shape: PowerPoint.Shape = shapes.getItemAt(0);
+ const textFrame: PowerPoint.TextFrame = shape.textFrame.load("textRange,hasText");
+ await context.sync();
+ if (textFrame.hasText != true) {
+ console.warn("You must select only one shape with text in it.");
+ return;
+ }
+ const textRange: PowerPoint.TextRange = textFrame.textRange;
+ textRange.load("text");
+ await context.sync();
+ if (textRange.text.length < 10) {
+ console.warn("You must select only one shape with at least 10 characters in it.");
+ return;
+ }
+ const textRange10 = textRange.getSubstring(0, 10);
+ textRange10.setSelected();
+ await context.sync();
+ });
+
+
+ ...
+
+
+ // Sets the range selection to the range that was saved previously.
+
+ await PowerPoint.run(async (context) => {
+ const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedTextSlideSelection[0]);
+ const shape1: PowerPoint.Shape = slide1.shapes.getItem(savedTextShapeSelection[0]);
+ const textRange: PowerPoint.TextRange = shape1.textFrame.textRange.getSubstring(savedTextTextRangeStart, savedTextTextRangeLength);
+ textRange.setSelected();
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSelected(): void;'
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.TextRange#toJSON:member(1)
+ package: powerpoint!
+ fullName: toJSON()
+ summary: >-
+ 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's 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TextRangeData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textrun.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textrun.yml
new file mode 100644
index 0000000000..e65959e5a0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textrun.yml
@@ -0,0 +1,49 @@
+### YamlMime:TSType
+name: PowerPoint.TextRun
+uid: powerpoint!PowerPoint.TextRun:interface
+package: powerpoint!
+fullName: PowerPoint.TextRun
+summary: Represents a sequence of one or more characters with the same font attributes.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: font
+ uid: powerpoint!PowerPoint.TextRun#font:member
+ package: powerpoint!
+ fullName: font
+ summary: >-
+ The font attributes (such as font name, font size, and color) applied to
+ this text run.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'font?: PowerPoint.FontProperties;'
+ return:
+ type:
+ - name: text
+ uid: powerpoint!PowerPoint.TextRun#text:member
+ package: powerpoint!
+ fullName: text
+ summary: The text of this text run.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text: string;'
+ return:
+ type: string
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textverticalalignment.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textverticalalignment.yml
new file mode 100644
index 0000000000..b6d742a868
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.textverticalalignment.yml
@@ -0,0 +1,135 @@
+### YamlMime:TSEnum
+name: PowerPoint.TextVerticalAlignment
+uid: powerpoint!PowerPoint.TextVerticalAlignment:enum
+package: powerpoint!
+fullName: PowerPoint.TextVerticalAlignment
+summary: >-
+ Represents the vertical alignment of a
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) in a
+ [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class). 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
+ [PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)
+ and
+ [PowerPoint.ParagraphHorizontalAlignment](xref:powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
+
+
+ // This function gets the collection of shapes on the first slide,
+
+ // and adds a brace pair, {}, to the collection, while specifying its
+
+ // location and size. Then it names the shape, sets its text and font
+
+ // color, and centers it inside the braces.
+
+ await PowerPoint.run(async (context) => {
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ const braces: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.bracePair, {
+ left: 100,
+ top: 400,
+ height: 50,
+ width: 150
+ });
+ braces.name = "Braces";
+ braces.textFrame.textRange.text = "Shape text";
+ braces.textFrame.textRange.font.color = "purple";
+ braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
+
+ return context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: bottom
+ uid: powerpoint!PowerPoint.TextVerticalAlignment.bottom:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Bottom"'
+ - name: bottomCentered
+ uid: powerpoint!PowerPoint.TextVerticalAlignment.bottomCentered:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the `TextFrame` should be bottom aligned vertically to the
+ `Shape`. Contents of the `TextFrame` will be centered horizontally
+ within the `Shape`.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"BottomCentered"'
+ - name: middle
+ uid: powerpoint!PowerPoint.TextVerticalAlignment.middle:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the `TextFrame` should be center aligned to the `Shape`.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Middle"'
+ - name: middleCentered
+ uid: powerpoint!PowerPoint.TextVerticalAlignment.middleCentered:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the `TextFrame` should be center aligned vertically to the
+ `Shape`. Contents of the `TextFrame` will be centered horizontally
+ within the `Shape`.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MiddleCentered"'
+ - name: top
+ uid: powerpoint!PowerPoint.TextVerticalAlignment.top:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the `TextFrame` should be top aligned to the `Shape`.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Top"'
+ - name: topCentered
+ uid: powerpoint!PowerPoint.TextVerticalAlignment.topCentered:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the `TextFrame` should be top aligned vertically to the
+ `Shape`. Contents of the `TextFrame` will be centered horizontally
+ within the `Shape`.
+
+
+ * \[ [API set: PowerPointApi
+ 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TopCentered"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml
new file mode 100644
index 0000000000..88f0dec200
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml
@@ -0,0 +1,1080 @@
+items:
+ - name: API reference
+ items:
+ - name: API reference overview
+ href: ../overview/overview.md
+ - name: Excel
+ href: /javascript/api/excel
+ - name: OneNote
+ href: /javascript/api/onenote
+ - name: Outlook
+ href: /javascript/api/outlook
+ - name: PowerPoint
+ uid: powerpoint!
+ items:
+ - name: Enums
+ uid: ''
+ items:
+ - name: BindingType
+ uid: powerpoint!PowerPoint.BindingType:enum
+ - name: ConnectorType
+ uid: powerpoint!PowerPoint.ConnectorType:enum
+ - name: DocumentPropertyType
+ uid: powerpoint!PowerPoint.DocumentPropertyType:enum
+ - name: ErrorCodes
+ uid: powerpoint!PowerPoint.ErrorCodes:enum
+ - name: GeometricShapeType
+ uid: powerpoint!PowerPoint.GeometricShapeType:enum
+ - name: InsertSlideFormatting
+ uid: powerpoint!PowerPoint.InsertSlideFormatting:enum
+ - name: ParagraphHorizontalAlignment
+ uid: powerpoint!PowerPoint.ParagraphHorizontalAlignment:enum
+ - name: PlaceholderType
+ uid: powerpoint!PowerPoint.PlaceholderType:enum
+ - name: ShapeAutoSize
+ uid: powerpoint!PowerPoint.ShapeAutoSize:enum
+ - name: ShapeFillType
+ uid: powerpoint!PowerPoint.ShapeFillType:enum
+ - name: ShapeFontUnderlineStyle
+ uid: powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum
+ - name: ShapeLineDashStyle
+ uid: powerpoint!PowerPoint.ShapeLineDashStyle:enum
+ - name: ShapeLineStyle
+ uid: powerpoint!PowerPoint.ShapeLineStyle:enum
+ - name: ShapeType
+ uid: powerpoint!PowerPoint.ShapeType:enum
+ - name: ShapeZOrder
+ uid: powerpoint!PowerPoint.ShapeZOrder:enum
+ - name: SlideLayoutType
+ uid: powerpoint!PowerPoint.SlideLayoutType:enum
+ - name: TextVerticalAlignment
+ uid: powerpoint!PowerPoint.TextVerticalAlignment:enum
+ - name: AddSlideOptions
+ uid: powerpoint!PowerPoint.AddSlideOptions:interface
+ - name: Application
+ uid: powerpoint!PowerPoint.Application:class
+ - name: Binding
+ uid: powerpoint!PowerPoint.Binding:class
+ - name: BindingCollection
+ uid: powerpoint!PowerPoint.BindingCollection:class
+ - name: BorderProperties
+ uid: powerpoint!PowerPoint.BorderProperties:interface
+ - name: BulletFormat
+ uid: powerpoint!PowerPoint.BulletFormat:class
+ - name: CustomProperty
+ uid: powerpoint!PowerPoint.CustomProperty:class
+ - name: CustomPropertyCollection
+ uid: powerpoint!PowerPoint.CustomPropertyCollection:class
+ - name: CustomXmlPart
+ uid: powerpoint!PowerPoint.CustomXmlPart:class
+ - name: CustomXmlPartCollection
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection:class
+ - name: CustomXmlPartScopedCollection
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection:class
+ - name: DocumentProperties
+ uid: powerpoint!PowerPoint.DocumentProperties:class
+ - name: FillProperties
+ uid: powerpoint!PowerPoint.FillProperties:interface
+ - name: FontProperties
+ uid: powerpoint!PowerPoint.FontProperties:interface
+ - name: Hyperlink
+ uid: powerpoint!PowerPoint.Hyperlink:class
+ - name: HyperlinkCollection
+ uid: powerpoint!PowerPoint.HyperlinkCollection:class
+ - name: InsertSlideOptions
+ uid: powerpoint!PowerPoint.InsertSlideOptions:interface
+ - name: ParagraphFormat
+ uid: powerpoint!PowerPoint.ParagraphFormat:class
+ - name: PlaceholderFormat
+ uid: powerpoint!PowerPoint.PlaceholderFormat:class
+ - name: Presentation
+ uid: powerpoint!PowerPoint.Presentation:class
+ - name: RequestContext
+ uid: powerpoint!PowerPoint.RequestContext:class
+ - name: Shape
+ uid: powerpoint!PowerPoint.Shape:class
+ - name: ShapeAddOptions
+ uid: powerpoint!PowerPoint.ShapeAddOptions:interface
+ - name: ShapeCollection
+ uid: powerpoint!PowerPoint.ShapeCollection:class
+ - name: ShapeFill
+ uid: powerpoint!PowerPoint.ShapeFill:class
+ - name: ShapeFont
+ uid: powerpoint!PowerPoint.ShapeFont:class
+ - name: ShapeGroup
+ uid: powerpoint!PowerPoint.ShapeGroup:class
+ - name: ShapeLineFormat
+ uid: powerpoint!PowerPoint.ShapeLineFormat:class
+ - name: ShapeScopedCollection
+ uid: powerpoint!PowerPoint.ShapeScopedCollection:class
+ - name: Slide
+ uid: powerpoint!PowerPoint.Slide:class
+ - name: SlideCollection
+ uid: powerpoint!PowerPoint.SlideCollection:class
+ - name: SlideGetImageOptions
+ uid: powerpoint!PowerPoint.SlideGetImageOptions:interface
+ - name: SlideLayout
+ uid: powerpoint!PowerPoint.SlideLayout:class
+ - name: SlideLayoutCollection
+ uid: powerpoint!PowerPoint.SlideLayoutCollection:class
+ - name: SlideMaster
+ uid: powerpoint!PowerPoint.SlideMaster:class
+ - name: SlideMasterCollection
+ uid: powerpoint!PowerPoint.SlideMasterCollection:class
+ - name: SlideScopedCollection
+ uid: powerpoint!PowerPoint.SlideScopedCollection:class
+ - name: Table
+ uid: powerpoint!PowerPoint.Table:class
+ - name: TableAddOptions
+ uid: powerpoint!PowerPoint.TableAddOptions:interface
+ - name: TableCell
+ uid: powerpoint!PowerPoint.TableCell:class
+ - name: TableCellBorders
+ uid: powerpoint!PowerPoint.TableCellBorders:interface
+ - name: TableCellCollection
+ uid: powerpoint!PowerPoint.TableCellCollection:class
+ - name: TableCellMargins
+ uid: powerpoint!PowerPoint.TableCellMargins:interface
+ - name: TableCellProperties
+ uid: powerpoint!PowerPoint.TableCellProperties:interface
+ - name: TableColumnProperties
+ uid: powerpoint!PowerPoint.TableColumnProperties:interface
+ - name: TableMergedAreaProperties
+ uid: powerpoint!PowerPoint.TableMergedAreaProperties:interface
+ - name: TableRowProperties
+ uid: powerpoint!PowerPoint.TableRowProperties:interface
+ - name: Tag
+ uid: powerpoint!PowerPoint.Tag:class
+ - name: TagCollection
+ uid: powerpoint!PowerPoint.TagCollection:class
+ - name: TextFrame
+ uid: powerpoint!PowerPoint.TextFrame:class
+ - name: TextRange
+ uid: powerpoint!PowerPoint.TextRange:class
+ - name: TextRun
+ uid: powerpoint!PowerPoint.TextRun:interface
+ - name: Visio
+ href: /javascript/api/visio
+ - name: Word
+ href: /javascript/api/word
+ - name: Common APIs
+ uid: office!
+ items:
+ - name: Office
+ uid: office!
+ items:
+ - name: Enums
+ uid: ''
+ items:
+ - name: ActiveView
+ uid: office!Office.ActiveView:enum
+ - name: AsyncResultStatus
+ uid: office!Office.AsyncResultStatus:enum
+ - name: BindingType
+ uid: office!Office.BindingType:enum
+ - name: CoercionType
+ uid: office!Office.CoercionType:enum
+ - name: CustomXMLNodeType
+ uid: office!Office.CustomXMLNodeType:enum
+ - name: DevicePermissionType
+ uid: office!Office.DevicePermissionType:enum
+ - name: DocumentMode
+ uid: office!Office.DocumentMode:enum
+ - name: EventType
+ uid: office!Office.EventType:enum
+ - name: FileType
+ uid: office!Office.FileType:enum
+ - name: FilterType
+ uid: office!Office.FilterType:enum
+ - name: GoToType
+ uid: office!Office.GoToType:enum
+ - name: HostType
+ uid: office!Office.HostType:enum
+ - name: Index
+ uid: office!Office.Index:enum
+ - name: InitializationReason
+ uid: office!Office.InitializationReason:enum
+ - name: PlatformType
+ uid: office!Office.PlatformType:enum
+ - name: ProjectProjectFields
+ uid: office!Office.ProjectProjectFields:enum
+ - name: ProjectResourceFields
+ uid: office!Office.ProjectResourceFields:enum
+ - name: ProjectTaskFields
+ uid: office!Office.ProjectTaskFields:enum
+ - name: ProjectViewTypes
+ uid: office!Office.ProjectViewTypes:enum
+ - name: SelectionMode
+ uid: office!Office.SelectionMode:enum
+ - name: StartupBehavior
+ uid: office!Office.StartupBehavior:enum
+ - name: Table
+ uid: office!Office.Table:enum
+ - name: ThemeId
+ uid: office!Office.ThemeId:enum
+ - name: ValueFormat
+ uid: office!Office.ValueFormat:enum
+ - name: VisibilityMode
+ uid: office!Office.VisibilityMode:enum
+ - name: Actions
+ uid: office!Office.Actions:interface
+ - name: AddBindingFromNamedItemOptions
+ uid: office!Office.AddBindingFromNamedItemOptions:interface
+ - name: AddBindingFromPromptOptions
+ uid: office!Office.AddBindingFromPromptOptions:interface
+ - name: AddBindingFromSelectionOptions
+ uid: office!Office.AddBindingFromSelectionOptions:interface
+ - name: Addin
+ uid: office!Office.Addin:interface
+ - name: AddinCommands.Event
+ uid: office!Office.AddinCommands.Event:interface
+ - name: AddinCommands.EventCompletedOptions
+ uid: office!Office.AddinCommands.EventCompletedOptions:interface
+ - name: AddinCommands.Source
+ uid: office!Office.AddinCommands.Source:interface
+ - name: AsyncContextOptions
+ uid: office!Office.AsyncContextOptions:interface
+ - name: AsyncResult
+ uid: office!Office.AsyncResult:interface
+ - name: Auth
+ uid: office!Office.Auth:interface
+ - name: AuthOptions
+ uid: office!Office.AuthOptions:interface
+ - name: BeforeDocumentCloseNotification
+ uid: office!Office.BeforeDocumentCloseNotification:interface
+ - name: Binding
+ uid: office!Office.Binding:interface
+ - name: BindingDataChangedEventArgs
+ uid: office!Office.BindingDataChangedEventArgs:interface
+ - name: Bindings
+ uid: office!Office.Bindings:interface
+ - name: BindingSelectionChangedEventArgs
+ uid: office!Office.BindingSelectionChangedEventArgs:interface
+ - name: Context
+ uid: office!Office.Context:interface
+ - name: ContextInformation
+ uid: office!Office.ContextInformation:interface
+ - name: ContextMenu
+ uid: office!Office.ContextMenu:interface
+ - name: ContextMenuControl
+ uid: office!Office.ContextMenuControl:interface
+ - name: ContextMenuUpdaterData
+ uid: office!Office.ContextMenuUpdaterData:interface
+ - name: Control
+ uid: office!Office.Control:interface
+ - name: CustomXmlNode
+ uid: office!Office.CustomXmlNode:interface
+ - name: CustomXmlPart
+ uid: office!Office.CustomXmlPart:interface
+ - name: CustomXmlParts
+ uid: office!Office.CustomXmlParts:interface
+ - name: CustomXmlPrefixMappings
+ uid: office!Office.CustomXmlPrefixMappings:interface
+ - name: DevicePermission
+ uid: office!Office.DevicePermission:interface
+ - name: Dialog
+ uid: office!Office.Dialog:interface
+ - name: DialogMessageOptions
+ uid: office!Office.DialogMessageOptions:interface
+ - name: DialogOptions
+ uid: office!Office.DialogOptions:interface
+ - name: DialogParentMessageReceivedEventArgs
+ uid: office!Office.DialogParentMessageReceivedEventArgs:interface
+ - name: Document
+ uid: office!Office.Document:interface
+ - name: DocumentSelectionChangedEventArgs
+ uid: office!Office.DocumentSelectionChangedEventArgs:interface
+ - name: Error
+ uid: office!Office.Error:interface
+ - name: File
+ uid: office!Office.File:interface
+ - name: FileProperties
+ uid: office!Office.FileProperties:interface
+ - name: GetBindingDataOptions
+ uid: office!Office.GetBindingDataOptions:interface
+ - name: GetFileOptions
+ uid: office!Office.GetFileOptions:interface
+ - name: GetSelectedDataOptions
+ uid: office!Office.GetSelectedDataOptions:interface
+ - name: GoToByIdOptions
+ uid: office!Office.GoToByIdOptions:interface
+ - name: Group
+ uid: office!Office.Group:interface
+ - name: IPromiseConstructor
+ uid: office!Office.IPromiseConstructor:interface
+ - name: MatrixBinding
+ uid: office!Office.MatrixBinding:interface
+ - name: NodeDeletedEventArgs
+ uid: office!Office.NodeDeletedEventArgs:interface
+ - name: NodeInsertedEventArgs
+ uid: office!Office.NodeInsertedEventArgs:interface
+ - name: NodeReplacedEventArgs
+ uid: office!Office.NodeReplacedEventArgs:interface
+ - name: OfficeTheme
+ uid: office!Office.OfficeTheme:interface
+ - name: RangeCoordinates
+ uid: office!Office.RangeCoordinates:interface
+ - name: RangeFormatConfiguration
+ uid: office!Office.RangeFormatConfiguration:interface
+ - name: RemoveHandlerOptions
+ uid: office!Office.RemoveHandlerOptions:interface
+ - name: RequirementSetSupport
+ uid: office!Office.RequirementSetSupport:interface
+ - name: Ribbon
+ uid: office!Office.Ribbon:interface
+ - name: RibbonUpdaterData
+ uid: office!Office.RibbonUpdaterData:interface
+ - name: SaveSettingsOptions
+ uid: office!Office.SaveSettingsOptions:interface
+ - name: SetBindingDataOptions
+ uid: office!Office.SetBindingDataOptions:interface
+ - name: SetSelectedDataOptions
+ uid: office!Office.SetSelectedDataOptions:interface
+ - name: Settings
+ uid: office!Office.Settings:interface
+ - name: SettingsChangedEventArgs
+ uid: office!Office.SettingsChangedEventArgs:interface
+ - name: Slice
+ uid: office!Office.Slice:interface
+ - name: Tab
+ uid: office!Office.Tab:interface
+ - name: TableBinding
+ uid: office!Office.TableBinding:interface
+ - name: TableData
+ uid: office!Office.TableData:class
+ - name: TextBinding
+ uid: office!Office.TextBinding:interface
+ - name: UI
+ uid: office!Office.UI:interface
+ - name: Urls
+ uid: office!Office.Urls:interface
+ - name: VisibilityModeChangedMessage
+ uid: office!Office.VisibilityModeChangedMessage:interface
+ - name: OfficeExtension
+ items:
+ - name: ClientObject
+ uid: office!OfficeExtension.ClientObject:class
+ - name: ClientRequestContext
+ uid: office!OfficeExtension.ClientRequestContext:class
+ - name: ClientResult
+ uid: office!OfficeExtension.ClientResult:class
+ - name: DebugInfo
+ uid: office!OfficeExtension.DebugInfo:interface
+ - name: EmbeddedOptions
+ uid: office!OfficeExtension.EmbeddedOptions:interface
+ - name: EmbeddedSession
+ uid: office!OfficeExtension.EmbeddedSession:class
+ - name: Error
+ uid: office!OfficeExtension.Error:class
+ - name: ErrorCodes
+ uid: office!OfficeExtension.ErrorCodes:class
+ - name: EventHandlerResult
+ uid: office!OfficeExtension.EventHandlerResult:class
+ - name: EventHandlers
+ uid: office!OfficeExtension.EventHandlers:class
+ - name: EventInfo
+ uid: office!OfficeExtension.EventInfo:interface
+ - name: IPromise
+ uid: office!OfficeExtension.IPromise:type
+ - name: LoadOption
+ uid: office!OfficeExtension.LoadOption:interface
+ - name: RequestContextDebugInfo
+ uid: office!OfficeExtension.RequestContextDebugInfo:interface
+ - name: RequestUrlAndHeaderInfo
+ uid: office!OfficeExtension.RequestUrlAndHeaderInfo:interface
+ - name: RunOptions
+ uid: office!OfficeExtension.RunOptions:interface
+ - name: TrackedObjects
+ uid: office!OfficeExtension.TrackedObjects:class
+ - name: UpdateOptions
+ uid: office!OfficeExtension.UpdateOptions:interface
+ - name: OfficeRuntime
+ uid: office-runtime!
+ items:
+ - name: ApiInformation
+ uid: office-runtime!OfficeRuntime.ApiInformation:interface
+ - name: Auth
+ uid: office-runtime!OfficeRuntime.Auth:interface
+ - name: AuthOptions
+ uid: office-runtime!OfficeRuntime.AuthOptions:interface
+ - name: Dialog
+ uid: office-runtime!OfficeRuntime.Dialog:interface
+ - name: DisplayWebDialogOptions
+ uid: office-runtime!OfficeRuntime.DisplayWebDialogOptions:interface
+ - name: Storage
+ uid: office-runtime!OfficeRuntime.Storage:interface
+ - name: Add-in only manifest reference
+ items:
+ - name: Add-in only manifest overview
+ href: ../../manifest/manifest.md
+ - name: AllowSnapshot
+ href: ../../manifest/allowsnapshot.md
+ - name: AlternateId
+ href: ../../manifest/alternateid.md
+ - name: AppDomain
+ href: ../../manifest/appdomain.md
+ - name: AppDomains
+ href: ../../manifest/appdomains.md
+ - name: CitationText
+ href: ../../manifest/citationtext.md
+ - name: DefaultLocale
+ href: ../../manifest/defaultlocale.md
+ - name: DefaultSettings
+ href: ../../manifest/defaultsettings.md
+ - name: Description
+ href: ../../manifest/description.md
+ - name: DesktopSettings
+ href: ../../manifest/desktopsettings.md
+ - name: Dictionary
+ href: ../../manifest/dictionary.md
+ - name: DictionaryHomePage
+ href: ../../manifest/dictionaryhomepage.md
+ - name: DisableEntityHighlighting
+ href: ../../manifest/disableentityhighlighting.md
+ - name: DisplayName
+ href: ../../manifest/displayname.md
+ - name: ExtendedOverrides
+ href: ../../manifest/extendedoverrides.md
+ - name: FileName
+ href: ../../manifest/filename.md
+ - name: Form
+ href: ../../manifest/form.md
+ - name: FormSettings
+ href: ../../manifest/formsettings.md
+ - name: HighResolutionIconUrl
+ href: ../../manifest/highresolutioniconurl.md
+ - name: Host
+ href: ../../manifest/host.md
+ - name: Hosts
+ href: ../../manifest/hosts.md
+ - name: IconUrl
+ href: ../../manifest/iconurl.md
+ - name: Id
+ href: ../../manifest/id.md
+ - name: Metadata
+ href: ../../manifest/metadata.md
+ - name: Method
+ href: ../../manifest/method.md
+ - name: Methods
+ href: ../../manifest/methods.md
+ - name: Namespace
+ href: ../../manifest/namespace.md
+ - name: OfficeApp
+ href: ../../manifest/officeapp.md
+ - name: Override
+ href: ../../manifest/override.md
+ - name: Permissions
+ href: ../../manifest/permissions.md
+ - name: PhoneSettings
+ href: ../../manifest/phonesettings.md
+ - name: ProgId
+ href: ../../manifest/progid.md
+ - name: ProviderName
+ href: ../../manifest/providername.md
+ - name: QueryUri
+ href: ../../manifest/queryuri.md
+ - name: RequestedHeight
+ href: ../../manifest/requestedheight.md
+ - name: RequestedWidth
+ href: ../../manifest/requestedwidth.md
+ - name: Requirements
+ href: ../../manifest/requirements.md
+ - name: Rule
+ href: ../../manifest/rule.md
+ - name: Set
+ href: ../../manifest/set.md
+ - name: Sets
+ href: ../../manifest/sets.md
+ - name: SourceLocation
+ href: ../../manifest/sourcelocation.md
+ - name: SupportUrl
+ href: ../../manifest/supporturl.md
+ - name: TabletSettings
+ href: ../../manifest/tabletsettings.md
+ - name: TargetDialect
+ href: ../../manifest/targetdialect.md
+ - name: TargetDialects
+ href: ../../manifest/targetdialects.md
+ - name: Tokens
+ href: ../../manifest/tokens.md
+ - name: Token
+ href: ../../manifest/token.md
+ - name: Type
+ href: ../../manifest/type.md
+ - name: Version
+ href: ../../manifest/version.md
+ - name: VersionOverrides
+ items:
+ - name: VersionOverrides Overview
+ href: ../../manifest/versionoverrides.md
+ - name: VersionOverrides 1.0 TaskPane
+ href: ../../manifest/versionoverrides-1-0-taskpane.md
+ - name: VersionOverrides 1.0 Content
+ href: ../../manifest/versionoverrides-1-0-content.md
+ - name: VersionOverrides 1.0 Mail
+ href: ../../manifest/versionoverrides-1-0-mail.md
+ - name: VersionOverrides 1.1 Mail
+ href: ../../manifest/versionoverrides-1-1-mail.md
+ - name: Action
+ href: ../../manifest/action.md
+ - name: AllFormFactors
+ href: ../../manifest/allformfactors.md
+ - name: CommandSurface
+ href: ../../manifest/commandsurface.md
+ - name: Control
+ href: ../../manifest/control.md
+ - name: Control (Button)
+ href: ../../manifest/control-button.md
+ - name: Control (Menu)
+ href: ../../manifest/control-menu.md
+ - name: Control (MobileButton)
+ href: ../../manifest/control-mobilebutton.md
+ - name: CustomTab
+ href: ../../manifest/customtab.md
+ - name: DesktopFormFactor
+ href: ../../manifest/desktopformfactor.md
+ - name: Enabled
+ href: ../../manifest/enabled.md
+ - name: EquivalentAddin
+ href: ../../manifest/equivalentaddin.md
+ - name: EquivalentAddins
+ href: ../../manifest/equivalentaddins.md
+ - name: Event
+ href: ../../manifest/event.md
+ - name: ExtendedPermission
+ href: ../../manifest/extendedpermission.md
+ - name: ExtendedPermissions
+ href: ../../manifest/extendedpermissions.md
+ - name: ExtensionPoint
+ href: ../../manifest/extensionpoint.md
+ - name: FunctionFile
+ href: ../../manifest/functionfile.md
+ - name: GetStarted
+ href: ../../manifest/getstarted.md
+ - name: Group
+ href: ../../manifest/group.md
+ - name: Host
+ href: ../../manifest/host.md
+ - name: Hosts
+ href: ../../manifest/hosts.md
+ - name: Icon
+ href: ../../manifest/icon.md
+ - name: Image
+ href: ../../manifest/image.md
+ - name: Images
+ href: ../../manifest/images.md
+ - name: Item
+ href: ../../manifest/item.md
+ - name: Items
+ href: ../../manifest/items.md
+ - name: LaunchEvent
+ href: ../../manifest/launchevent.md
+ - name: LaunchEvents
+ href: ../../manifest/launchevents.md
+ - name: LongStrings
+ href: ../../manifest/longstrings.md
+ - name: MessageAttachment
+ href: ../../manifest/messageattachment.md
+ - name: MessageAttachments
+ href: ../../manifest/messageattachments.md
+ - name: MobileFormFactor
+ href: ../../manifest/mobileformfactor.md
+ - name: MoreInfo
+ href: ../../manifest/moreinfo.md
+ - name: OfficeMenu
+ href: ../../manifest/officemenu.md
+ - name: OfficeTab
+ href: ../../manifest/officetab.md
+ - name: Override
+ href: ../../manifest/override.md
+ - name: OverriddenByRibbonApi
+ href: ../../manifest/overriddenbyribbonapi.md
+ - name: Page
+ href: ../../manifest/page.md
+ - name: PreProcessingDialog
+ href: ../../manifest/preprocessingdialog.md
+ - name: ReportPhishingCustomization
+ href: ../../manifest/reportphishingcustomization.md
+ - name: ReportingOptions
+ href: ../../manifest/reportingoptions.md
+ - name: Resources
+ href: ../../manifest/resources.md
+ - name: Runtime
+ href: ../../manifest/runtime.md
+ - name: Runtimes
+ href: ../../manifest/runtimes.md
+ - name: Scopes
+ href: ../../manifest/scopes.md
+ - name: Script
+ href: ../../manifest/script.md
+ - name: ShortStrings
+ href: ../../manifest/shortstrings.md
+ - name: SourceLocation (version overrides)
+ href: ../../manifest/customfunctionssourcelocation.md
+ - name: String
+ href: ../../manifest/string.md
+ - name: Supertip
+ href: ../../manifest/supertip.md
+ - name: SupportsSharedFolders
+ href: ../../manifest/supportssharedfolders.md
+ - name: Url
+ href: ../../manifest/url.md
+ - name: Urls
+ href: ../../manifest/urls.md
+ - name: WebApplicationInfo
+ href: ../../manifest/webapplicationinfo.md
+ - name: Requirement sets
+ items:
+ - name: Application and platform availability
+ href: ../../requirement-sets/requirement-sets.md
+ - name: Excel requirement sets
+ items:
+ - name: Overview
+ href: ../../requirement-sets/excel/excel-api-requirement-sets.md
+ displayName: Excel
+ - name: CustomFunctionsRuntime API requirement sets
+ href: ../../requirement-sets/excel/custom-functions-requirement-sets.md
+ displayName: Excel, Custom Functions
+ - name: Excel preview APIs
+ href: ../../requirement-sets/excel/excel-preview-apis.md
+ displayName: Excel
+ - name: ExcelApi online-only requirement set
+ href: ../../requirement-sets/excel/excel-api-online-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.18 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-18-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.17 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-17-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.16 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-16-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.15 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-15-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.14 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-14-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.13 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-13-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.12 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-12-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.11 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-11-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.10 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-10-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.9 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-9-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.8 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-8-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.7 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-7-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.6 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-6-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.5 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-5-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.4 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-4-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.3 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-3-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.2 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-2-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.1 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-1-requirement-set.md
+ displayName: Excel
+ - name: OneNote requirement sets
+ items:
+ - name: API requirement sets
+ href: ../../requirement-sets/onenote/onenote-api-requirement-sets.md
+ displayName: OneNote
+ - name: Outlook requirement sets
+ items:
+ - name: Overview
+ href: ../../requirement-sets/outlook/outlook-api-requirement-sets.md
+ displayName: Outlook
+ - name: Mailbox preview requirement set
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md
+ - name: Office
+ href: >-
+ ../../requirement-sets/outlook/preview-requirement-set/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/preview-requirement-set/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/preview-requirement-set/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/preview-requirement-set/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.15
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.15/outlook-requirement-set-1.15.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.15/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.15/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.15/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.15/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.14
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.14/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.14/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.14/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.14/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.13
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.13/outlook-requirement-set-1.13.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.13/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.13/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.13/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.13/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.12
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.12/outlook-requirement-set-1.12.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.12/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.12/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.12/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.12/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.11
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.11/outlook-requirement-set-1.11.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.11/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.11/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.11/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.11/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.10
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.10/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.10/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.10/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.10/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.9
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.9/outlook-requirement-set-1.9.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.9/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.9/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.9/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.9/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.8
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.8/outlook-requirement-set-1.8.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.8/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.8/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.8/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.8/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.7
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.7/outlook-requirement-set-1.7.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.7/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.7/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.7/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.7/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.6
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.6/outlook-requirement-set-1.6.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.6/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.6/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.6/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.6/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.5
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.5/outlook-requirement-set-1.5.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.5/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.5/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.5/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.5/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.4
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.4/outlook-requirement-set-1.4.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.4/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.4/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.4/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.4/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.3
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.3/outlook-requirement-set-1.3.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.3/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.3/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.3/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.3/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.2
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.2/outlook-requirement-set-1.2.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.2/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.2/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.2/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.2/Office.context.mailbox.item.md
+ - name: Mailbox requirement set 1.1
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.1/outlook-requirement-set-1.1.md
+ - name: Office
+ href: ../../requirement-sets/outlook/requirement-set-1.1/office.md
+ - name: Office.context
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.1/Office.context.md
+ - name: Office.context.mailbox
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.1/Office.context.mailbox.md
+ - name: Office.context.mailbox.item
+ href: >-
+ ../../requirement-sets/outlook/requirement-set-1.1/Office.context.mailbox.item.md
+ - name: PowerPoint requirement sets
+ items:
+ - name: Overview
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-requirement-sets.md
+ displayName: PowerPoint
+ - name: PowerPoint preview APIs
+ href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
+ displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
+ - name: PowerPointApi 1.7 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.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
+ - name: PowerPointApi 1.4 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-4-requirement-set.md
+ displayName: PowerPoint
+ - name: PowerPointApi 1.3 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-3-requirement-set.md
+ displayName: PowerPoint
+ - name: PowerPointApi 1.2 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-2-requirement-set.md
+ displayName: PowerPoint
+ - name: PowerPointApi 1.1 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-1-requirement-set.md
+ displayName: PowerPoint
+ - name: Word requirement sets
+ items:
+ - name: Overview
+ href: ../../requirement-sets/word/word-api-requirement-sets.md
+ displayName: Word
+ - name: Word preview APIs
+ href: ../../requirement-sets/word/word-preview-apis.md
+ displayName: Word
+ - name: WordApi online-only requirement set
+ href: ../../requirement-sets/word/word-api-online-requirement-set.md
+ displayName: Word
+ - name: WordApiDesktop 1.2 requirement set
+ href: >-
+ ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md
+ displayName: Word
+ - name: WordApiDesktop 1.1 requirement set
+ href: >-
+ ../../requirement-sets/word/word-api-desktop-1.1-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.9 requirement set
+ href: ../../requirement-sets/word/word-api-1-9-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.8 requirement set
+ href: ../../requirement-sets/word/word-api-1-8-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.7 requirement set
+ href: ../../requirement-sets/word/word-api-1-7-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.6 requirement set
+ href: ../../requirement-sets/word/word-api-1-6-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.5 requirement set
+ href: ../../requirement-sets/word/word-api-1-5-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.4 requirement set
+ href: ../../requirement-sets/word/word-api-1-4-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.3 requirement set
+ href: ../../requirement-sets/word/word-api-1-3-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.2 requirement set
+ href: ../../requirement-sets/word/word-api-1-2-requirement-set.md
+ displayName: Word
+ - name: WordApi 1.1 requirement set
+ href: ../../requirement-sets/word/word-api-1-1-requirement-set.md
+ displayName: Word
+ - name: Common API requirement sets
+ items:
+ - name: Overview
+ href: ../../requirement-sets/common/office-add-in-requirement-sets.md
+ - name: Add-in commands requirement sets
+ href: ../../requirement-sets/common/add-in-commands-requirement-sets.md
+ - name: Device Permission Service requirement sets
+ href: >-
+ ../../requirement-sets/common/device-permission-service-requirement-sets.md
+ - name: Dialog API requirement sets
+ href: ../../requirement-sets/common/dialog-api-requirement-sets.md
+ - name: Dialog Origin requirement sets
+ href: ../../requirement-sets/common/dialog-origin-requirement-sets.md
+ - name: Identity API requirement sets
+ href: ../../requirement-sets/common/identity-api-requirement-sets.md
+ - name: Image Coercion requirement sets
+ href: ../../requirement-sets/common/image-coercion-requirement-sets.md
+ - name: Keyboard Shortcuts requirement sets
+ href: >-
+ ../../requirement-sets/common/keyboard-shortcuts-requirement-sets.md
+ - name: Nested App Auth requirement sets
+ href: ../../requirement-sets/common/nested-app-auth-requirement-sets.md
+ - name: Open Browser Window requirement sets
+ href: >-
+ ../../requirement-sets/common/open-browser-window-api-requirement-sets.md
+ - name: Ribbon API requirement sets
+ href: ../../requirement-sets/common/ribbon-api-requirement-sets.md
+ - name: Shared Runtime requirement sets
+ href: ../../requirement-sets/common/shared-runtime-requirement-sets.md
diff --git a/docs/docs-ref-autogen/visio/toc.yml b/docs/docs-ref-autogen/visio/toc.yml
index fc5ed1139b..93b708ec6d 100644
--- a/docs/docs-ref-autogen/visio/toc.yml
+++ b/docs/docs-ref-autogen/visio/toc.yml
@@ -681,6 +681,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml
index d29708bac9..d1e763ce4a 100644
--- a/docs/docs-ref-autogen/word/toc.yml
+++ b/docs/docs-ref-autogen/word/toc.yml
@@ -1153,6 +1153,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_1/toc.yml b/docs/docs-ref-autogen/word_1_1/toc.yml
index 8209afc1f1..93e5e5b884 100644
--- a/docs/docs-ref-autogen/word_1_1/toc.yml
+++ b/docs/docs-ref-autogen/word_1_1/toc.yml
@@ -883,6 +883,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_2/toc.yml b/docs/docs-ref-autogen/word_1_2/toc.yml
index 8209afc1f1..93e5e5b884 100644
--- a/docs/docs-ref-autogen/word_1_2/toc.yml
+++ b/docs/docs-ref-autogen/word_1_2/toc.yml
@@ -883,6 +883,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_3/toc.yml b/docs/docs-ref-autogen/word_1_3/toc.yml
index 68b82e8f4f..eb65da8ceb 100644
--- a/docs/docs-ref-autogen/word_1_3/toc.yml
+++ b/docs/docs-ref-autogen/word_1_3/toc.yml
@@ -939,6 +939,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml
index 68b82e8f4f..eb65da8ceb 100644
--- a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml
+++ b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml
@@ -939,6 +939,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_4/toc.yml b/docs/docs-ref-autogen/word_1_4/toc.yml
index 9ec882409a..89948a07e7 100644
--- a/docs/docs-ref-autogen/word_1_4/toc.yml
+++ b/docs/docs-ref-autogen/word_1_4/toc.yml
@@ -967,6 +967,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml
index 9ec882409a..89948a07e7 100644
--- a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml
+++ b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml
@@ -967,6 +967,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_5/toc.yml b/docs/docs-ref-autogen/word_1_5/toc.yml
index 0a5a67ea45..4a542de841 100644
--- a/docs/docs-ref-autogen/word_1_5/toc.yml
+++ b/docs/docs-ref-autogen/word_1_5/toc.yml
@@ -1009,6 +1009,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml
index 0a5a67ea45..4a542de841 100644
--- a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml
+++ b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml
@@ -1009,6 +1009,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_6/toc.yml b/docs/docs-ref-autogen/word_1_6/toc.yml
index 44971c9124..cb6bcb9d86 100644
--- a/docs/docs-ref-autogen/word_1_6/toc.yml
+++ b/docs/docs-ref-autogen/word_1_6/toc.yml
@@ -1025,6 +1025,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_7/toc.yml b/docs/docs-ref-autogen/word_1_7/toc.yml
index 925d760021..c2e6c64988 100644
--- a/docs/docs-ref-autogen/word_1_7/toc.yml
+++ b/docs/docs-ref-autogen/word_1_7/toc.yml
@@ -1051,6 +1051,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_8/toc.yml b/docs/docs-ref-autogen/word_1_8/toc.yml
index 459d0066cb..f4c39ebce7 100644
--- a/docs/docs-ref-autogen/word_1_8/toc.yml
+++ b/docs/docs-ref-autogen/word_1_8/toc.yml
@@ -1055,6 +1055,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_1_9/toc.yml b/docs/docs-ref-autogen/word_1_9/toc.yml
index 054c420ab9..2341bcff3f 100644
--- a/docs/docs-ref-autogen/word_1_9/toc.yml
+++ b/docs/docs-ref-autogen/word_1_9/toc.yml
@@ -1063,6 +1063,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml
index 97db31058d..e75253c434 100644
--- a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml
+++ b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml
@@ -1081,6 +1081,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml
index c821028402..0039f286cf 100644
--- a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml
+++ b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml
@@ -1135,6 +1135,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_online/toc.yml b/docs/docs-ref-autogen/word_online/toc.yml
index 054c420ab9..2341bcff3f 100644
--- a/docs/docs-ref-autogen/word_online/toc.yml
+++ b/docs/docs-ref-autogen/word_online/toc.yml
@@ -1063,6 +1063,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
diff --git a/docs/includes/powerpoint-1_8.md b/docs/includes/powerpoint-1_8.md
new file mode 100644
index 0000000000..4f9791f06c
--- /dev/null
+++ b/docs/includes/powerpoint-1_8.md
@@ -0,0 +1,114 @@
+| Class | Fields | Description |
+|:---|:---|:---|
+|[Binding](/javascript/api/powerpoint/powerpoint.binding)|[delete()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-delete-member(1))|Deletes the binding.|
+||[getShape()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-getshape-member(1))|Returns the shape represented by the binding.|
+||[id](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-id-member)|Represents the binding identifier.|
+||[type](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-type-member)|Returns the type of the binding.|
+|[BindingCollection](/javascript/api/powerpoint/powerpoint.bindingcollection)|[add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-add-member(1))|Adds a new binding to a particular Shape.|
+||[addFromSelection(bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-addfromselection-member(1))|Adds a new binding based on the current selection.|
+||[getCount()](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.|
+||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitem-member(1))|Gets a binding object by ID.|
+||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.|
+||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.|
+||[items](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-items-member)|Gets the loaded child items in this collection.|
+|[BorderProperties](/javascript/api/powerpoint/powerpoint.borderproperties)|[color](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").|
+||[dashStyle](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-dashstyle-member)|Represents the dash style of the line.|
+||[transparency](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).|
+||[weight](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-weight-member)|Represents the weight of the line, in points.|
+|[FillProperties](/javascript/api/powerpoint/powerpoint.fillproperties)|[color](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-color-member)|Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").|
+||[transparency](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
+|[FontProperties](/javascript/api/powerpoint/powerpoint.fontproperties)|[allCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-allcaps-member)|Represents whether the font uses all caps, where lowercase letters are shown as capital letters.|
+||[bold](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-bold-member)|Represents the bold status of font.|
+||[color](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-color-member)|Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").|
+||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-doublestrikethrough-member)|Represents the double-strikethrough status of the font.|
+||[italic](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-italic-member)|Represents the italic status of font.|
+||[name](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-name-member)|Represents the font name (e.g., "Calibri").|
+||[size](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-size-member)|Represents the font size in points (e.g., 11).|
+||[smallCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-smallcaps-member)|Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.|
+||[strikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-strikethrough-member)|Represents the strikethrough status of the font.|
+||[subscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-subscript-member)|Represents the subscript status of the font.|
+||[superscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-superscript-member)|Represents the superscript status of the font.|
+||[underline](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-underline-member)|Type of underline applied to the font.|
+|[PlaceholderFormat](/javascript/api/powerpoint/powerpoint.placeholderformat)|[containedType](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-containedtype-member)|Gets the type of the shape contained within the placeholder.|
+||[type](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-type-member)|Returns the type of this placeholder.|
+|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[bindings](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-bindings-member)|Returns a collection of bindings that are associated with the presentation.|
+|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[getTable()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-gettable-member(1))|Returns the `Table` object if this shape is a table.|
+||[group](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-group-member)|Returns the `ShapeGroup` associated with the shape.|
+||[level](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-level-member)|Returns the level of the specified shape.|
+||[parentGroup](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-parentgroup-member)|Returns the parent group of this shape.|
+||[placeholderFormat](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-placeholderformat-member)|Returns the properties that apply specifically to this placeholder.|
+||[setZOrder(position: PowerPoint.ShapeZOrder)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.|
+||[zOrderPosition](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-zorderposition-member)|Returns the z-order position of the shape, with 0 representing the bottom of the order stack.|
+|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[addGroup(values: Array)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addgroup-member(1))|Create a shape group for several shapes.|
+||[addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addtable-member(1))|Adds a table to the slide.|
+|[ShapeFill](/javascript/api/powerpoint/powerpoint.shapefill)|[setImage(base64EncodedImage: string)](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-setimage-member(1))|Sets the fill formatting of the shape to an image.|
+|[ShapeFont](/javascript/api/powerpoint/powerpoint.shapefont)|[allCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-allcaps-member)|Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters.|
+||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-doublestrikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute.|
+||[smallCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-smallcaps-member)|Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters.|
+||[strikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-strikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute.|
+||[subscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-subscript-member)|Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute.|
+||[superscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-superscript-member)|Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute.|
+|[ShapeGroup](/javascript/api/powerpoint/powerpoint.shapegroup)|[id](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-id-member)|Gets the unique ID of the shape group.|
+||[shape](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shape-member)|Returns the `Shape` object associated with the group.|
+||[shapes](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shapes-member)|Returns the collection of `Shape` objects in the group.|
+||[ungroup()](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.|
+|[ShapeScopedCollection](/javascript/api/powerpoint/powerpoint.shapescopedcollection)|[group()](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-group-member(1))|Groups all shapes in this collection into a single shape.|
+|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[applyLayout(slideLayout: PowerPoint.SlideLayout)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-applylayout-member(1))|Applies the specified layout to the slide, changing its design and structure according to the chosen layout.|
+||[exportAsBase64()](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-exportasbase64-member(1))|Exports the slide to its own presentation file, returned as Base64-encoded data.|
+||[getImageAsBase64(options?: PowerPoint.SlideGetImageOptions)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-getimageasbase64-member(1))|Renders an image of the slide.|
+||[index](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-index-member)|Returns the zero-based index of the slide representing its position in the presentation.|
+||[moveTo(slideIndex: number)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-moveto-member(1))|Moves the slide to a new position within the presentation.|
+|[SlideGetImageOptions](/javascript/api/powerpoint/powerpoint.slidegetimageoptions)|[height](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-height-member)|The desired height of the resulting image in pixels.|
+||[width](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-width-member)|The desired width of the resulting image in pixels.|
+|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[type](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-type-member)|Returns the type of the slide layout.|
+|[Table](/javascript/api/powerpoint/powerpoint.table)|[columnCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-columncount-member)|Gets the number of columns in the table.|
+||[getCellOrNullObject(rowIndex: number, columnIndex: number)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getcellornullobject-member(1))|Gets the cell at the specified `rowIndex` and `columnIndex`.|
+||[getMergedAreas()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getmergedareas-member(1))|Gets a collection of cells that represent the merged areas of the table.|
+||[getShape()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getshape-member(1))|Gets the shape object for the table.|
+||[rowCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-rowcount-member)|Gets the number of rows in the table.|
+||[values](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-values-member)|Gets all of the values in the table.|
+|[TableAddOptions](/javascript/api/powerpoint/powerpoint.tableaddoptions)|[columns](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-columns-member)|If provided, specifies properties for each column in the table.|
+||[height](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-height-member)|Specifies the height, in points, of the table.|
+||[left](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-left-member)|Specifies the distance, in points, from the left side of the table to the left side of the slide.|
+||[mergedAreas](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-mergedareas-member)|If specified, represents an rectangular area where multiple cells appear as a single cell.|
+||[rows](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-rows-member)|If provided, specifies properties for each row in the table.|
+||[specificCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-specificcellproperties-member)|If provided, specifies properties for each cell in the table.|
+||[top](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-top-member)|Specifies the distance, in points, from the top edge of the table to the top edge of the slide.|
+||[uniformCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-uniformcellproperties-member)|Specifies the formatting which applies uniformly to all of the table cells.|
+||[values](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-values-member)|If provided, specifies the values for the table.|
+||[width](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-width-member)|Specifies the width, in points, of the table.|
+|[TableCell](/javascript/api/powerpoint/powerpoint.tablecell)|[columnCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columncount-member)|Gets the number of table columns this cell spans across.|
+||[columnIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columnindex-member)|Gets the zero-based column index of the cell within the table.|
+||[rowCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowcount-member)|Gets the number of table rows this cell spans across.|
+||[rowIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowindex-member)|Gets the zero-based row index of the cell within the table.|
+||[text](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-text-member)|Specifies the text content of the table cell.|
+|[TableCellBorders](/javascript/api/powerpoint/powerpoint.tablecellborders)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-bottom-member)|Represents the bottom border.|
+||[diagonalDown](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonaldown-member)|Represents the diagonal border (top-left to bottom-right).|
+||[diagonalUp](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonalup-member)|Represents the diagonal border (bottom-left to top-right).|
+||[left](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-left-member)|Represents the left border.|
+||[right](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-right-member)|Represents the right border.|
+||[top](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-top-member)|Represents the top border.|
+|[TableCellCollection](/javascript/api/powerpoint/powerpoint.tablecellcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getcount-member(1))|Gets the number of table cells in the collection.|
+||[getItemAtOrNullObject(row: number, column: number)](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getitematornullobject-member(1))|Gets the table cell using its zero-based index in the collection.|
+||[items](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-items-member)|Gets the loaded child items in this collection.|
+|[TableCellMargins](/javascript/api/powerpoint/powerpoint.tablecellmargins)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-bottom-member)|Specifies the bottom margin in points.|
+||[left](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-left-member)|Specifies the left margin in points.|
+||[right](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-right-member)|Specifies the right margin in points.|
+||[top](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-top-member)|Specifies the top margin in points.|
+|[TableCellProperties](/javascript/api/powerpoint/powerpoint.tablecellproperties)|[borders](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-borders-member)|Specifies the border formatting of the table cell.|
+||[fill](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-fill-member)|Specifies the fill formatting of the table cell.|
+||[font](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-font-member)|Specifies the font formatting of the table cell.|
+||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-horizontalalignment-member)|Represents the horizontal alignment of the table cell.|
+||[indentLevel](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-indentlevel-member)|Represents the indent level of the text in the table cell.|
+||[margins](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-margins-member)|Specifies the margin settings in the table cell.|
+||[text](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-text-member)|Specifies the text content of the table cell.|
+||[textRuns](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-textruns-member)|Specifies the contents of the table cell as an array of TextRun objects.|
+||[verticalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-verticalalignment-member)|Represents the vertical alignment of the table cell.|
+|[TableColumnProperties](/javascript/api/powerpoint/powerpoint.tablecolumnproperties)|[columnWidth](/javascript/api/powerpoint/powerpoint.tablecolumnproperties#powerpoint-powerpoint-tablecolumnproperties-columnwidth-member)|Represents the desired width of each column in points, or is undefined.|
+|[TableMergedAreaProperties](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties)|[columnCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columncount-member)|Specifies the number of columns for the merged cells area.|
+||[columnIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columnindex-member)|Specifies the zero-based index of the column of the top left cell of the merged area.|
+||[rowCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowcount-member)|Specifies the number of rows for the merged cells area.|
+||[rowIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowindex-member)|Specifies the zero-based index of the row of the top left cell of the merged area.|
+|[TableRowProperties](/javascript/api/powerpoint/powerpoint.tablerowproperties)|[rowHeight](/javascript/api/powerpoint/powerpoint.tablerowproperties#powerpoint-powerpoint-tablerowproperties-rowheight-member)|Represents the desired height of each row in points, or is undefined.|
+|[TextRun](/javascript/api/powerpoint/powerpoint.textrun)|[font](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.|
+||[text](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-text-member)|The text of this text run.|
diff --git a/docs/includes/powerpoint-preview.md b/docs/includes/powerpoint-preview.md
index 4f9791f06c..76d510b80b 100644
--- a/docs/includes/powerpoint-preview.md
+++ b/docs/includes/powerpoint-preview.md
@@ -1,114 +1,2 @@
| Class | Fields | Description |
|:---|:---|:---|
-|[Binding](/javascript/api/powerpoint/powerpoint.binding)|[delete()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-delete-member(1))|Deletes the binding.|
-||[getShape()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-getshape-member(1))|Returns the shape represented by the binding.|
-||[id](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-id-member)|Represents the binding identifier.|
-||[type](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-type-member)|Returns the type of the binding.|
-|[BindingCollection](/javascript/api/powerpoint/powerpoint.bindingcollection)|[add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-add-member(1))|Adds a new binding to a particular Shape.|
-||[addFromSelection(bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-addfromselection-member(1))|Adds a new binding based on the current selection.|
-||[getCount()](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.|
-||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitem-member(1))|Gets a binding object by ID.|
-||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.|
-||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.|
-||[items](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-items-member)|Gets the loaded child items in this collection.|
-|[BorderProperties](/javascript/api/powerpoint/powerpoint.borderproperties)|[color](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").|
-||[dashStyle](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-dashstyle-member)|Represents the dash style of the line.|
-||[transparency](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).|
-||[weight](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-weight-member)|Represents the weight of the line, in points.|
-|[FillProperties](/javascript/api/powerpoint/powerpoint.fillproperties)|[color](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-color-member)|Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").|
-||[transparency](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
-|[FontProperties](/javascript/api/powerpoint/powerpoint.fontproperties)|[allCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-allcaps-member)|Represents whether the font uses all caps, where lowercase letters are shown as capital letters.|
-||[bold](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-bold-member)|Represents the bold status of font.|
-||[color](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-color-member)|Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").|
-||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-doublestrikethrough-member)|Represents the double-strikethrough status of the font.|
-||[italic](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-italic-member)|Represents the italic status of font.|
-||[name](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-name-member)|Represents the font name (e.g., "Calibri").|
-||[size](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-size-member)|Represents the font size in points (e.g., 11).|
-||[smallCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-smallcaps-member)|Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.|
-||[strikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-strikethrough-member)|Represents the strikethrough status of the font.|
-||[subscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-subscript-member)|Represents the subscript status of the font.|
-||[superscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-superscript-member)|Represents the superscript status of the font.|
-||[underline](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-underline-member)|Type of underline applied to the font.|
-|[PlaceholderFormat](/javascript/api/powerpoint/powerpoint.placeholderformat)|[containedType](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-containedtype-member)|Gets the type of the shape contained within the placeholder.|
-||[type](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-type-member)|Returns the type of this placeholder.|
-|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[bindings](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-bindings-member)|Returns a collection of bindings that are associated with the presentation.|
-|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[getTable()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-gettable-member(1))|Returns the `Table` object if this shape is a table.|
-||[group](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-group-member)|Returns the `ShapeGroup` associated with the shape.|
-||[level](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-level-member)|Returns the level of the specified shape.|
-||[parentGroup](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-parentgroup-member)|Returns the parent group of this shape.|
-||[placeholderFormat](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-placeholderformat-member)|Returns the properties that apply specifically to this placeholder.|
-||[setZOrder(position: PowerPoint.ShapeZOrder)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.|
-||[zOrderPosition](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-zorderposition-member)|Returns the z-order position of the shape, with 0 representing the bottom of the order stack.|
-|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[addGroup(values: Array)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addgroup-member(1))|Create a shape group for several shapes.|
-||[addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addtable-member(1))|Adds a table to the slide.|
-|[ShapeFill](/javascript/api/powerpoint/powerpoint.shapefill)|[setImage(base64EncodedImage: string)](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-setimage-member(1))|Sets the fill formatting of the shape to an image.|
-|[ShapeFont](/javascript/api/powerpoint/powerpoint.shapefont)|[allCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-allcaps-member)|Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters.|
-||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-doublestrikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute.|
-||[smallCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-smallcaps-member)|Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters.|
-||[strikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-strikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute.|
-||[subscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-subscript-member)|Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute.|
-||[superscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-superscript-member)|Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute.|
-|[ShapeGroup](/javascript/api/powerpoint/powerpoint.shapegroup)|[id](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-id-member)|Gets the unique ID of the shape group.|
-||[shape](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shape-member)|Returns the `Shape` object associated with the group.|
-||[shapes](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shapes-member)|Returns the collection of `Shape` objects in the group.|
-||[ungroup()](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.|
-|[ShapeScopedCollection](/javascript/api/powerpoint/powerpoint.shapescopedcollection)|[group()](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-group-member(1))|Groups all shapes in this collection into a single shape.|
-|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[applyLayout(slideLayout: PowerPoint.SlideLayout)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-applylayout-member(1))|Applies the specified layout to the slide, changing its design and structure according to the chosen layout.|
-||[exportAsBase64()](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-exportasbase64-member(1))|Exports the slide to its own presentation file, returned as Base64-encoded data.|
-||[getImageAsBase64(options?: PowerPoint.SlideGetImageOptions)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-getimageasbase64-member(1))|Renders an image of the slide.|
-||[index](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-index-member)|Returns the zero-based index of the slide representing its position in the presentation.|
-||[moveTo(slideIndex: number)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-moveto-member(1))|Moves the slide to a new position within the presentation.|
-|[SlideGetImageOptions](/javascript/api/powerpoint/powerpoint.slidegetimageoptions)|[height](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-height-member)|The desired height of the resulting image in pixels.|
-||[width](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-width-member)|The desired width of the resulting image in pixels.|
-|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[type](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-type-member)|Returns the type of the slide layout.|
-|[Table](/javascript/api/powerpoint/powerpoint.table)|[columnCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-columncount-member)|Gets the number of columns in the table.|
-||[getCellOrNullObject(rowIndex: number, columnIndex: number)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getcellornullobject-member(1))|Gets the cell at the specified `rowIndex` and `columnIndex`.|
-||[getMergedAreas()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getmergedareas-member(1))|Gets a collection of cells that represent the merged areas of the table.|
-||[getShape()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getshape-member(1))|Gets the shape object for the table.|
-||[rowCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-rowcount-member)|Gets the number of rows in the table.|
-||[values](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-values-member)|Gets all of the values in the table.|
-|[TableAddOptions](/javascript/api/powerpoint/powerpoint.tableaddoptions)|[columns](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-columns-member)|If provided, specifies properties for each column in the table.|
-||[height](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-height-member)|Specifies the height, in points, of the table.|
-||[left](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-left-member)|Specifies the distance, in points, from the left side of the table to the left side of the slide.|
-||[mergedAreas](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-mergedareas-member)|If specified, represents an rectangular area where multiple cells appear as a single cell.|
-||[rows](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-rows-member)|If provided, specifies properties for each row in the table.|
-||[specificCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-specificcellproperties-member)|If provided, specifies properties for each cell in the table.|
-||[top](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-top-member)|Specifies the distance, in points, from the top edge of the table to the top edge of the slide.|
-||[uniformCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-uniformcellproperties-member)|Specifies the formatting which applies uniformly to all of the table cells.|
-||[values](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-values-member)|If provided, specifies the values for the table.|
-||[width](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-width-member)|Specifies the width, in points, of the table.|
-|[TableCell](/javascript/api/powerpoint/powerpoint.tablecell)|[columnCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columncount-member)|Gets the number of table columns this cell spans across.|
-||[columnIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columnindex-member)|Gets the zero-based column index of the cell within the table.|
-||[rowCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowcount-member)|Gets the number of table rows this cell spans across.|
-||[rowIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowindex-member)|Gets the zero-based row index of the cell within the table.|
-||[text](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-text-member)|Specifies the text content of the table cell.|
-|[TableCellBorders](/javascript/api/powerpoint/powerpoint.tablecellborders)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-bottom-member)|Represents the bottom border.|
-||[diagonalDown](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonaldown-member)|Represents the diagonal border (top-left to bottom-right).|
-||[diagonalUp](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonalup-member)|Represents the diagonal border (bottom-left to top-right).|
-||[left](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-left-member)|Represents the left border.|
-||[right](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-right-member)|Represents the right border.|
-||[top](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-top-member)|Represents the top border.|
-|[TableCellCollection](/javascript/api/powerpoint/powerpoint.tablecellcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getcount-member(1))|Gets the number of table cells in the collection.|
-||[getItemAtOrNullObject(row: number, column: number)](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getitematornullobject-member(1))|Gets the table cell using its zero-based index in the collection.|
-||[items](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-items-member)|Gets the loaded child items in this collection.|
-|[TableCellMargins](/javascript/api/powerpoint/powerpoint.tablecellmargins)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-bottom-member)|Specifies the bottom margin in points.|
-||[left](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-left-member)|Specifies the left margin in points.|
-||[right](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-right-member)|Specifies the right margin in points.|
-||[top](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-top-member)|Specifies the top margin in points.|
-|[TableCellProperties](/javascript/api/powerpoint/powerpoint.tablecellproperties)|[borders](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-borders-member)|Specifies the border formatting of the table cell.|
-||[fill](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-fill-member)|Specifies the fill formatting of the table cell.|
-||[font](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-font-member)|Specifies the font formatting of the table cell.|
-||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-horizontalalignment-member)|Represents the horizontal alignment of the table cell.|
-||[indentLevel](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-indentlevel-member)|Represents the indent level of the text in the table cell.|
-||[margins](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-margins-member)|Specifies the margin settings in the table cell.|
-||[text](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-text-member)|Specifies the text content of the table cell.|
-||[textRuns](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-textruns-member)|Specifies the contents of the table cell as an array of TextRun objects.|
-||[verticalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-verticalalignment-member)|Represents the vertical alignment of the table cell.|
-|[TableColumnProperties](/javascript/api/powerpoint/powerpoint.tablecolumnproperties)|[columnWidth](/javascript/api/powerpoint/powerpoint.tablecolumnproperties#powerpoint-powerpoint-tablecolumnproperties-columnwidth-member)|Represents the desired width of each column in points, or is undefined.|
-|[TableMergedAreaProperties](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties)|[columnCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columncount-member)|Specifies the number of columns for the merged cells area.|
-||[columnIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columnindex-member)|Specifies the zero-based index of the column of the top left cell of the merged area.|
-||[rowCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowcount-member)|Specifies the number of rows for the merged cells area.|
-||[rowIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowindex-member)|Specifies the zero-based index of the row of the top left cell of the merged area.|
-|[TableRowProperties](/javascript/api/powerpoint/powerpoint.tablerowproperties)|[rowHeight](/javascript/api/powerpoint/powerpoint.tablerowproperties#powerpoint-powerpoint-tablerowproperties-rowheight-member)|Represents the desired height of each row in points, or is undefined.|
-|[TextRun](/javascript/api/powerpoint/powerpoint.textrun)|[font](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.|
-||[text](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-text-member)|The text of this text run.|
diff --git a/docs/requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md b/docs/requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
new file mode 100644
index 0000000000..a48f14f2f3
--- /dev/null
+++ b/docs/requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
@@ -0,0 +1,23 @@
+---
+title: PowerPoint JavaScript API requirement set 1.8
+description: Details about the PowerPointApi 1.8 requirement set.
+ms.date: 04/30/2025
+ms.topic: whats-new
+ms.localizationpriority: medium
+---
+
+# What's new in PowerPoint JavaScript API 1.8
+
+PowerPointApi 1.8 added APIs to manage bindings, shapes, and tables in the presentation.
+
+## API list
+
+The following table lists the PowerPoint JavaScript API requirement set 1.8. For a complete list of all PowerPoint JavaScript APIs (including preview APIs and previously released APIs), see [all PowerPoint JavaScript APIs](/javascript/api/powerpoint?view=powerpoint-js-preview&preserve-view=true).
+
+
+[!INCLUDE[API table](../../includes/powerpoint-1_8.md)]
+
+## See also
+
+- [PowerPoint JavaScript API Reference Documentation](/javascript/api/powerpoint?view=powerpoint-js-1.8&preserve-view=true)
+- [PowerPoint JavaScript API requirement sets](powerpoint-api-requirement-sets.md)
diff --git a/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md b/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md
index acfcff4512..e4edd19d1e 100644
--- a/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md
+++ b/docs/requirement-sets/powerpoint/powerpoint-api-requirement-sets.md
@@ -1,7 +1,7 @@
---
title: PowerPoint JavaScript API requirement sets
description: Learn more about the PowerPoint JavaScript API requirement sets.
-ms.date: 01/16/2025
+ms.date: 04/30/2025
ms.topic: overview
ms.localizationpriority: high
---
@@ -15,6 +15,7 @@ The following table lists the PowerPoint requirement sets, the supported Office
| Requirement set | Office on the web | Office on Windows- Microsoft 365 subscription
- retail perpetual
| Office on Windows- volume-licensed perpetual
| Office on Mac | Office on iPad |
|:-----|:-----|:-----|:-----|:-----|:-----|
| [Preview](powerpoint-preview-apis.md) | Please use the latest Office version to try preview APIs (you may need to join the [Microsoft 365 Insider program](https://insider.microsoft365.com/join)). |
+| [PowerPointApi 1.8](powerpoint-api-1-8-requirement-set.md) | Supported | Version 2504 (Build 18730.20030) | Not available | Version 16.96 (25041326) | Not available |
| [PowerPointApi 1.7](powerpoint-api-1-7-requirement-set.md) | Supported | Version 2412 (Build 18324.20030) | Not available | Version 16.92 (24120731) | Not available |
| [PowerPointApi 1.6](powerpoint-api-1-6-requirement-set.md) | Supported | Version 2410 (Build 18129.20030) | Not available | Version 16.90 (24101387) | Not available |
| [PowerPointApi 1.5](powerpoint-api-1-5-requirement-set.md) | Supported | Version 2208 (Build 15601.20230) | Office 2024: Version 2208 (Build 15601.20230) | Version 16.64 (22080400) | Not available |
@@ -57,6 +58,10 @@ PowerPoint JavaScript API 1.6 includes APIs to select slides, text ranges, and s
PowerPoint JavaScript API 1.7 includes APIs to manage custom and document properties within presentations. For more information, see [PowerPoint JavaScript API requirement set 1.7](powerpoint-api-1-7-requirement-set.md).
+## PowerPoint JavaScript API 1.8
+
+PowerPoint JavaScript API 1.8 includes APIs to manage bindings, shapes, and tables within presentations. For more information, see [PowerPoint JavaScript API requirement set 1.8](powerpoint-api-1-8-requirement-set.md).
+
## How to use PowerPoint requirement sets at runtime and in the manifest
> [!NOTE]
diff --git a/docs/requirement-sets/powerpoint/powerpoint-preview-apis.md b/docs/requirement-sets/powerpoint/powerpoint-preview-apis.md
index 5dbf854a93..8b4255b0f5 100644
--- a/docs/requirement-sets/powerpoint/powerpoint-preview-apis.md
+++ b/docs/requirement-sets/powerpoint/powerpoint-preview-apis.md
@@ -1,7 +1,7 @@
---
title: PowerPoint JavaScript preview APIs
description: Details about upcoming PowerPoint JavaScript APIs.
-ms.date: 02/25/2025
+ms.date: 04/30/2025
ms.topic: whats-new
ms.localizationpriority: medium
---
diff --git a/docs/requirement-sets/requirement-sets.md b/docs/requirement-sets/requirement-sets.md
index 892d471226..f1b7b74db2 100644
--- a/docs/requirement-sets/requirement-sets.md
+++ b/docs/requirement-sets/requirement-sets.md
@@ -1,7 +1,7 @@
---
title: Office client application and platform availability for Office Add-ins
description: Supported requirement sets for Excel, OneNote, Outlook, PowerPoint, Project, and Word.
-ms.date: 04/09/2025
+ms.date: 04/30/2025
ms.topic: overview
ms.localizationpriority: high
---
@@ -98,14 +98,14 @@ To work as expected, your Office Add-in might depend on a specific Office applic
|Platform|Extension points|Application-specific API requirement sets|[Common API requirement sets](common/office-add-in-requirement-sets.md)|
|---|---|---|---|
-|Office on the web|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DevicePermissionService 1.1](common/device-permission-service-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
-|Office on Windows
(Microsoft 365 subscription)|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
-|Office on Windows
(retail perpetual Office 2016 and later)|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
+|Office on the web|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
- [PowerPointApi 1.8](powerpoint/powerpoint-api-1-8-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DevicePermissionService 1.1](common/device-permission-service-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
+|Office on Windows
(Microsoft 365 subscription)|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
- [PowerPointApi 1.8](powerpoint/powerpoint-api-1-8-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
+|Office on Windows
(retail perpetual Office 2016 and later)|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
- [PowerPointApi 1.8](powerpoint/powerpoint-api-1-8-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
|Office 2024 on Windows
(volume-licensed perpetual)|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
|Office 2021 on Windows
(volume-licensed perpetual)|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
|Office 2019 on Windows
(volume-licensed perpetual)|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|Not available|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)\*
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
|Office 2016 on Windows
(volume-licensed perpetual)||Not available|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)\*
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
-|Office on Mac|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
+|Office on Mac|- Content
- TaskPane
- [Add-in Commands](common/add-in-commands-requirement-sets.md)
|- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
- [PowerPointApi 1.2](powerpoint/powerpoint-api-1-2-requirement-set.md)
- [PowerPointApi 1.3](powerpoint/powerpoint-api-1-3-requirement-set.md)
- [PowerPointApi 1.4](powerpoint/powerpoint-api-1-4-requirement-set.md)
- [PowerPointApi 1.5](powerpoint/powerpoint-api-1-5-requirement-set.md)
- [PowerPointApi 1.6](powerpoint/powerpoint-api-1-6-requirement-set.md)
- [PowerPointApi 1.7](powerpoint/powerpoint-api-1-7-requirement-set.md)
- [PowerPointApi 1.8](powerpoint/powerpoint-api-1-8-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
|Office on iPad||- [PowerPointApi 1.1](powerpoint/powerpoint-api-1-1-requirement-set.md)
|- [ActiveView](common/office-add-in-requirement-sets.md#activeview)
- [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
- [DialogApi 1.1](common/dialog-api-requirement-sets.md)
- [DialogApi 1.2](common/dialog-api-requirement-sets.md)
- [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
- [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
- [File](common/office-add-in-requirement-sets.md#file)
- [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
- [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
- [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
- [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
- [Selection](common/office-add-in-requirement-sets.md#selection)
- [Settings](common/office-add-in-requirement-sets.md#settings)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
** Added with post-release updates.*
diff --git a/docs/toc.yml b/docs/toc.yml
index cf5443676b..ce4e0522be 100644
--- a/docs/toc.yml
+++ b/docs/toc.yml
@@ -522,6 +522,9 @@ items:
- name: PowerPoint preview APIs
href: requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.8 requirement set
+ href: requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.7 requirement set
href: requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md
displayName: PowerPoint
diff --git a/generate-docs/GenerateDocs.sh b/generate-docs/GenerateDocs.sh
index cc8aa5a6d7..efd3a0a018 100644
--- a/generate-docs/GenerateDocs.sh
+++ b/generate-docs/GenerateDocs.sh
@@ -100,6 +100,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_8/powerpoint.d.ts "PowerPointApi 1.8" ../api-extractor-inputs-powerpoint-release/powerpoint_1_7/powerpoint.d.ts
node version-remover ../api-extractor-inputs-powerpoint-release/powerpoint_1_7/powerpoint.d.ts "PowerPointApi 1.7" ../api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.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
@@ -181,7 +182,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_7/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_8/powerpoint.d.ts ../../docs/includes/powerpoint-preview
+node whats-new powerpoint ../api-extractor-inputs-powerpoint-release/powerpoint_1_8/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_7/powerpoint.d.ts ../../docs/includes/powerpoint-1_8
node whats-new powerpoint ../api-extractor-inputs-powerpoint-release/powerpoint_1_7/powerpoint.d.ts ../api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts ../../docs/includes/powerpoint-1_7
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
@@ -453,6 +455,12 @@ if [ ! -d "json/powerpoint" ]; then
../node_modules/.bin/api-extractor run
popd
fi
+if [ ! -d "json/powerpoint_1_8" ]; then
+ echo Running API Extractor for PowerPoint 1.8.
+ pushd api-extractor-inputs-powerpoint-release/PowerPoint_1_8
+ ../../node_modules/.bin/api-extractor run
+ popd
+fi
if [ ! -d "json/powerpoint_1_7" ]; then
echo Running API Extractor for PowerPoint 1.7.
pushd api-extractor-inputs-powerpoint-release/PowerPoint_1_7
@@ -761,6 +769,9 @@ fi
if [ ! -d "yaml/powerpoint_1_7" ]; then
./node_modules/.bin/api-documenter yaml --input-folder ./json/powerpoint_1_7 --output-folder ./yaml/powerpoint_1_7 --office 2>/dev/null
fi
+if [ ! -d "yaml/powerpoint_1_8" ]; then
+ ./node_modules/.bin/api-documenter yaml --input-folder ./json/powerpoint_1_8 --output-folder ./yaml/powerpoint_1_8 --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 5a18e54b24..7583a14a6a 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
@@ -37,6 +37,7 @@ export declare namespace PowerPoint {
+
readonly title: string;
@@ -92,6 +93,29 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -160,6 +184,20 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+ }
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
}
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
export interface ShapeCollectionUpdateData {
@@ -221,6 +259,10 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
export interface CustomPropertyUpdateData {
@@ -271,6 +313,11 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+
+
}
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
export interface HyperlinkData {
@@ -290,9 +337,33 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
+
+
+
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+
}
@@ -304,6 +375,7 @@ export declare namespace PowerPoint {
export interface SlideLayoutData {
+
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
export interface SlideLayoutCollectionData {
@@ -326,10 +398,15 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `slide.toJSON()`. */
export interface SlideData {
+
}
/** 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+
}
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
export interface ShapeLineFormatData {
@@ -374,6 +451,17 @@ export declare namespace PowerPoint {
+
+
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+
+
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
export interface CustomPropertyData {
@@ -443,6 +531,13 @@ 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 21aa3d48f8..e099dcc82c 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
@@ -34,6 +34,7 @@ export declare namespace PowerPoint {
+
/**
* Returns an ordered collection of slides in the presentation.
*
@@ -106,6 +107,25 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -131,6 +151,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
readonly id: string;
+
+
/**
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
*
@@ -139,6 +161,9 @@ export declare namespace PowerPoint {
*/
delete(): void;
+
+
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -179,6 +204,10 @@ export declare namespace PowerPoint {
+
+
+
+
/**
* Specifies the formatting options for when slides are inserted.
*
@@ -359,6 +388,20 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+ }
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
}
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
export interface ShapeCollectionUpdateData {
@@ -420,6 +463,10 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
export interface CustomPropertyUpdateData {
@@ -470,6 +517,11 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+
+
}
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
export interface HyperlinkData {
@@ -489,9 +541,33 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
+
+
+
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+
}
@@ -503,6 +579,7 @@ export declare namespace PowerPoint {
export interface SlideLayoutData {
+
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
export interface SlideLayoutCollectionData {
@@ -531,10 +608,15 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: string;
+
}
/** 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+
}
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
export interface ShapeLineFormatData {
@@ -579,6 +661,17 @@ export declare namespace PowerPoint {
+
+
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+
+
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
export interface CustomPropertyData {
@@ -642,6 +735,10 @@ export declare namespace PowerPoint {
+
+
+
+
/**
* Represents a single slide of a presentation.
*
@@ -662,6 +759,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
@@ -673,6 +771,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Represents the collection of slides in the presentation.
*
@@ -693,6 +794,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
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 f5eb0fd35d..fcce58e5e8 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
@@ -33,6 +33,7 @@ export declare namespace PowerPoint {
context: RequestContext;
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -137,6 +138,23 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -157,6 +175,8 @@ export declare namespace PowerPoint {
+
+
/**
* Gets the number of shapes in the collection.
*
@@ -219,6 +239,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
}
+
+
/**
* Represents the layout of a slide.
*
@@ -250,6 +272,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -604,6 +627,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
readonly id: string;
+
+
/**
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
*
@@ -612,6 +637,9 @@ export declare namespace PowerPoint {
*/
delete(): void;
+
+
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -647,6 +675,8 @@ export declare namespace PowerPoint {
+
+
/**
* Represents a single shape in the slide.
*
@@ -659,6 +689,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Returns a collection of tags in the shape.
*
@@ -680,6 +713,8 @@ export declare namespace PowerPoint {
+
+
/**
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
*
@@ -693,6 +728,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -724,6 +762,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the formatting options for when slides are inserted.
*
@@ -905,7 +945,7 @@ export declare namespace PowerPoint {
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}."
+ 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]
@@ -985,6 +1025,20 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+ }
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
}
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
export interface ShapeCollectionUpdateData {
@@ -1052,6 +1106,10 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
export interface CustomPropertyUpdateData {
@@ -1102,6 +1160,11 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+
+
}
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
export interface HyperlinkData {
@@ -1121,11 +1184,35 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
+
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+
+
+
}
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
export interface ShapeCollectionData {
@@ -1147,6 +1234,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: string;
+
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
export interface SlideLayoutCollectionData {
@@ -1199,10 +1287,15 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: string;
+
}
/** 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+
}
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
export interface ShapeLineFormatData {
@@ -1253,6 +1346,17 @@ export declare namespace PowerPoint {
+
+
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+
+
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
export interface CustomPropertyData {
@@ -1310,6 +1414,10 @@ export declare namespace PowerPoint {
+
+
+
+
/**
* Represents the collection of shapes.
*
@@ -1325,6 +1433,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the shape.
*
@@ -1337,6 +1448,8 @@ export declare namespace PowerPoint {
+
+
}
/**
* Represents the layout of a slide.
@@ -1363,6 +1476,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the collection of layouts provided by the Slide Master for slides.
@@ -1389,6 +1503,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the Slide Master of a slide.
@@ -1500,6 +1615,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
@@ -1507,6 +1623,7 @@ export declare namespace PowerPoint {
+
/**
* Represents a single shape in the slide.
*
@@ -1522,6 +1639,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Gets the unique ID of the shape.
*
@@ -1531,6 +1651,8 @@ export declare namespace PowerPoint {
id?: boolean;
+
+
@@ -1538,6 +1660,8 @@ export declare namespace PowerPoint {
+
+
/**
* Represents the collection of slides in the presentation.
*
@@ -1570,6 +1694,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
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 2952489495..8be41d6594 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
@@ -33,6 +33,7 @@ export declare namespace PowerPoint {
context: RequestContext;
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -128,6 +129,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the type of a shape.
*
@@ -252,6 +255,7 @@ export declare namespace PowerPoint {
}
+
/**
* Specifies the connector type for line shapes.
*
@@ -1601,6 +1605,7 @@ export declare namespace PowerPoint {
* [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`.
*
@@ -1756,6 +1761,7 @@ export declare namespace PowerPoint {
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;
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -1776,6 +1782,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -1803,6 +1810,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -1837,6 +1848,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeFontData;
}
+
+
/**
* 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.
@@ -1883,6 +1896,18 @@ export declare namespace PowerPoint {
*/
bottomCentered = "BottomCentered",
}
+
+
+
+
+
+
+
+
+
+
+
+
/**
* Represents the collection of shapes.
*
@@ -1916,6 +1941,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -1938,7 +1964,8 @@ export declare namespace PowerPoint {
* @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
@@ -2011,6 +2038,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
}
+
+
/**
* Represents the layout of a slide.
*
@@ -2042,6 +2071,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -2396,6 +2426,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
readonly id: string;
+
+
/**
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
*
@@ -2404,6 +2436,9 @@ export declare namespace PowerPoint {
*/
delete(): void;
+
+
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -2432,6 +2467,7 @@ export declare namespace PowerPoint {
toJSON(): PowerPoint.Interfaces.SlideData;
}
+
/**
* Specifies the style for a line.
*
@@ -2851,6 +2887,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.TextFrameData;
}
+
/**
* Represents a single shape in the slide.
*
@@ -2868,6 +2905,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly fill: PowerPoint.ShapeFill;
+
/**
* Returns the line formatting of this shape.
*
@@ -2875,6 +2913,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly lineFormat: PowerPoint.ShapeLineFormat;
+
+
/**
* Returns a collection of tags in the shape.
*
@@ -2910,6 +2950,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left: number;
+
/**
* Specifies the name of this shape.
*
@@ -2938,6 +2979,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width: number;
+
/**
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
*
@@ -2951,6 +2993,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -2982,6 +3027,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the formatting options for when slides are inserted.
*
@@ -3163,7 +3210,7 @@ export declare namespace PowerPoint {
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}."
+ 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]
@@ -3249,6 +3296,7 @@ export declare namespace PowerPoint {
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -3269,6 +3317,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -3296,6 +3345,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -3304,6 +3357,14 @@ export declare namespace PowerPoint {
*/
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
}
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
export interface ShapeCollectionUpdateData {
items?: PowerPoint.Interfaces.ShapeData[];
@@ -3497,6 +3558,10 @@ export declare namespace PowerPoint {
*/
width?: number;
}
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
+ }
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
export interface CustomPropertyUpdateData {
@@ -3546,6 +3611,11 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+
+
}
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
export interface HyperlinkData {
@@ -3582,7 +3652,8 @@ export declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
- /**
+
+ /**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
* - `true`: All the text is bold.
@@ -3602,6 +3673,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -3629,6 +3701,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -3636,6 +3712,24 @@ export declare namespace PowerPoint {
* [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" | null;
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+
+
+
}
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
export interface ShapeCollectionData {
@@ -3657,6 +3751,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: string;
+
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
export interface SlideLayoutCollectionData {
@@ -3709,10 +3804,15 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: string;
+
}
/** 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+
}
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
export interface ShapeLineFormatData {
@@ -3873,6 +3973,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: number;
+
/**
* Specifies the name of this shape.
*
@@ -3901,6 +4002,16 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: number;
+
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+
+
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
export interface CustomPropertyData {
@@ -3956,6 +4067,7 @@ export declare namespace PowerPoint {
+
/**
* Represents the fill formatting of a shape object.
*
@@ -4000,6 +4112,7 @@ export declare namespace PowerPoint {
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 whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -4020,6 +4133,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: boolean;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -4047,6 +4161,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: boolean;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -4055,6 +4173,9 @@ export declare namespace PowerPoint {
*/
underline?: boolean;
}
+
+
+
/**
* Represents the collection of shapes.
*
@@ -4073,6 +4194,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -4080,6 +4202,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -4108,6 +4232,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -4136,6 +4261,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
/**
* Represents the layout of a slide.
@@ -4162,6 +4288,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the collection of layouts provided by the Slide Master for slides.
@@ -4188,6 +4315,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the Slide Master of a slide.
@@ -4299,8 +4427,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
+
/**
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
*
@@ -4528,6 +4658,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* Returns the line formatting of this shape.
*
@@ -4535,6 +4666,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* Returns the text frame object of this shape.
*
@@ -4563,7 +4696,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
- /**
+
+ /**
* Specifies the name of this shape.
*
* @remarks
@@ -4591,10 +4725,13 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
+
+
/**
* Represents the collection of slides in the presentation.
*
@@ -4627,6 +4764,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
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 b8e1ca819b..7a4b76d59a 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
@@ -33,6 +33,7 @@ export declare namespace PowerPoint {
context: RequestContext;
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -171,6 +172,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the type of a shape.
*
@@ -295,6 +298,7 @@ export declare namespace PowerPoint {
}
+
/**
* Specifies the connector type for line shapes.
*
@@ -1644,6 +1648,7 @@ export declare namespace PowerPoint {
* [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`.
*
@@ -1799,6 +1804,7 @@ export declare namespace PowerPoint {
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;
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -1819,6 +1825,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -1846,6 +1853,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -1880,6 +1891,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeFontData;
}
+
+
/**
* 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.
@@ -1926,6 +1939,18 @@ export declare namespace PowerPoint {
*/
bottomCentered = "BottomCentered",
}
+
+
+
+
+
+
+
+
+
+
+
+
/**
* Represents the collection of shapes.
*
@@ -1959,6 +1984,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -1981,7 +2007,8 @@ export declare namespace PowerPoint {
* @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
@@ -2054,6 +2081,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
}
+
+
/**
* Represents the layout of a slide.
*
@@ -2085,6 +2114,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -2439,6 +2469,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
readonly id: string;
+
+
/**
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
*
@@ -2446,6 +2478,9 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
delete(): void;
+
+
+
/**
* Selects the specified shapes. Existing shape selection is replaced with the new selection.
*
@@ -2531,6 +2566,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -2555,6 +2591,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
}
+
/**
* Specifies the style for a line.
*
@@ -3006,6 +3043,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.TextFrameData;
}
+
/**
* Represents a single shape in the slide.
*
@@ -3023,6 +3061,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly fill: PowerPoint.ShapeFill;
+
/**
* Returns the line formatting of this shape.
*
@@ -3030,6 +3069,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly lineFormat: PowerPoint.ShapeLineFormat;
+
+
/**
* Returns a collection of tags in the shape.
*
@@ -3065,6 +3106,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left: number;
+
/**
* Specifies the name of this shape.
*
@@ -3093,6 +3135,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width: number;
+
/**
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
*
@@ -3142,6 +3185,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3173,6 +3219,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the formatting options for when slides are inserted.
*
@@ -3427,7 +3475,7 @@ export declare namespace PowerPoint {
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}."
+ 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]
@@ -3513,6 +3561,7 @@ export declare namespace PowerPoint {
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -3533,6 +3582,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -3560,6 +3610,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -3568,6 +3622,14 @@ export declare namespace PowerPoint {
*/
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
}
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
export interface ShapeCollectionUpdateData {
items?: PowerPoint.Interfaces.ShapeData[];
@@ -3775,6 +3837,10 @@ export declare namespace PowerPoint {
*/
width?: number;
}
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
+ }
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
export interface CustomPropertyUpdateData {
@@ -3830,6 +3896,11 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+
+
}
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
export interface HyperlinkData {
@@ -3866,7 +3937,8 @@ export declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
- /**
+
+ /**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
* - `true`: All the text is bold.
@@ -3886,6 +3958,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -3913,6 +3986,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -3920,6 +3997,24 @@ export declare namespace PowerPoint {
* [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" | null;
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+
+
+
}
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
export interface ShapeCollectionData {
@@ -3941,6 +4036,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: string;
+
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
export interface SlideLayoutCollectionData {
@@ -3993,10 +4089,15 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: string;
+
}
/** 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+
}
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
export interface ShapeLineFormatData {
@@ -4171,6 +4272,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: number;
+
/**
* Specifies the name of this shape.
*
@@ -4199,6 +4301,16 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: number;
+
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+
+
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
export interface CustomPropertyData {
@@ -4260,6 +4372,7 @@ export declare namespace PowerPoint {
+
/**
* Represents the fill formatting of a shape object.
*
@@ -4304,6 +4417,7 @@ export declare namespace PowerPoint {
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 whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -4324,6 +4438,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: boolean;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -4351,6 +4466,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: boolean;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -4359,6 +4478,9 @@ export declare namespace PowerPoint {
*/
underline?: boolean;
}
+
+
+
/**
* Represents the collection of shapes.
*
@@ -4377,6 +4499,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -4384,6 +4507,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -4412,6 +4537,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -4440,6 +4566,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
/**
* Represents the layout of a slide.
@@ -4466,6 +4593,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the collection of layouts provided by the Slide Master for slides.
@@ -4492,6 +4620,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the Slide Master of a slide.
@@ -4603,6 +4732,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents a collection of shapes.
@@ -4622,6 +4752,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -4629,6 +4760,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -4657,6 +4790,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -4685,7 +4819,9 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
+
/**
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
*
@@ -4927,6 +5063,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* Returns the line formatting of this shape.
*
@@ -4934,6 +5071,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* Returns the text frame object of this shape.
*
@@ -4962,7 +5101,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
- /**
+
+ /**
* Specifies the name of this shape.
*
* @remarks
@@ -4990,10 +5130,13 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
+
+
/**
* Represents the collection of slides in the presentation.
*
@@ -5026,6 +5169,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents a collection of slides in the presentation.
@@ -5059,6 +5203,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents the collection of Slide Masters in the presentation.
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
index a23e6c2e0b..b4d7297bae 100644
--- 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
@@ -33,6 +33,7 @@ export declare namespace PowerPoint {
context: RequestContext;
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -171,6 +172,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the type of a shape.
*
@@ -293,6 +296,7 @@ export declare namespace PowerPoint {
*/
textBox = "TextBox",
}
+
/**
* Represents a single hyperlink.
*
@@ -1745,6 +1749,7 @@ export declare namespace PowerPoint {
* [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`.
*
@@ -1900,6 +1905,7 @@ export declare namespace PowerPoint {
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;
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -1920,6 +1926,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -1947,6 +1954,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -1981,6 +1992,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeFontData;
}
+
+
/**
* 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.
@@ -2027,6 +2040,18 @@ export declare namespace PowerPoint {
*/
bottomCentered = "BottomCentered",
}
+
+
+
+
+
+
+
+
+
+
+
+
/**
* Represents the collection of shapes.
*
@@ -2060,6 +2085,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -2082,7 +2108,8 @@ export declare namespace PowerPoint {
* @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
@@ -2155,6 +2182,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
}
+
+
/**
* Represents the layout of a slide.
*
@@ -2186,6 +2215,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -2546,6 +2576,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
readonly id: string;
+
+
/**
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
*
@@ -2553,6 +2585,9 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
delete(): void;
+
+
+
/**
* Selects the specified shapes. Existing shape selection is replaced with the new selection.
*
@@ -2638,6 +2673,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -2662,6 +2698,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
}
+
/**
* Specifies the style for a line.
*
@@ -3113,6 +3150,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.TextFrameData;
}
+
/**
* Represents a single shape in the slide.
*
@@ -3130,6 +3168,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly fill: PowerPoint.ShapeFill;
+
/**
* Returns the line formatting of this shape.
*
@@ -3137,6 +3176,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly lineFormat: PowerPoint.ShapeLineFormat;
+
+
/**
* Returns a collection of tags in the shape.
*
@@ -3172,6 +3213,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left: number;
+
/**
* Specifies the name of this shape.
*
@@ -3200,6 +3242,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width: number;
+
/**
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
*
@@ -3249,6 +3292,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3280,6 +3326,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the formatting options for when slides are inserted.
*
@@ -3534,7 +3582,7 @@ export declare namespace PowerPoint {
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}."
+ 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]
@@ -3632,6 +3680,7 @@ export declare namespace PowerPoint {
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -3652,6 +3701,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -3679,6 +3729,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -3687,6 +3741,14 @@ export declare namespace PowerPoint {
*/
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
}
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
export interface ShapeCollectionUpdateData {
items?: PowerPoint.Interfaces.ShapeData[];
@@ -3894,6 +3956,10 @@ export declare namespace PowerPoint {
*/
width?: number;
}
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
+ }
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
export interface CustomPropertyUpdateData {
@@ -3949,6 +4015,11 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+
+
}
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
export interface HyperlinkData {
@@ -3997,7 +4068,8 @@ export declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
- /**
+
+ /**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
* - `true`: All the text is bold.
@@ -4017,6 +4089,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -4044,6 +4117,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -4051,6 +4128,24 @@ export declare namespace PowerPoint {
* [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" | null;
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+
+
+
}
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
export interface ShapeCollectionData {
@@ -4072,6 +4167,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: string;
+
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
export interface SlideLayoutCollectionData {
@@ -4124,10 +4220,15 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: string;
+
}
/** 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+
}
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
export interface ShapeLineFormatData {
@@ -4302,6 +4403,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: number;
+
/**
* Specifies the name of this shape.
*
@@ -4330,6 +4432,16 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: number;
+
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+
+
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
export interface CustomPropertyData {
@@ -4389,6 +4501,7 @@ export declare namespace PowerPoint {
+
/**
* Represents a single hyperlink.
*
@@ -4485,6 +4598,7 @@ export declare namespace PowerPoint {
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 whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -4505,6 +4619,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: boolean;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -4532,6 +4647,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: boolean;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -4540,6 +4659,9 @@ export declare namespace PowerPoint {
*/
underline?: boolean;
}
+
+
+
/**
* Represents the collection of shapes.
*
@@ -4558,6 +4680,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -4565,6 +4688,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -4593,6 +4718,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -4621,6 +4747,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
/**
* Represents the layout of a slide.
@@ -4647,6 +4774,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the collection of layouts provided by the Slide Master for slides.
@@ -4673,6 +4801,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the Slide Master of a slide.
@@ -4784,6 +4913,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents a collection of shapes.
@@ -4803,6 +4933,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -4810,6 +4941,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -4838,6 +4971,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -4866,7 +5000,9 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
+
/**
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
*
@@ -5108,6 +5244,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* Returns the line formatting of this shape.
*
@@ -5115,6 +5252,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* Returns the text frame object of this shape.
*
@@ -5143,7 +5282,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
- /**
+
+ /**
* Specifies the name of this shape.
*
* @remarks
@@ -5171,10 +5311,13 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
+
+
/**
* Represents the collection of slides in the presentation.
*
@@ -5207,6 +5350,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents a collection of slides in the presentation.
@@ -5240,6 +5384,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents the collection of Slide Masters in the presentation.
diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_7/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_7/powerpoint.d.ts
index 56ce10e5d3..7ee3509b26 100644
--- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_7/powerpoint.d.ts
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_7/powerpoint.d.ts
@@ -31,6 +31,7 @@ export declare namespace PowerPoint {
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 a collection of custom XML parts that are associated with the presentation.
*
@@ -180,6 +181,7 @@ export declare namespace PowerPoint {
*/
slideMasterId?: string;
}
+
/**
* Represents a custom XML part object.
*
@@ -415,6 +417,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
}
+
/**
* Specifies the type of a shape.
*
@@ -537,6 +540,7 @@ export declare namespace PowerPoint {
*/
textBox = "TextBox",
}
+
/**
* Represents a single hyperlink.
*
@@ -1989,6 +1993,7 @@ export declare namespace PowerPoint {
* [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`.
*
@@ -2144,6 +2149,7 @@ export declare namespace PowerPoint {
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;
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -2164,6 +2170,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -2191,6 +2198,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -2225,6 +2236,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeFontData;
}
+
+
/**
* 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.
@@ -2271,6 +2284,18 @@ export declare namespace PowerPoint {
*/
bottomCentered = "BottomCentered",
}
+
+
+
+
+
+
+
+
+
+
+
+
/**
* Represents the collection of shapes.
*
@@ -2304,6 +2329,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -2326,7 +2352,8 @@ export declare namespace PowerPoint {
* @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
@@ -2399,6 +2426,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
}
+
+
/**
* Represents the layout of a slide.
*
@@ -2436,6 +2465,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -2808,6 +2838,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
readonly id: string;
+
+
/**
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
*
@@ -2815,6 +2847,9 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
delete(): void;
+
+
+
/**
* Selects the specified shapes. Existing shape selection is replaced with the new selection.
*
@@ -2900,6 +2935,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -2924,6 +2960,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
}
+
/**
* Specifies the style for a line.
*
@@ -3375,6 +3412,7 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.TextFrameData;
}
+
/**
* Represents a single shape in the slide.
*
@@ -3398,6 +3436,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly fill: PowerPoint.ShapeFill;
+
/**
* Returns the line formatting of this shape.
*
@@ -3405,6 +3444,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly lineFormat: PowerPoint.ShapeLineFormat;
+
+
/**
* Returns a collection of tags in the shape.
*
@@ -3440,6 +3481,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left: number;
+
/**
* Specifies the name of this shape.
*
@@ -3468,6 +3510,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width: number;
+
/**
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
*
@@ -3517,6 +3560,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3544,6 +3590,8 @@ export declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeData;
}
+
+
/**
* Specifies the document property type for custom properties.
*
@@ -4099,7 +4147,7 @@ export declare namespace PowerPoint {
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}."
+ 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]
@@ -4197,6 +4245,7 @@ export declare namespace PowerPoint {
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
+
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -4217,6 +4266,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -4244,6 +4294,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -4252,6 +4306,14 @@ export declare namespace PowerPoint {
*/
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
}
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
export interface ShapeCollectionUpdateData {
items?: PowerPoint.Interfaces.ShapeData[];
@@ -4459,6 +4521,10 @@ export declare namespace PowerPoint {
*/
width?: number;
}
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
+ }
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
export interface CustomPropertyUpdateData {
/**
@@ -4587,6 +4653,11 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+
+
}
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
export interface HyperlinkData {
@@ -4635,7 +4706,8 @@ export declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
- /**
+
+ /**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
* - `true`: All the text is bold.
@@ -4655,6 +4727,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -4682,6 +4755,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -4689,6 +4766,24 @@ export declare namespace PowerPoint {
* [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" | null;
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+
+
+
+
+
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+
+
+
}
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
export interface ShapeCollectionData {
@@ -4710,6 +4805,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: string;
+
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
export interface SlideLayoutCollectionData {
@@ -4762,10 +4858,15 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: string;
+
}
/** 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+
}
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
export interface ShapeLineFormatData {
@@ -4940,6 +5041,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: number;
+
/**
* Specifies the name of this shape.
*
@@ -4968,6 +5070,16 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: number;
+
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+
+
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
export interface CustomPropertyData {
@@ -5195,6 +5307,7 @@ export declare namespace PowerPoint {
*/
namespaceUri?: boolean;
}
+
/**
* Represents a single hyperlink.
*
@@ -5291,6 +5404,7 @@ export declare namespace PowerPoint {
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 whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -5311,6 +5425,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: boolean;
+
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -5338,6 +5453,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: boolean;
+
+
+
+
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -5346,6 +5465,9 @@ export declare namespace PowerPoint {
*/
underline?: boolean;
}
+
+
+
/**
* Represents the collection of shapes.
*
@@ -5364,6 +5486,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -5371,6 +5494,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -5399,6 +5524,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -5427,6 +5553,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
/**
* Represents the layout of a slide.
@@ -5453,6 +5580,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the collection of layouts provided by the Slide Master for slides.
@@ -5479,6 +5607,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+
}
/**
* Represents the Slide Master of a slide.
@@ -5590,6 +5719,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents a collection of shapes.
@@ -5609,6 +5739,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -5616,6 +5747,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -5644,6 +5777,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -5672,7 +5806,9 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
+
/**
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
*
@@ -5914,6 +6050,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+
/**
* Returns the line formatting of this shape.
*
@@ -5921,6 +6058,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+
+
/**
* Returns the text frame object of this shape.
*
@@ -5949,7 +6088,8 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
- /**
+
+ /**
* Specifies the name of this shape.
*
* @remarks
@@ -5977,7 +6117,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+
}
+
+
/**
* Represents a custom property.
*
@@ -6167,6 +6310,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents a collection of slides in the presentation.
@@ -6200,6 +6344,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+
}
/**
* Represents the collection of Slide Masters in the presentation.
diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/api-extractor.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/api-extractor.json
new file mode 100644
index 0000000000..a41be4aca4
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/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_8/.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_8/package.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/package.json
new file mode 100644
index 0000000000..21d486c0b7
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/package.json
@@ -0,0 +1,4 @@
+{
+ "name": "powerpoint",
+ "version": "1.8.0"
+}
\ No newline at end of file
diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts
new file mode 100644
index 0000000000..a90c171025
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts
@@ -0,0 +1,8776 @@
+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's 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 a collection of bindings that are associated with the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly bindings: PowerPoint.BindingCollection;
+ /**
+ * Returns a collection of custom XML parts that are associated with the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+ /**
+ * Gets the properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly properties: PowerPoint.DocumentProperties;
+ /**
+ * 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's 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 the possible binding types.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum BindingType {
+ /**
+ * Represents a shape binding.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ shape = "Shape",
+ }
+ /**
+ * Represents a custom XML part object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export class CustomXmlPart 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;
+ /**
+ * The ID of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly id: string;
+ /**
+ * The namespace URI of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly namespaceUri: string;
+ /**
+ * Deletes the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ delete(): void;
+ /**
+ * Gets the XML content of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ getXml(): OfficeExtension.ClientResult;
+ /**
+ * Sets the XML content for the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ *
+ * @param xml - XML content for the part.
+ */
+ setXml(xml: 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.CustomXmlPartLoadOptions): PowerPoint.CustomXmlPart;
+ /**
+ * 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.CustomXmlPart;
+ /**
+ * 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.CustomXmlPart;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartData;
+ }
+ /**
+ * A scoped collection of custom XML parts.
+ A scoped collection is the result of some operation (such as filtering by namespace).
+ A scoped collection cannot be scoped any further.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export class CustomXmlPartScopedCollection 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.CustomXmlPart[];
+ /**
+ * Gets the number of custom XML parts in this collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ * @returns The number of custom XML parts in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets a `CustomXmlPart` based on its ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ *
+ * @param id - ID of the object to be retrieved.
+ */
+ getItem(id: string): PowerPoint.CustomXmlPart;
+ /**
+ * Gets a `CustomXmlPart` based on its ID.
+ If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
+ 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.7]
+ *
+ * @param id - ID of the object to be retrieved.
+ */
+ getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;
+ /**
+ * If the collection contains exactly one item, this method returns it.
+ If the collection contains no items or more than one item, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ getOnlyItem(): PowerPoint.CustomXmlPart;
+ /**
+ * If the collection contains exactly one item, this method returns it.
+ Otherwise, this method returns `null`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;
+ /**
+ * 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.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;
+ /**
+ * 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.CustomXmlPartScopedCollection;
+ /**
+ * 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.CustomXmlPartScopedCollection;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;
+ }
+ /**
+ * A collection of custom XML parts.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export class CustomXmlPartCollection 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.CustomXmlPart[];
+ /**
+ * Adds a new `CustomXmlPart` to the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ *
+ * @param xml - XML content. Must be a valid XML fragment. If the XML fragment is invalid, then this method returns the `GeneralException` error.
+ */
+ add(xml: string): PowerPoint.CustomXmlPart;
+ /**
+ * Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ *
+ * @param namespaceUri - This must be a fully qualified schema URI, such as "http://schemas.contoso.com/review/1.0".
+ */
+ getByNamespace(namespaceUri: string): PowerPoint.CustomXmlPartScopedCollection;
+ /**
+ * Gets the number of custom XML parts in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ * @returns The number of custom XML parts in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets a `CustomXmlPart` based on its ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ *
+ * @param id - ID of the object to be retrieved.
+ */
+ getItem(id: string): PowerPoint.CustomXmlPart;
+ /**
+ * Gets a `CustomXmlPart` based on its ID.
+ If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
+ 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.7]
+ *
+ * @param id - ID of the object to be retrieved.
+ */
+ getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;
+ /**
+ * 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.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartCollection;
+ /**
+ * 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.CustomXmlPartCollection;
+ /**
+ * 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.CustomXmlPartCollection;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
+ }
+ /**
+ * Specifies the type of a placeholder.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum PlaceholderType {
+ /**
+ * The placeholder is unsupported.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ unsupported = "Unsupported",
+ /**
+ * The placeholder is for a date.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ date = "Date",
+ /**
+ * The placeholder is for a slide number.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ slideNumber = "SlideNumber",
+ /**
+ * The placeholder is for a footer.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ footer = "Footer",
+ /**
+ * The placeholder is for a header.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ header = "Header",
+ /**
+ * The placeholder is for a title.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ title = "Title",
+ /**
+ * The placeholder is for a body.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ body = "Body",
+ /**
+ * The placeholder is for a center title.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ centerTitle = "CenterTitle",
+ /**
+ * The placeholder is for a subtitle.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subtitle = "Subtitle",
+ /**
+ * The placeholder is for a vertical title.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalTitle = "VerticalTitle",
+ /**
+ * The placeholder is for a vertical body.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalBody = "VerticalBody",
+ /**
+ * The placeholder is for generic content.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ content = "Content",
+ /**
+ * The placeholder is for a chart.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ chart = "Chart",
+ /**
+ * The placeholder is for a table.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ table = "Table",
+ /**
+ * The placeholder is for an online picture.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ onlinePicture = "OnlinePicture",
+ /**
+ * The placeholder is for a SmartArt.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smartArt = "SmartArt",
+ /**
+ * The placeholder is for media.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ media = "Media",
+ /**
+ * The placeholder is for generic vertical content.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalContent = "VerticalContent",
+ /**
+ * The placeholder is for a picture.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ picture = "Picture",
+ /**
+ * The placeholder is for a cameo.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ cameo = "Cameo",
+ }
+ /**
+ * 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",
+ /**
+ * The shape is a callout.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ callout = "Callout",
+ /**
+ * The shape is a chart.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ chart = "Chart",
+ /**
+ * The shape is a content Office Add-in.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ contentApp = "ContentApp",
+ /**
+ * The shape is a diagram.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ diagram = "Diagram",
+ /**
+ * The shape is a freeform object.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ freeform = "Freeform",
+ /**
+ * The shape is a graphic.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ graphic = "Graphic",
+ /**
+ * The shape is an ink object.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ ink = "Ink",
+ /**
+ * The shape is a media object.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ media = "Media",
+ /**
+ * The shape is a 3D model.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ model3D = "Model3D",
+ /**
+ * The shape is an OLE (Object Linking and Embedding) object.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ ole = "Ole",
+ /**
+ * The shape is a placeholder.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ placeholder = "Placeholder",
+ /**
+ * The shape is a SmartArt graphic.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ smartArt = "SmartArt",
+ /**
+ * The shape is a text box.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ textBox = "TextBox",
+ }
+ /**
+ * Represents the properties of a `placeholder` shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export class PlaceholderFormat 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 type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
+ Returns `null` if the placeholder is empty.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
+ /**
+ * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
+ /**
+ * 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.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat;
+ /**
+ * 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.PlaceholderFormat;
+ /**
+ * 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.PlaceholderFormat;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;
+ }
+ /**
+ * 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's 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's 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;
+ }
+ /**
+ * 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 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 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 an image. This changes the fill type to `PictureAndTexture`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param base64EncodedImage - A string that is a Base64 encoding of the image data.
+ */
+ setImage(base64EncodedImage: string): 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's 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;
+ }
+ /**
+ * 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 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;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+ *
+ * - `true`: All the text is bold.
+ *
+ * - `false`: None of the text is bold.
+ *
+ * - `null`: Returned if some, but not all, of the text is bold.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bold: boolean | null;
+ /**
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ color: string | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+ *
+ * - `true`: All the text is italicized.
+ *
+ * - `false`: None of the text is italicized.
+ *
+ * - `null`: Returned if some, but not all, of the text is italicized.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ italic: boolean | null;
+ /**
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ name: string | null;
+ /**
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ size: number | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript: boolean | null;
+ /**
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains 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" | null;
+ /**
+ * 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's 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;
+ }
+ /**
+ * Represents the font attributes, such as font name, size, and color.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface FontProperties {
+ /**
+ * Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean | undefined;
+ /**
+ * Represents the bold status of font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bold?: boolean | undefined;
+ /**
+ * Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ color?: string | undefined;
+ /**
+ * Represents the double-strikethrough status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean | undefined;
+ /**
+ * Represents the italic status of font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ italic?: boolean | undefined;
+ /**
+ * Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ name?: string | undefined;
+ /**
+ * Represents the font size in points (e.g., 11).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ size?: number | undefined;
+ /**
+ * Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean | undefined;
+ /**
+ * Represents the strikethrough status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean | undefined;
+ /**
+ * Represents the subscript status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean | undefined;
+ /**
+ * Represents the superscript status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean | undefined;
+ /**
+ * Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;
+ }
+ /**
+ * Represents a sequence of one or more characters with the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TextRun {
+ /**
+ * The font attributes (such as font name, font size, and color) applied to this text run.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ font?: PowerPoint.FontProperties;
+ /**
+ * The text of this text run.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text: string;
+ }
+ /**
+ * 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 a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export class TableCell 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 number of table columns this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly columnCount: number;
+ /**
+ * Gets the zero-based column index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly columnIndex: number;
+ /**
+ * Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly rowCount: number;
+ /**
+ * Gets the zero-based row index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly rowIndex: number;
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text: 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.TableCellLoadOptions): PowerPoint.TableCell;
+ /**
+ * 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.TableCell;
+ /**
+ * 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.TableCell;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableCellData;
+ }
+ /**
+ * Represents a collection of table cells.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export class TableCellCollection 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.TableCell[];
+ /**
+ * Gets the number of table cells in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ * @returns The number of table cells in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](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.8]
+ *
+ * @param row - Row index value of the table cell to be retrieved, as a zero-based index.
+ * @param column - Column index value of the table cell to be retrieved, as a zero-based index.
+ * @returns The `TableCell` object.
+ */
+ getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell;
+ /**
+ * 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.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection;
+ /**
+ * 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.TableCellCollection;
+ /**
+ * 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.TableCellCollection;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.TableCellCollectionData;
+ }
+ /**
+ * Represents the fill formatting of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface FillProperties {
+ /**
+ * Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ color?: string | undefined;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ transparency?: number | undefined;
+ }
+ /**
+ * Represents the properties for a table cell border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface BorderProperties {
+ /**
+ * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ color?: string | undefined;
+ /**
+ * Represents the dash style of the line.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
+ /**
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ transparency?: number | undefined;
+ /**
+ * Represents the weight of the line, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ weight?: number | undefined;
+ }
+ /**
+ * Represents the borders of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableCellBorders {
+ /**
+ * Represents the bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bottom?: PowerPoint.BorderProperties;
+ /**
+ * Represents the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ diagonalDown?: PowerPoint.BorderProperties;
+ /**
+ * Represents the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ diagonalUp?: PowerPoint.BorderProperties;
+ /**
+ * Represents the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ left?: PowerPoint.BorderProperties;
+ /**
+ * Represents the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ right?: PowerPoint.BorderProperties;
+ /**
+ * Represents the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ top?: PowerPoint.BorderProperties;
+ }
+ /**
+ * Represents the margins of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableCellMargins {
+ /**
+ * Specifies the bottom margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bottom?: number | undefined;
+ /**
+ * Specifies the left margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ left?: number | undefined;
+ /**
+ * Specifies the right margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ right?: number | undefined;
+ /**
+ * Specifies the top margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ top?: number | undefined;
+ }
+ /**
+ * Represents the table cell properties to update.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableCellProperties {
+ /**
+ * Specifies the border formatting of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ borders?: PowerPoint.TableCellBorders;
+ /**
+ * Specifies the fill formatting of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ fill?: PowerPoint.FillProperties;
+ /**
+ * Specifies the font formatting of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ font?: PowerPoint.FontProperties;
+ /**
+ * Represents the horizontal alignment of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
+ /**
+ * Represents the indent level of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ indentLevel?: number | undefined;
+ /**
+ * Specifies the margin settings in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ margins?: PowerPoint.TableCellMargins;
+ /**
+ * Specifies the text content of the table cell.
+
+ If a portion of the text requires different formatting, use the `textRuns` property instead.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: string;
+ /**
+ * Specifies the contents of the table cell as an array of {@link TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textRuns?: PowerPoint.TextRun[];
+ /**
+ * Represents the vertical alignment of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
+ }
+ /**
+ * Represents a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export class Table 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 number of columns in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly columnCount: number;
+ /**
+ * Gets the number of rows in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly rowCount: number;
+ /**
+ * Gets all of the values in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly values: string[][];
+ /**
+ * Gets the cell at the specified `rowIndex` and `columnIndex`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param rowIndex - The zero-based row index of the cell.
+ * @param columnIndex - The zero-based column index of the cell.
+ * @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned.
+ */
+ getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
+ /**
+ * Gets a collection of cells that represent the merged areas of the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ * @returns a `TableCellCollection` with cells that represent the merged areas of the table.
+ */
+ getMergedAreas(): PowerPoint.TableCellCollection;
+ /**
+ * Gets the shape object for the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ getShape(): 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.TableLoadOptions): PowerPoint.Table;
+ /**
+ * 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.Table;
+ /**
+ * 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.Table;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableData;
+ }
+ /**
+ * Provides the table column properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableColumnProperties {
+ /**
+ * Represents the desired width of each column in points, or is undefined.
+
+ When a table is being added, for columns whose width is undefined,
+ the column width will be calculated by evenly dividing the remaining width
+ of the table amongst those columns. If the table does not have a defined width,
+ a default column width will be used.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnWidth?: number | undefined;
+ }
+ /**
+ * Represents the properties of a merged area of cells in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableMergedAreaProperties {
+ /**
+ * Specifies the number of columns for the merged cells area.
+ Must be 1 or greater.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount: number;
+ /**
+ * Specifies the zero-based index of the column of the top left cell of the merged area.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnIndex: number;
+ /**
+ * Specifies the number of rows for the merged cells area.
+ Must be 1 or greater.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount: number;
+ /**
+ * Specifies the zero-based index of the row of the top left cell of the merged area.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowIndex: number;
+ }
+ /**
+ * Provides the table row properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableRowProperties {
+ /**
+ * Represents the desired height of each row in points, or is undefined.
+
+ When a table is being added, for rows whose height is undefined,
+ the row height will be calculated by evenly dividing the remaining height
+ of the table amongst those rows. If the table does not have a defined height,
+ a default row height will be used.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowHeight?: number | undefined;
+ }
+ /**
+ * Represents the available options when adding a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableAddOptions {
+ /**
+ * If provided, specifies properties for each column in the table.
+ The array length must be equal to the number of columns in the table.
+ Specify an empty object for columns that should use the default formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columns?: PowerPoint.TableColumnProperties[];
+ /**
+ * Specifies the height, in points, of the table.
+ A default value is used when this parameter is not provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ height?: number | undefined;
+ /**
+ * Specifies the distance, in points, from the left side of the table to the left side of the slide.
+ The table is centered horizontally when this parameter is not provided.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ left?: number | undefined;
+ /**
+ * If specified, represents an rectangular area where multiple cells appear as a single cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ mergedAreas?: PowerPoint.TableMergedAreaProperties[];
+ /**
+ * If provided, specifies properties for each row in the table.
+ The array length must be equal to the number of rows in the table.
+ Specify an empty object for rows that should use the default formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rows?: PowerPoint.TableRowProperties[];
+ /**
+ * If provided, specifies properties for each cell in the table.
+
+ This should be an 2D array with the same number of rows and columns as the table.
+ If a cell does not require specific formatting, specify an empty object for that cell.
+ Only the top left cell of a merged are can have properties specified, which will be applied
+ to the entire merged area. For the other cells in the merged area, an empty object should be provided.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ specificCellProperties?: PowerPoint.TableCellProperties[][];
+ /**
+ * Specifies the distance, in points, from the top edge of the table to the top edge of the slide.
+ A default value is used when this parameter is not provided.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ top?: number | undefined;
+ /**
+ * Specifies the formatting which applies uniformly to all of the table cells.
+
+ To apply specific formatting to individual cells, use specificCellProperties.
+
+ If both uniformCellProperties and specificCellProperties are undefined, the default formatting
+ will be used, and the default table style will be applied. The table will have the same
+ appearance as when the user adds a table through the PowerPoint UI.
+
+ To provide a plain appearance for the table, set this property to an empty object
+ and do not specify specificCellProperties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ uniformCellProperties?: PowerPoint.TableCellProperties;
+ /**
+ * If provided, specifies the values for the table.
+
+ When the table contains areas of merged cells,
+ only the top left cell of each merged area can have a
+ non-empty string value. The other cells
+ in the merged area must be an empty string.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ values?: string[][];
+ /**
+ * Specifies the width, in points, of the table.
+ A default value is used when this parameter is not provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ width?: number | undefined;
+ }
+ /**
+ * 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;
+ /**
+ * Create a shape group for several shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param values - An array of shape IDs or `Shape` objects.
+ * @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group.
+ */
+ addGroup(values: Array): 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 table to the slide. Returns a `Shape` object that represents the new table.
+ Use the `Shape.table` property to get the `Table` object for the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param rowCount - Number of rows in the table. Must be 1 or greater.
+ * @param columnCount - Number of columns in the table. Must be 1 or greater.
+ * @param options - Provides options describing the new table.
+ * @returns The newly inserted shape.
+ */
+ addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): 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's 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 available options when getting an image of a slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface SlideGetImageOptions {
+ /**
+ * The desired height of the resulting image in pixels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ height?: number;
+ /**
+ * The desired width of the resulting image in pixels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ width?: number;
+ }
+ /**
+ * Specifies the type of a slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum SlideLayoutType {
+ /**
+ * Blank layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ blank = "Blank",
+ /**
+ * Chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ chart = "Chart",
+ /**
+ * Chart and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ chartAndText = "ChartAndText",
+ /**
+ * ClipArt and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ clipArtAndText = "ClipArtAndText",
+ /**
+ * ClipArt and vertical text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ clipArtAndVerticalText = "ClipArtAndVerticalText",
+ /**
+ * Comparison layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ comparison = "Comparison",
+ /**
+ * Content with caption layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ contentWithCaption = "ContentWithCaption",
+ /**
+ * Custom layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ custom = "Custom",
+ /**
+ * Four objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ fourObjects = "FourObjects",
+ /**
+ * Large object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ largeObject = "LargeObject",
+ /**
+ * MediaClip and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ mediaClipAndText = "MediaClipAndText",
+ /**
+ * Mixed layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ mixed = "Mixed",
+ /**
+ * Object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ object = "Object",
+ /**
+ * Object and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ objectAndText = "ObjectAndText",
+ /**
+ * Object and two objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ objectAndTwoObjects = "ObjectAndTwoObjects",
+ /**
+ * Object over text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ objectOverText = "ObjectOverText",
+ /**
+ * Organization chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ organizationChart = "OrganizationChart",
+ /**
+ * Picture with caption layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ pictureWithCaption = "PictureWithCaption",
+ /**
+ * Section header layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ sectionHeader = "SectionHeader",
+ /**
+ * Table layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ table = "Table",
+ /**
+ * Text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text = "Text",
+ /**
+ * Text and chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndChart = "TextAndChart",
+ /**
+ * Text and ClipArt layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndClipArt = "TextAndClipArt",
+ /**
+ * Text and MediaClip layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndMediaClip = "TextAndMediaClip",
+ /**
+ * Text and object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndObject = "TextAndObject",
+ /**
+ * Text and two objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndTwoObjects = "TextAndTwoObjects",
+ /**
+ * Text over object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textOverObject = "TextOverObject",
+ /**
+ * Title layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ title = "Title",
+ /**
+ * Title only layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ titleOnly = "TitleOnly",
+ /**
+ * Two-column text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoColumnText = "TwoColumnText",
+ /**
+ * Two objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjects = "TwoObjects",
+ /**
+ * Two objects and object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjectsAndObject = "TwoObjectsAndObject",
+ /**
+ * Two objects and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjectsAndText = "TwoObjectsAndText",
+ /**
+ * Two objects over text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjectsOverText = "TwoObjectsOverText",
+ /**
+ * Vertical text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalText = "VerticalText",
+ /**
+ * Vertical title and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalTitleAndText = "VerticalTitleAndText",
+ /**
+ * Vertical title and text over chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
+ }
+ /**
+ * 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 custom XML parts in the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+ /**
+ * 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;
+ /**
+ * Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
+ /**
+ * 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's 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's 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;
+ /**
+ * Returns a collection of custom XML parts in the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+ /**
+ * 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's 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's 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's 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 custom XML parts in the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+ /**
+ * 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;
+ /**
+ * Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly index: number;
+ /**
+ * Applies the specified layout to the slide, changing its design and structure according to the chosen layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param slideLayout - The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master.
+ */
+ applyLayout(slideLayout: PowerPoint.SlideLayout): void;
+ /**
+ * Deletes the slide from the presentation. Does nothing if the slide does not exist.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.2]
+ */
+ delete(): void;
+ /**
+ * Exports the slide to its own presentation file, returned as Base64-encoded data.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ exportAsBase64(): OfficeExtension.ClientResult;
+ /**
+ * Renders an image of the slide. The image is scaled to fit into the desired dimensions.
+ If width and height aren't specified, the true size of the slide is used. If only one
+ of either width or height is specified, the other will be calculated to preserve aspect ratio.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param options - Optional. Options to specify the desired size of the slide image.
+ * @returns A Base64 string of the slide image in PNG format.
+ */
+ getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult;
+ /**
+ * Moves the slide to a new position within the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param slideIndex - The zero-based index where the slide should be moved.
+ */
+ moveTo(slideIndex: number): 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's 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;
+ }
+ /**
+ * 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;
+ /**
+ * Groups all shapes in this collection into a single shape.
+ If the collection contains fewer than two shapes, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ * @returns The newly created grouped shape as a {@link PowerPoint.Shape}.
+ */
+ group(): 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's 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 a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export class ShapeGroup 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 `Shape` object associated with the group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly shape: PowerPoint.Shape;
+ /**
+ * Returns the collection of `Shape` objects in the group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly shapes: PowerPoint.ShapeScopedCollection;
+ /**
+ * Gets the unique ID of the shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly id: string;
+ /**
+ * Ungroups any grouped shapes in the specified shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ ungroup(): 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.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;
+ /**
+ * 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.ShapeGroup;
+ /**
+ * 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.ShapeGroup;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.ShapeGroupData;
+ }
+ /**
+ * 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's 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;
+ }
+ /**
+ * 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's 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's 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;
+ }
+ /**
+ * 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's 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's 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;
+ }
+ /**
+ * Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum ShapeZOrder {
+ /**
+ * Brings the shape forward one spot in the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bringForward = "BringForward",
+ /**
+ * Brings the shape to the front of the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bringToFront = "BringToFront",
+ /**
+ * Sends the shape backward one spot in the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ sendBackward = "SendBackward",
+ /**
+ * Sends the shape to the back of the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ sendToBack = "SendToBack",
+ }
+ /**
+ * 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 a collection of custom XML parts in the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+ /**
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ readonly fill: PowerPoint.ShapeFill;
+ /**
+ * Returns the `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly group: PowerPoint.ShapeGroup;
+ /**
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ readonly lineFormat: PowerPoint.ShapeLineFormat;
+ /**
+ * Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly parentGroup: PowerPoint.Shape;
+ /**
+ * Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly placeholderFormat: PowerPoint.PlaceholderFormat;
+ /**
+ * 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;
+ /**
+ * Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly level: 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" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
+ /**
+ * 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;
+ /**
+ * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly zOrderPosition: 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;
+ /**
+ * Returns the `Table` object if this shape is a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ getTable(): PowerPoint.Table;
+ /**
+ * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param position - Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
+ */
+ setZOrder(position: PowerPoint.ShapeZOrder): void;
+ /**
+ * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param positionString - Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
+ */
+ setZOrder(positionString: "BringForward" | "BringToFront" | "SendBackward" | "SendToBack"): 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.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's 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;
+ }
+ /**
+ * Represents an Office.js binding that is defined in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export class Binding 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 binding identifier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly id: string;
+ /**
+ * Returns the type of the binding. See `BindingType` for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly type: PowerPoint.BindingType | "Shape";
+ /**
+ * Deletes the binding.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ delete(): void;
+ /**
+ * Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ getShape(): 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.BindingLoadOptions): PowerPoint.Binding;
+ /**
+ * 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.Binding;
+ /**
+ * 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.Binding;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.BindingData;
+ }
+ /**
+ * Represents the collection of all the binding objects that are part of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export class BindingCollection 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.Binding[];
+ /**
+ * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param shape - Shape to which the binding is added.
+ * @param bindingType - Type of binding. See `BindingType`.
+ * @param id - ID of the binding.
+ */
+ add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
+ /**
+ * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param shape - Shape to which the binding is added.
+ * @param bindingTypeString - Type of binding. See `BindingType`.
+ * @param id - ID of the binding.
+ */
+ add(shape: PowerPoint.Shape, bindingTypeString: "Shape", id: string): PowerPoint.Binding;
+ /**
+ * Adds a new binding based on the current selection.
+ If the selection has multiple areas, the `InvalidReference` error will be returned.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param bindingType - Type of binding. See `BindingType`.
+ * @param id - ID of the binding.
+ */
+ addFromSelection(bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
+ /**
+ * Adds a new binding based on the current selection.
+ If the selection has multiple areas, the `InvalidReference` error will be returned.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param bindingTypeString - Type of binding. See `BindingType`.
+ * @param id - ID of the binding.
+ */
+ addFromSelection(bindingTypeString: "Shape", id: string): PowerPoint.Binding;
+ /**
+ * Gets the number of bindings in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param key - ID of the binding object to be retrieved.
+ */
+ getItem(key: string): PowerPoint.Binding;
+ /**
+ * Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param index - Index value of the object to be retrieved. Zero-indexed.
+ */
+ getItemAt(index: number): PowerPoint.Binding;
+ /**
+ * Gets a binding object by ID. If the binding object doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
+ 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.8]
+ *
+ * @param id - ID of the binding object to be retrieved.
+ */
+ getItemOrNullObject(id: string): PowerPoint.Binding;
+ /**
+ * 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.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.BindingCollection;
+ /**
+ * 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.BindingCollection;
+ /**
+ * 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.BindingCollection;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.BindingCollectionData;
+ }
+ /**
+ * Specifies the document property type for custom properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ enum DocumentPropertyType {
+ /**
+ * The Boolean document property type.
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ boolean = "Boolean",
+ /**
+ * The Date document property type.
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ date = "Date",
+ /**
+ * The Number document property type.
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ number = "Number",
+ /**
+ * The String document property type.
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ string = "String",
+ }
+ /**
+ * Represents a custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export class CustomProperty 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;
+ /**
+ * The string that uniquely identifies the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly key: string;
+ /**
+ * The type of the value used for the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";
+ /**
+ * The value of the custom property.
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ value: boolean | Date | number | string;
+ /**
+ * Deletes the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ delete(): 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.CustomPropertyLoadOptions): PowerPoint.CustomProperty;
+ /**
+ * 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.CustomProperty;
+ /**
+ * 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.CustomProperty;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.CustomPropertyData;
+ }
+ /**
+ * A collection of custom properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export class CustomPropertyCollection 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.CustomProperty[];
+ /**
+ * Creates a new `CustomProperty` or updates the property with the given key.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ *
+ * @param key - The string that identifies the `CustomProperty` object. It's case-insensitive.
+ * The maximum key length is 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
+ * @param value - The value of the `CustomProperty`.
+ * If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
+ */
+ add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;
+ /**
+ * Deletes all custom properties in this collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ deleteAll(): void;
+ /**
+ * Gets the number of custom properties in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ * @returns The number of custom properties in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets a `CustomProperty` by its key.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ *
+ * @param key - The string that identifies the `CustomProperty` object. It's case-insensitive.
+ * Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the `InvalidArgument` error.
+ */
+ getItem(key: string): PowerPoint.CustomProperty;
+ /**
+ * Gets a `CustomProperty` by its key.
+ If the `CustomProperty` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
+ 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.7]
+ *
+ * @param key - The string that identifies the `CustomProperty` object. It's case-insensitive.
+ * Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the `InvalidArgument` error.
+ */
+ getItemOrNullObject(key: string): PowerPoint.CustomProperty;
+ /**
+ * 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.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;
+ /**
+ * 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.CustomPropertyCollection;
+ /**
+ * 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.CustomPropertyCollection;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;
+ }
+ /**
+ * Represents presentation properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export class DocumentProperties 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;
+ /**
+ * The collection of custom properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly customProperties: PowerPoint.CustomPropertyCollection;
+ /**
+ * The author of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ author: string;
+ /**
+ * The category of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ category: string;
+ /**
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ comments: string;
+ /**
+ * The company of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ company: string;
+ /**
+ * The creation date of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly creationDate: Date;
+ /**
+ * The keywords of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ keywords: string;
+ /**
+ * The last author of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ readonly lastAuthor: string;
+ /**
+ * The manager of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ manager: string;
+ /**
+ * The revision number of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ revisionNumber: number;
+ /**
+ * The subject of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ subject: string;
+ /**
+ * The title of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ title: 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.DocumentPropertiesLoadOptions): PowerPoint.DocumentProperties;
+ /**
+ * 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.DocumentProperties;
+ /**
+ * 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.DocumentProperties;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.DocumentPropertiesData;
+ }
+ /**
+ * 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 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's 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's 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's 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 `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */
+ export interface CustomXmlPartScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */
+ export interface CustomXmlPartCollectionUpdateData {
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** 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 `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 `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
+ export interface ShapeFontUpdateData {
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps**attribute.
+ *
+ * - `null`: Some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+ *
+ * - `true`: All the text is bold.
+ *
+ * - `false`: None of the text is bold.
+ *
+ * - `null`: Returned if some, but not all, of the text is bold.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bold?: boolean | null;
+ /**
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ color?: string | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+ *
+ * - `true`: All the text is italicized.
+ *
+ * - `false`: None of the text is italicized.
+ *
+ * - `null`: Returned if some, but not all, of the text is italicized.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ italic?: boolean | null;
+ /**
+ * Specifies the 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. Returns `null` if the `TextRange` contains text fragments with different font names.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ name?: string | null;
+ /**
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ size?: number | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean | null;
+ /**
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains 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" | null;
+ }
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: string;
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ export interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** 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 `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
+ export interface ShapeScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.ShapeData[];
+ }
+ /** 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 `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 `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ export interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
+ }
+ /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
+ export interface CustomPropertyUpdateData {
+ /**
+ * The value of the custom property.
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ value?: boolean | Date | number | string;
+ }
+ /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */
+ export interface CustomPropertyCollectionUpdateData {
+ items?: PowerPoint.Interfaces.CustomPropertyData[];
+ }
+ /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */
+ export interface DocumentPropertiesUpdateData {
+ /**
+ * The author of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ author?: string;
+ /**
+ * The category of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ category?: string;
+ /**
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ comments?: string;
+ /**
+ * The company of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ company?: string;
+ /**
+ * The keywords of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ keywords?: string;
+ /**
+ * The manager of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ manager?: string;
+ /**
+ * The revision number of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ revisionNumber?: number;
+ /**
+ * The subject of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ subject?: string;
+ /**
+ * The title of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ title?: string;
+ }
+ /** 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 `customXmlPart.toJSON()`. */
+ export interface CustomXmlPartData {
+ /**
+ * The ID of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ id?: string;
+ /**
+ * The namespace URI of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ namespaceUri?: string;
+ }
+ /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */
+ export interface CustomXmlPartScopedCollectionData {
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */
+ export interface CustomXmlPartCollectionData {
+ items?: PowerPoint.Interfaces.CustomXmlPartData[];
+ }
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ export interface PlaceholderFormatData {
+ /**
+ * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
+ Returns `null` if the placeholder is empty.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
+ /**
+ * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
+ }
+ /** 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 `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 `shapeFont.toJSON()`. */
+ export interface ShapeFontData {
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps**attribute.
+ *
+ * - `null`: Some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+ *
+ * - `true`: All the text is bold.
+ *
+ * - `false`: None of the text is bold.
+ *
+ * - `null`: Returned if some, but not all, of the text is bold.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bold?: boolean | null;
+ /**
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ color?: string | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+ *
+ * - `true`: All the text is italicized.
+ *
+ * - `false`: None of the text is italicized.
+ *
+ * - `null`: Returned if some, but not all, of the text is italicized.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ italic?: boolean | null;
+ /**
+ * Specifies the 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. Returns `null` if the `TextRange` contains text fragments with different font names.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ name?: string | null;
+ /**
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ size?: number | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean | null;
+ /**
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains 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" | null;
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ export interface TableCellData {
+ /**
+ * Gets the number of table columns this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount?: number;
+ /**
+ * Gets the zero-based column index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnIndex?: number;
+ /**
+ * Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount?: number;
+ /**
+ * Gets the zero-based row index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowIndex?: number;
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: string;
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ export interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ export interface TableData {
+ /**
+ * Gets the number of columns in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount?: number;
+ /**
+ * Gets the number of rows in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount?: number;
+ /**
+ * Gets all of the values in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ values?: string[][];
+ }
+ /** 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;
+ /**
+ * Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
+ }
+ /** 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;
+ /**
+ * Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: 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 `shapeGroup.toJSON()`. */
+ export interface ShapeGroupData {
+ /**
+ * Gets the unique ID of the shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: string;
+ }
+ /** 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 `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;
+ /**
+ * Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: 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" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
+ /**
+ * 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;
+ /**
+ * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: number;
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ export interface BindingData {
+ /**
+ * Represents the binding identifier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: string;
+ /**
+ * Returns the type of the binding. See `BindingType` for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: PowerPoint.BindingType | "Shape";
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ export interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
+ }
+ /** An interface describing the data returned by calling `customProperty.toJSON()`. */
+ export interface CustomPropertyData {
+ /**
+ * The string that uniquely identifies the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ key?: string;
+ /**
+ * The type of the value used for the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ type?: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";
+ /**
+ * The value of the custom property.
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ value?: boolean | Date | number | string;
+ }
+ /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */
+ export interface CustomPropertyCollectionData {
+ items?: PowerPoint.Interfaces.CustomPropertyData[];
+ }
+ /** An interface describing the data returned by calling `documentProperties.toJSON()`. */
+ export interface DocumentPropertiesData {
+ /**
+ * The author of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ author?: string;
+ /**
+ * The category of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ category?: string;
+ /**
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ comments?: string;
+ /**
+ * The company of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ company?: string;
+ /**
+ * The creation date of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ creationDate?: Date;
+ /**
+ * The keywords of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ keywords?: string;
+ /**
+ * The last author of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ lastAuthor?: string;
+ /**
+ * The manager of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ manager?: string;
+ /**
+ * The revision number of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ revisionNumber?: number;
+ /**
+ * The subject of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ subject?: string;
+ /**
+ * The title of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ title?: string;
+ }
+ /** 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 properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
+ /**
+ * Gets the ID of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
+ id?: boolean;
+ title?: boolean;
+ }
+ /**
+ * Represents a custom XML part object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export interface CustomXmlPartLoadOptions {
+ /**
+ 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;
+ /**
+ * The ID of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ id?: boolean;
+ /**
+ * The namespace URI of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ namespaceUri?: boolean;
+ }
+ /**
+ * A scoped collection of custom XML parts.
+ A scoped collection is the result of some operation (such as filtering by namespace).
+ A scoped collection cannot be scoped any further.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export interface CustomXmlPartScopedCollectionLoadOptions {
+ /**
+ 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: The ID of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ id?: boolean;
+ /**
+ * For EACH ITEM in the collection: The namespace URI of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ namespaceUri?: boolean;
+ }
+ /**
+ * A collection of custom XML parts.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export interface CustomXmlPartCollectionLoadOptions {
+ /**
+ 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: The ID of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ id?: boolean;
+ /**
+ * For EACH ITEM in the collection: The namespace URI of the custom XML part.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ namespaceUri?: boolean;
+ }
+ /**
+ * Represents the properties of a `placeholder` shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface PlaceholderFormatLoadOptions {
+ /**
+ 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 type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
+ Returns `null` if the placeholder is empty.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ containedType?: boolean;
+ /**
+ * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: 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 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 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;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps**attribute.
+ *
+ * - `null`: Some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+ *
+ * - `true`: All the text is bold.
+ *
+ * - `false`: None of the text is bold.
+ *
+ * - `null`: Returned if some, but not all, of the text is bold.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bold?: boolean;
+ /**
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ color?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+ *
+ * - `true`: All the text is italicized.
+ *
+ * - `false`: None of the text is italicized.
+ *
+ * - `null`: Returned if some, but not all, of the text is italicized.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ italic?: boolean;
+ /**
+ * Specifies the 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. Returns `null` if the `TextRange` contains text fragments with different font names.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ name?: boolean;
+ /**
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ size?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean;
+ /**
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ underline?: boolean;
+ }
+ /**
+ * Represents a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableCellLoadOptions {
+ /**
+ 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 number of table columns this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount?: boolean;
+ /**
+ * Gets the zero-based column index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnIndex?: boolean;
+ /**
+ * Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount?: boolean;
+ /**
+ * Gets the zero-based row index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowIndex?: boolean;
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: boolean;
+ }
+ /**
+ * Represents a collection of table cells.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableCellCollectionLoadOptions {
+ /**
+ 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 number of table columns this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnIndex?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowIndex?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: boolean;
+ }
+ /**
+ * Represents a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface TableLoadOptions {
+ /**
+ 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 number of columns in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount?: boolean;
+ /**
+ * Gets the number of rows in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount?: boolean;
+ /**
+ * Gets all of the values in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ values?: 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 `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
+ /**
+ * 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 parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
+ /**
+ * 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: Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: 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;
+ /**
+ * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: 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;
+ /**
+ * Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: 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;
+ /**
+ * For EACH ITEM in the collection: Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: 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;
+ /**
+ * Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: 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 `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
+ /**
+ * 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 parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
+ /**
+ * 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: Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: 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;
+ /**
+ * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: boolean;
+ }
+ /**
+ * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface ShapeGroupLoadOptions {
+ /**
+ 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 `Shape` object associated with the group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ shape?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * Gets the unique ID of the shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: 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;
+ }
+ /**
+ * 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 `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
+ /**
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+ /**
+ * Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
+ /**
+ * 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;
+ /**
+ * Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: 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;
+ /**
+ * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: boolean;
+ }
+ /**
+ * Represents an Office.js binding that is defined in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface BindingLoadOptions {
+ /**
+ 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 binding identifier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: boolean;
+ /**
+ * Returns the type of the binding. See `BindingType` for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents the collection of all the binding objects that are part of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ export interface BindingCollectionLoadOptions {
+ /**
+ 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: Represents the binding identifier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents a custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export interface CustomPropertyLoadOptions {
+ /**
+ 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;
+ /**
+ * The string that uniquely identifies the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ key?: boolean;
+ /**
+ * The type of the value used for the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ type?: boolean;
+ /**
+ * The value of the custom property.
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ value?: boolean;
+ }
+ /**
+ * A collection of custom properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export interface CustomPropertyCollectionLoadOptions {
+ /**
+ 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: The string that uniquely identifies the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ key?: boolean;
+ /**
+ * For EACH ITEM in the collection: The type of the value used for the custom property.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ type?: boolean;
+ /**
+ * For EACH ITEM in the collection: The value of the custom property.
+ If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an `InvalidArgument` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ value?: boolean;
+ }
+ /**
+ * Represents presentation properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ export interface DocumentPropertiesLoadOptions {
+ /**
+ 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;
+ /**
+ * The author of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ author?: boolean;
+ /**
+ * The category of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ category?: boolean;
+ /**
+ * The Comments field in the metadata of the presentation. These have no connection to comments made in slides.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ comments?: boolean;
+ /**
+ * The company of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ company?: boolean;
+ /**
+ * The creation date of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ creationDate?: boolean;
+ /**
+ * The keywords of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ keywords?: boolean;
+ /**
+ * The last author of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ lastAuthor?: boolean;
+ /**
+ * The manager of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ manager?: boolean;
+ /**
+ * The revision number of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ revisionNumber?: boolean;
+ /**
+ * The subject of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ subject?: boolean;
+ /**
+ * The title of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
+ title?: 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;
+ /**
+ * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: 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;
+ /**
+ * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: 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_8/tsconfig.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/tsconfig.json
new file mode 100644
index 0000000000..c8d2a749f7
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/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_8/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/tsdoc-metadata.json
new file mode 100644
index 0000000000..901e33ada3
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/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.52.1"
+ }
+ ]
+}
diff --git a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts
index d16a1e9a28..47a46c6c2b 100644
--- a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts
+++ b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts
@@ -35,8 +35,7 @@ export declare namespace PowerPoint {
* Returns a collection of bindings that are associated with the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly bindings: PowerPoint.BindingCollection;
/**
@@ -192,15 +191,13 @@ export declare namespace PowerPoint {
* Represents the possible binding types.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum BindingType {
/**
* Represents a shape binding.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
shape = "Shape",
}
@@ -443,148 +440,127 @@ export declare namespace PowerPoint {
* Specifies the type of a placeholder.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum PlaceholderType {
/**
* The placeholder is unsupported.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
unsupported = "Unsupported",
/**
* The placeholder is for a date.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
date = "Date",
/**
* The placeholder is for a slide number.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
slideNumber = "SlideNumber",
/**
* The placeholder is for a footer.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
footer = "Footer",
/**
* The placeholder is for a header.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
header = "Header",
/**
* The placeholder is for a title.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
title = "Title",
/**
* The placeholder is for a body.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
body = "Body",
/**
* The placeholder is for a center title.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
centerTitle = "CenterTitle",
/**
* The placeholder is for a subtitle.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subtitle = "Subtitle",
/**
* The placeholder is for a vertical title.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalTitle = "VerticalTitle",
/**
* The placeholder is for a vertical body.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalBody = "VerticalBody",
/**
* The placeholder is for generic content.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
content = "Content",
/**
* The placeholder is for a chart.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
chart = "Chart",
/**
* The placeholder is for a table.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
table = "Table",
/**
* The placeholder is for an online picture.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
onlinePicture = "OnlinePicture",
/**
* The placeholder is for a SmartArt.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smartArt = "SmartArt",
/**
* The placeholder is for media.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
media = "Media",
/**
* The placeholder is for generic vertical content.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalContent = "VerticalContent",
/**
* The placeholder is for a picture.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
picture = "Picture",
/**
* The placeholder is for a cameo.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
cameo = "Cameo",
}
@@ -714,8 +690,7 @@ export declare namespace PowerPoint {
* Represents the properties of a `placeholder` shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export class PlaceholderFormat extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -725,16 +700,14 @@ export declare namespace PowerPoint {
Returns `null` if the placeholder is empty.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
/**
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
/**
@@ -2220,8 +2193,7 @@ export declare namespace PowerPoint {
* Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param base64EncodedImage - A string that is a Base64 encoding of the image data.
*/
@@ -2391,8 +2363,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps: boolean | null;
/**
@@ -2425,8 +2396,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough: boolean | null;
/**
@@ -2466,8 +2436,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps: boolean | null;
/**
@@ -2480,8 +2449,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough: boolean | null;
/**
@@ -2494,8 +2462,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript: boolean | null;
/**
@@ -2508,8 +2475,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript: boolean | null;
/**
@@ -2550,104 +2516,91 @@ export declare namespace PowerPoint {
* Represents the font attributes, such as font name, size, and color.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface FontProperties {
/**
* Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean | undefined;
/**
* Represents the bold status of font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bold?: boolean | undefined;
/**
* Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
color?: string | undefined;
/**
* Represents the double-strikethrough status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean | undefined;
/**
* Represents the italic status of font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
italic?: boolean | undefined;
/**
* Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
name?: string | undefined;
/**
* Represents the font size in points (e.g., 11).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
size?: number | undefined;
/**
* Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean | undefined;
/**
* Represents the strikethrough status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean | undefined;
/**
* Represents the subscript status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean | undefined;
/**
* Represents the superscript status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean | undefined;
/**
* Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;
}
@@ -2655,24 +2608,21 @@ export declare namespace PowerPoint {
* Represents a sequence of one or more characters with the same font attributes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TextRun {
/**
* The font attributes (such as font name, font size, and color) applied to this text run.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
font?: PowerPoint.FontProperties;
/**
* The text of this text run.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text: string;
}
@@ -2726,8 +2676,7 @@ export declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export class TableCell extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -2737,16 +2686,14 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly columnCount: number;
/**
* Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly columnIndex: number;
/**
@@ -2754,24 +2701,21 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly rowCount: number;
/**
* Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly rowIndex: number;
/**
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text: string;
/**
@@ -2805,8 +2749,7 @@ export declare namespace PowerPoint {
* Represents a collection of table cells.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export class TableCellCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -2817,8 +2760,7 @@ export declare namespace PowerPoint {
* Gets the number of table cells in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
* @returns The number of table cells in the collection.
*/
getCount(): OfficeExtension.ClientResult;
@@ -2826,8 +2768,7 @@ export declare namespace PowerPoint {
* Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](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 BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param row - Row index value of the table cell to be retrieved, as a zero-based index.
* @param column - Column index value of the table cell to be retrieved, as a zero-based index.
@@ -2862,24 +2803,21 @@ export declare namespace PowerPoint {
* Represents the fill formatting of a table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface FillProperties {
/**
* Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
color?: string | undefined;
/**
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
transparency?: number | undefined;
}
@@ -2887,40 +2825,35 @@ export declare namespace PowerPoint {
* Represents the properties for a table cell border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface BorderProperties {
/**
* Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
color?: string | undefined;
/**
* Represents the dash style of the line.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
/**
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
transparency?: number | undefined;
/**
* Represents the weight of the line, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
weight?: number | undefined;
}
@@ -2928,56 +2861,49 @@ export declare namespace PowerPoint {
* Represents the borders of a table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableCellBorders {
/**
* Represents the bottom border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bottom?: PowerPoint.BorderProperties;
/**
* Represents the diagonal border (top-left to bottom-right).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
diagonalDown?: PowerPoint.BorderProperties;
/**
* Represents the diagonal border (bottom-left to top-right).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
diagonalUp?: PowerPoint.BorderProperties;
/**
* Represents the left border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
left?: PowerPoint.BorderProperties;
/**
* Represents the right border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
right?: PowerPoint.BorderProperties;
/**
* Represents the top border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
top?: PowerPoint.BorderProperties;
}
@@ -2985,40 +2911,35 @@ export declare namespace PowerPoint {
* Represents the margins of a table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableCellMargins {
/**
* Specifies the bottom margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bottom?: number | undefined;
/**
* Specifies the left margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
left?: number | undefined;
/**
* Specifies the right margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
right?: number | undefined;
/**
* Specifies the top margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
top?: number | undefined;
}
@@ -3026,56 +2947,49 @@ export declare namespace PowerPoint {
* Represents the table cell properties to update.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableCellProperties {
/**
* Specifies the border formatting of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
borders?: PowerPoint.TableCellBorders;
/**
* Specifies the fill formatting of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
fill?: PowerPoint.FillProperties;
/**
* Specifies the font formatting of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
font?: PowerPoint.FontProperties;
/**
* Represents the horizontal alignment of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
/**
* Represents the indent level of the text in the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
indentLevel?: number | undefined;
/**
* Specifies the margin settings in the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
margins?: PowerPoint.TableCellMargins;
/**
@@ -3084,8 +2998,7 @@ export declare namespace PowerPoint {
If a portion of the text requires different formatting, use the `textRuns` property instead.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: string;
/**
@@ -3093,16 +3006,14 @@ export declare namespace PowerPoint {
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textRuns?: PowerPoint.TextRun[];
/**
* Represents the vertical alignment of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
}
@@ -3110,8 +3021,7 @@ export declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export class Table extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -3120,32 +3030,28 @@ export declare namespace PowerPoint {
* Gets the number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly columnCount: number;
/**
* Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly rowCount: number;
/**
* Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly values: string[][];
/**
* Gets the cell at the specified `rowIndex` and `columnIndex`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param rowIndex - The zero-based row index of the cell.
* @param columnIndex - The zero-based column index of the cell.
@@ -3156,8 +3062,7 @@ export declare namespace PowerPoint {
* Gets a collection of cells that represent the merged areas of the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
* @returns a `TableCellCollection` with cells that represent the merged areas of the table.
*/
getMergedAreas(): PowerPoint.TableCellCollection;
@@ -3165,8 +3070,7 @@ export declare namespace PowerPoint {
* Gets the shape object for the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getShape(): PowerPoint.Shape;
/**
@@ -3200,8 +3104,7 @@ export declare namespace PowerPoint {
* Provides the table column properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableColumnProperties {
/**
@@ -3213,8 +3116,7 @@ export declare namespace PowerPoint {
a default column width will be used.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnWidth?: number | undefined;
}
@@ -3222,8 +3124,7 @@ export declare namespace PowerPoint {
* Represents the properties of a merged area of cells in a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableMergedAreaProperties {
/**
@@ -3231,16 +3132,14 @@ export declare namespace PowerPoint {
Must be 1 or greater.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount: number;
/**
* Specifies the zero-based index of the column of the top left cell of the merged area.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex: number;
/**
@@ -3248,16 +3147,14 @@ export declare namespace PowerPoint {
Must be 1 or greater.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount: number;
/**
* Specifies the zero-based index of the row of the top left cell of the merged area.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex: number;
}
@@ -3265,8 +3162,7 @@ export declare namespace PowerPoint {
* Provides the table row properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableRowProperties {
/**
@@ -3278,8 +3174,7 @@ export declare namespace PowerPoint {
a default row height will be used.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowHeight?: number | undefined;
}
@@ -3287,8 +3182,7 @@ export declare namespace PowerPoint {
* Represents the available options when adding a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableAddOptions {
/**
@@ -3297,8 +3191,7 @@ export declare namespace PowerPoint {
Specify an empty object for columns that should use the default formatting.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columns?: PowerPoint.TableColumnProperties[];
/**
@@ -3307,8 +3200,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a negative value.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
height?: number | undefined;
/**
@@ -3316,16 +3208,14 @@ export declare namespace PowerPoint {
The table is centered horizontally when this parameter is not provided.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
left?: number | undefined;
/**
* If specified, represents an rectangular area where multiple cells appear as a single cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
mergedAreas?: PowerPoint.TableMergedAreaProperties[];
/**
@@ -3334,8 +3224,7 @@ export declare namespace PowerPoint {
Specify an empty object for rows that should use the default formatting.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rows?: PowerPoint.TableRowProperties[];
/**
@@ -3347,8 +3236,7 @@ export declare namespace PowerPoint {
to the entire merged area. For the other cells in the merged area, an empty object should be provided.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
specificCellProperties?: PowerPoint.TableCellProperties[][];
/**
@@ -3356,8 +3244,7 @@ export declare namespace PowerPoint {
A default value is used when this parameter is not provided.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
top?: number | undefined;
/**
@@ -3373,8 +3260,7 @@ export declare namespace PowerPoint {
and do not specify specificCellProperties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
uniformCellProperties?: PowerPoint.TableCellProperties;
/**
@@ -3386,8 +3272,7 @@ export declare namespace PowerPoint {
in the merged area must be an empty string.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
values?: string[][];
/**
@@ -3396,8 +3281,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a negative value.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
width?: number | undefined;
}
@@ -3438,8 +3322,7 @@ export declare namespace PowerPoint {
* Create a shape group for several shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param values - An array of shape IDs or `Shape` objects.
* @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group.
@@ -3472,8 +3355,7 @@ export declare namespace PowerPoint {
Use the `Shape.table` property to get the `Table` object for the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param rowCount - Number of rows in the table. Must be 1 or greater.
* @param columnCount - Number of columns in the table. Must be 1 or greater.
@@ -3558,24 +3440,21 @@ export declare namespace PowerPoint {
* Represents the available options when getting an image of a slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface SlideGetImageOptions {
/**
* The desired height of the resulting image in pixels.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
height?: number;
/**
* The desired width of the resulting image in pixels.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
width?: number;
}
@@ -3583,267 +3462,229 @@ export declare namespace PowerPoint {
* Specifies the type of a slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum SlideLayoutType {
/**
* Blank layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
blank = "Blank",
/**
* Chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
chart = "Chart",
/**
* Chart and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
chartAndText = "ChartAndText",
/**
* ClipArt and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
clipArtAndText = "ClipArtAndText",
/**
* ClipArt and vertical text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
clipArtAndVerticalText = "ClipArtAndVerticalText",
/**
* Comparison layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
comparison = "Comparison",
/**
* Content with caption layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
contentWithCaption = "ContentWithCaption",
/**
* Custom layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
custom = "Custom",
/**
* Four objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
fourObjects = "FourObjects",
/**
* Large object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
largeObject = "LargeObject",
/**
* MediaClip and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
mediaClipAndText = "MediaClipAndText",
/**
* Mixed layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
mixed = "Mixed",
/**
* Object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
object = "Object",
/**
* Object and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
objectAndText = "ObjectAndText",
/**
* Object and two objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
objectAndTwoObjects = "ObjectAndTwoObjects",
/**
* Object over text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
objectOverText = "ObjectOverText",
/**
* Organization chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
organizationChart = "OrganizationChart",
/**
* Picture with caption layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
pictureWithCaption = "PictureWithCaption",
/**
* Section header layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
sectionHeader = "SectionHeader",
/**
* Table layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
table = "Table",
/**
* Text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text = "Text",
/**
* Text and chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndChart = "TextAndChart",
/**
* Text and ClipArt layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndClipArt = "TextAndClipArt",
/**
* Text and MediaClip layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndMediaClip = "TextAndMediaClip",
/**
* Text and object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndObject = "TextAndObject",
/**
* Text and two objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndTwoObjects = "TextAndTwoObjects",
/**
* Text over object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textOverObject = "TextOverObject",
/**
* Title layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
title = "Title",
/**
* Title only layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
titleOnly = "TitleOnly",
/**
* Two-column text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoColumnText = "TwoColumnText",
/**
* Two objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjects = "TwoObjects",
/**
* Two objects and object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjectsAndObject = "TwoObjectsAndObject",
/**
* Two objects and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjectsAndText = "TwoObjectsAndText",
/**
* Two objects over text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjectsOverText = "TwoObjectsOverText",
/**
* Vertical text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalText = "VerticalText",
/**
* Vertical title and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalTitleAndText = "VerticalTitleAndText",
/**
* Vertical title and text over chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
}
@@ -3888,8 +3729,7 @@ export declare namespace PowerPoint {
* Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
/**
@@ -4268,16 +4108,14 @@ export declare namespace PowerPoint {
* Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly index: number;
/**
* Applies the specified layout to the slide, changing its design and structure according to the chosen layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param slideLayout - The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master.
*/
@@ -4293,8 +4131,7 @@ export declare namespace PowerPoint {
* Exports the slide to its own presentation file, returned as Base64-encoded data.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
exportAsBase64(): OfficeExtension.ClientResult;
/**
@@ -4303,19 +4140,17 @@ export declare namespace PowerPoint {
of either width or height is specified, the other will be calculated to preserve aspect ratio.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param options - Optional. Options to specify the desired size of the slide image.
- * @returns A base64 string of the slide image in PNG format.
+ * @returns A Base64 string of the slide image in PNG format.
*/
getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult;
/**
* Moves the slide to a new position within the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param slideIndex - The zero-based index where the slide should be moved.
*/
@@ -4410,8 +4245,7 @@ export declare namespace PowerPoint {
If the collection contains fewer than two shapes, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
* @returns The newly created grouped shape as a {@link PowerPoint.Shape}.
*/
group(): PowerPoint.Shape;
@@ -4443,8 +4277,7 @@ export declare namespace PowerPoint {
* Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export class ShapeGroup extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -4453,32 +4286,28 @@ export declare namespace PowerPoint {
* Returns the `Shape` object associated with the group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly shape: PowerPoint.Shape;
/**
* Returns the collection of `Shape` objects in the group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly shapes: PowerPoint.ShapeScopedCollection;
/**
* Gets the unique ID of the shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly id: string;
/**
* Ungroups any grouped shapes in the specified shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
ungroup(): void;
/**
@@ -4963,36 +4792,31 @@ export declare namespace PowerPoint {
* Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum ShapeZOrder {
/**
* Brings the shape forward one spot in the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bringForward = "BringForward",
/**
* Brings the shape to the front of the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bringToFront = "BringToFront",
/**
* Sends the shape backward one spot in the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
sendBackward = "SendBackward",
/**
* Sends the shape to the back of the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
sendToBack = "SendToBack",
}
@@ -5024,8 +4848,7 @@ export declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly group: PowerPoint.ShapeGroup;
/**
@@ -5040,8 +4863,7 @@ export declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly parentGroup: PowerPoint.Shape;
/**
@@ -5049,8 +4871,7 @@ export declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly placeholderFormat: PowerPoint.PlaceholderFormat;
/**
@@ -5098,8 +4919,7 @@ export declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly level: number;
/**
@@ -5135,8 +4955,7 @@ export declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly zOrderPosition: number;
/**
@@ -5192,16 +5011,14 @@ export declare namespace PowerPoint {
* Returns the `Table` object if this shape is a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getTable(): PowerPoint.Table;
/**
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param position - Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
*/
@@ -5210,8 +5027,7 @@ export declare namespace PowerPoint {
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param positionString - Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
*/
@@ -5247,8 +5063,7 @@ export declare namespace PowerPoint {
* Represents an Office.js binding that is defined in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export class Binding extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -5257,32 +5072,28 @@ export declare namespace PowerPoint {
* Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly id: string;
/**
* Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly type: PowerPoint.BindingType | "Shape";
/**
* Deletes the binding.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
delete(): void;
/**
* Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getShape(): PowerPoint.Shape;
/**
@@ -5316,8 +5127,7 @@ export declare namespace PowerPoint {
* Represents the collection of all the binding objects that are part of the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export class BindingCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -5328,8 +5138,7 @@ export declare namespace PowerPoint {
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param shape - Shape to which the binding is added.
* @param bindingType - Type of binding. See `BindingType`.
@@ -5340,8 +5149,7 @@ export declare namespace PowerPoint {
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param shape - Shape to which the binding is added.
* @param bindingTypeString - Type of binding. See `BindingType`.
@@ -5353,8 +5161,7 @@ export declare namespace PowerPoint {
If the selection has multiple areas, the `InvalidReference` error will be returned.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param bindingType - Type of binding. See `BindingType`.
* @param id - ID of the binding.
@@ -5365,8 +5172,7 @@ export declare namespace PowerPoint {
If the selection has multiple areas, the `InvalidReference` error will be returned.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param bindingTypeString - Type of binding. See `BindingType`.
* @param id - ID of the binding.
@@ -5376,16 +5182,14 @@ export declare namespace PowerPoint {
* Gets the number of bindings in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getCount(): OfficeExtension.ClientResult;
/**
* Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param key - ID of the binding object to be retrieved.
*/
@@ -5394,8 +5198,7 @@ export declare namespace PowerPoint {
* Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param index - Index value of the object to be retrieved. Zero-indexed.
*/
@@ -5405,8 +5208,7 @@ export declare namespace PowerPoint {
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 BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param id - ID of the binding object to be retrieved.
*/
@@ -5990,7 +5792,7 @@ export declare namespace PowerPoint {
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}."
+ 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]
@@ -6098,8 +5900,7 @@ export declare namespace PowerPoint {
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean | null;
/**
@@ -6132,8 +5933,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean | null;
/**
@@ -6173,8 +5973,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean | null;
/**
@@ -6187,8 +5986,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean | null;
/**
@@ -6201,8 +5999,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean | null;
/**
@@ -6215,8 +6012,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean | null;
/**
@@ -6233,8 +6029,7 @@ export declare namespace PowerPoint {
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: string;
}
@@ -6589,16 +6384,14 @@ export declare namespace PowerPoint {
Returns `null` if the placeholder is empty.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
/**
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
}
@@ -6659,8 +6452,7 @@ export declare namespace PowerPoint {
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean | null;
/**
@@ -6693,8 +6485,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean | null;
/**
@@ -6734,8 +6525,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean | null;
/**
@@ -6748,8 +6538,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean | null;
/**
@@ -6762,8 +6551,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean | null;
/**
@@ -6776,8 +6564,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean | null;
/**
@@ -6795,16 +6582,14 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: number;
/**
* Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex?: number;
/**
@@ -6812,24 +6597,21 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: number;
/**
* Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex?: number;
/**
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: string;
}
@@ -6843,24 +6625,21 @@ export declare namespace PowerPoint {
* Gets the number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: number;
/**
* Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: number;
/**
* Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
values?: string[][];
}
@@ -6888,8 +6667,7 @@ export declare namespace PowerPoint {
* Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
}
@@ -6948,8 +6726,7 @@ export declare namespace PowerPoint {
* Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: number;
}
@@ -6963,8 +6740,7 @@ export declare namespace PowerPoint {
* Gets the unique ID of the shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: string;
}
@@ -7151,8 +6927,7 @@ export declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: number;
/**
@@ -7188,8 +6963,7 @@ export declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: number;
}
@@ -7199,16 +6973,14 @@ export declare namespace PowerPoint {
* Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: string;
/**
* Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: PowerPoint.BindingType | "Shape";
}
@@ -7446,8 +7218,7 @@ export declare namespace PowerPoint {
* Represents the properties of a `placeholder` shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface PlaceholderFormatLoadOptions {
/**
@@ -7459,16 +7230,14 @@ export declare namespace PowerPoint {
Returns `null` if the placeholder is empty.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
containedType?: boolean;
/**
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -7578,8 +7347,7 @@ export declare namespace PowerPoint {
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean;
/**
@@ -7612,8 +7380,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean;
/**
@@ -7653,8 +7420,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean;
/**
@@ -7667,8 +7433,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean;
/**
@@ -7681,8 +7446,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean;
/**
@@ -7695,8 +7459,7 @@ export declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean;
/**
@@ -7711,8 +7474,7 @@ export declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableCellLoadOptions {
/**
@@ -7724,16 +7486,14 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: boolean;
/**
* Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex?: boolean;
/**
@@ -7741,24 +7501,21 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: boolean;
/**
* Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex?: boolean;
/**
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: boolean;
}
@@ -7766,8 +7523,7 @@ export declare namespace PowerPoint {
* Represents a collection of table cells.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableCellCollectionLoadOptions {
/**
@@ -7779,16 +7535,14 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: boolean;
/**
* For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex?: boolean;
/**
@@ -7796,24 +7550,21 @@ export declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: boolean;
/**
* For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex?: boolean;
/**
* For EACH ITEM in the collection: Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: boolean;
}
@@ -7821,8 +7572,7 @@ export declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface TableLoadOptions {
/**
@@ -7833,24 +7583,21 @@ export declare namespace PowerPoint {
* Gets the number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: boolean;
/**
* Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: boolean;
/**
* Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
values?: boolean;
}
@@ -7877,8 +7624,7 @@ export declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
@@ -7893,8 +7639,7 @@ export declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
@@ -7902,8 +7647,7 @@ export declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
@@ -7944,8 +7688,7 @@ export declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: boolean;
/**
@@ -7981,8 +7724,7 @@ export declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: boolean;
}
@@ -8015,8 +7757,7 @@ export declare namespace PowerPoint {
* Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -8049,8 +7790,7 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -8168,8 +7908,7 @@ export declare namespace PowerPoint {
* Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: boolean;
}
@@ -8196,8 +7935,7 @@ export declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
@@ -8212,8 +7950,7 @@ export declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
@@ -8221,8 +7958,7 @@ export declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
@@ -8263,8 +7999,7 @@ export declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: boolean;
/**
@@ -8300,8 +8035,7 @@ export declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: boolean;
}
@@ -8309,8 +8043,7 @@ export declare namespace PowerPoint {
* Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface ShapeGroupLoadOptions {
/**
@@ -8321,16 +8054,14 @@ export declare namespace PowerPoint {
* Returns the `Shape` object associated with the group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
shape?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
* Gets the unique ID of the shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: boolean;
}
@@ -8580,8 +8311,7 @@ export declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
@@ -8596,8 +8326,7 @@ export declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
@@ -8605,8 +8334,7 @@ export declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
@@ -8647,8 +8375,7 @@ export declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: boolean;
/**
@@ -8684,8 +8411,7 @@ export declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: boolean;
}
@@ -8693,8 +8419,7 @@ export declare namespace PowerPoint {
* Represents an Office.js binding that is defined in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface BindingLoadOptions {
/**
@@ -8705,16 +8430,14 @@ export declare namespace PowerPoint {
* Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: boolean;
/**
* Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -8722,8 +8445,7 @@ export declare namespace PowerPoint {
* Represents the collection of all the binding objects that are part of the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
export interface BindingCollectionLoadOptions {
/**
@@ -8734,16 +8456,14 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: boolean;
/**
* For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -8940,8 +8660,7 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: boolean;
}
@@ -8981,8 +8700,7 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: boolean;
}
diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts
index 235607c052..642c55a697 100644
--- a/generate-docs/script-inputs/office.d.ts
+++ b/generate-docs/script-inputs/office.d.ts
@@ -125127,6 +125127,13 @@ declare namespace PowerPoint {
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 a collection of bindings that are associated with the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly bindings: PowerPoint.BindingCollection;
/**
* Returns a collection of custom XML parts that are associated with the presentation.
*
@@ -125276,6 +125283,20 @@ declare namespace PowerPoint {
*/
slideMasterId?: string;
}
+ /**
+ * Represents the possible binding types.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum BindingType {
+ /**
+ * Represents a shape binding.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ shape = "Shape",
+ }
/**
* Represents a custom XML part object.
*
@@ -125511,6 +125532,134 @@ declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
}
+ /**
+ * Specifies the type of a placeholder.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum PlaceholderType {
+ /**
+ * The placeholder is unsupported.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ unsupported = "Unsupported",
+ /**
+ * The placeholder is for a date.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ date = "Date",
+ /**
+ * The placeholder is for a slide number.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ slideNumber = "SlideNumber",
+ /**
+ * The placeholder is for a footer.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ footer = "Footer",
+ /**
+ * The placeholder is for a header.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ header = "Header",
+ /**
+ * The placeholder is for a title.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ title = "Title",
+ /**
+ * The placeholder is for a body.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ body = "Body",
+ /**
+ * The placeholder is for a center title.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ centerTitle = "CenterTitle",
+ /**
+ * The placeholder is for a subtitle.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subtitle = "Subtitle",
+ /**
+ * The placeholder is for a vertical title.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalTitle = "VerticalTitle",
+ /**
+ * The placeholder is for a vertical body.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalBody = "VerticalBody",
+ /**
+ * The placeholder is for generic content.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ content = "Content",
+ /**
+ * The placeholder is for a chart.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ chart = "Chart",
+ /**
+ * The placeholder is for a table.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ table = "Table",
+ /**
+ * The placeholder is for an online picture.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ onlinePicture = "OnlinePicture",
+ /**
+ * The placeholder is for a SmartArt.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smartArt = "SmartArt",
+ /**
+ * The placeholder is for media.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ media = "Media",
+ /**
+ * The placeholder is for generic vertical content.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalContent = "VerticalContent",
+ /**
+ * The placeholder is for a picture.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ picture = "Picture",
+ /**
+ * The placeholder is for a cameo.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ cameo = "Cameo",
+ }
/**
* Specifies the type of a shape.
*
@@ -125633,6 +125782,57 @@ declare namespace PowerPoint {
*/
textBox = "TextBox",
}
+ /**
+ * Represents the properties of a `placeholder` shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ class PlaceholderFormat 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 type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
+ Returns `null` if the placeholder is empty.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
+ /**
+ * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
+ /**
+ * 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.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat;
+ /**
+ * 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.PlaceholderFormat;
+ /**
+ * 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.PlaceholderFormat;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;
+ }
/**
* Represents a single hyperlink.
*
@@ -127085,6 +127285,15 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
clear(): void;
+ /**
+ * Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param base64EncodedImage A string that is a Base64 encoding of the image data.
+ */
+ setImage(base64EncodedImage: string): void;
/**
* Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
*
@@ -127240,6 +127449,19 @@ declare namespace PowerPoint {
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;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps: boolean | null;
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -127260,6 +127482,19 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color: string | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough: boolean | null;
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -127287,6 +127522,58 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size: number | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript: boolean | null;
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -127321,6 +127608,120 @@ declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeFontData;
}
+ /**
+ * Represents the font attributes, such as font name, size, and color.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface FontProperties {
+ /**
+ * Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean | undefined;
+ /**
+ * Represents the bold status of font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bold?: boolean | undefined;
+ /**
+ * Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ color?: string | undefined;
+ /**
+ * Represents the double-strikethrough status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean | undefined;
+ /**
+ * Represents the italic status of font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ italic?: boolean | undefined;
+ /**
+ * Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ name?: string | undefined;
+ /**
+ * Represents the font size in points (e.g., 11).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ size?: number | undefined;
+ /**
+ * Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean | undefined;
+ /**
+ * Represents the strikethrough status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean | undefined;
+ /**
+ * Represents the subscript status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean | undefined;
+ /**
+ * Represents the superscript status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean | undefined;
+ /**
+ * Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;
+ }
+ /**
+ * Represents a sequence of one or more characters with the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TextRun {
+ /**
+ * The font attributes (such as font name, font size, and color) applied to this text run.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ font?: PowerPoint.FontProperties;
+ /**
+ * The text of this text run.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text: string;
+ }
/**
* 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.
@@ -127368,25 +127769,638 @@ declare namespace PowerPoint {
bottomCentered = "BottomCentered",
}
/**
- * Represents the collection of shapes.
+ * Represents a table.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.8]
*/
- class ShapeCollection extends OfficeExtension.ClientObject {
+ class TableCell 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.
+ * Gets the number of table columns this cell spans across.
+ Will be greater than or equal to 1.
*
* @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.
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly columnCount: number;
+ /**
+ * Gets the zero-based column index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly columnIndex: number;
+ /**
+ * Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly rowCount: number;
+ /**
+ * Gets the zero-based row index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly rowIndex: number;
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text: 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.TableCellLoadOptions): PowerPoint.TableCell;
+ /**
+ * 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.TableCell;
+ /**
+ * 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.TableCell;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableCellData;
+ }
+ /**
+ * Represents a collection of table cells.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ class TableCellCollection 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.TableCell[];
+ /**
+ * Gets the number of table cells in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ * @returns The number of table cells in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](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.8]
+ *
+ * @param row Row index value of the table cell to be retrieved, as a zero-based index.
+ * @param column Column index value of the table cell to be retrieved, as a zero-based index.
+ * @returns The `TableCell` object.
+ */
+ getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell;
+ /**
+ * 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.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection;
+ /**
+ * 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.TableCellCollection;
+ /**
+ * 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.TableCellCollection;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.TableCellCollectionData;
+ }
+ /**
+ * Represents the fill formatting of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface FillProperties {
+ /**
+ * Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ color?: string | undefined;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ transparency?: number | undefined;
+ }
+ /**
+ * Represents the properties for a table cell border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface BorderProperties {
+ /**
+ * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ color?: string | undefined;
+ /**
+ * Represents the dash style of the line.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
+ /**
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ transparency?: number | undefined;
+ /**
+ * Represents the weight of the line, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ weight?: number | undefined;
+ }
+ /**
+ * Represents the borders of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableCellBorders {
+ /**
+ * Represents the bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bottom?: PowerPoint.BorderProperties;
+ /**
+ * Represents the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ diagonalDown?: PowerPoint.BorderProperties;
+ /**
+ * Represents the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ diagonalUp?: PowerPoint.BorderProperties;
+ /**
+ * Represents the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ left?: PowerPoint.BorderProperties;
+ /**
+ * Represents the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ right?: PowerPoint.BorderProperties;
+ /**
+ * Represents the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ top?: PowerPoint.BorderProperties;
+ }
+ /**
+ * Represents the margins of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableCellMargins {
+ /**
+ * Specifies the bottom margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bottom?: number | undefined;
+ /**
+ * Specifies the left margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ left?: number | undefined;
+ /**
+ * Specifies the right margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ right?: number | undefined;
+ /**
+ * Specifies the top margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ top?: number | undefined;
+ }
+ /**
+ * Represents the table cell properties to update.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableCellProperties {
+ /**
+ * Specifies the border formatting of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ borders?: PowerPoint.TableCellBorders;
+ /**
+ * Specifies the fill formatting of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ fill?: PowerPoint.FillProperties;
+ /**
+ * Specifies the font formatting of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ font?: PowerPoint.FontProperties;
+ /**
+ * Represents the horizontal alignment of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
+ /**
+ * Represents the indent level of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ indentLevel?: number | undefined;
+ /**
+ * Specifies the margin settings in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ margins?: PowerPoint.TableCellMargins;
+ /**
+ * Specifies the text content of the table cell.
+
+ If a portion of the text requires different formatting, use the `textRuns` property instead.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: string;
+ /**
+ * Specifies the contents of the table cell as an array of {@link TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textRuns?: PowerPoint.TextRun[];
+ /**
+ * Represents the vertical alignment of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
+ }
+ /**
+ * Represents a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ class Table 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 number of columns in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly columnCount: number;
+ /**
+ * Gets the number of rows in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly rowCount: number;
+ /**
+ * Gets all of the values in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly values: string[][];
+ /**
+ * Gets the cell at the specified `rowIndex` and `columnIndex`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param rowIndex The zero-based row index of the cell.
+ * @param columnIndex The zero-based column index of the cell.
+ * @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned.
+ */
+ getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
+ /**
+ * Gets a collection of cells that represent the merged areas of the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ * @returns a `TableCellCollection` with cells that represent the merged areas of the table.
+ */
+ getMergedAreas(): PowerPoint.TableCellCollection;
+ /**
+ * Gets the shape object for the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ getShape(): 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.TableLoadOptions): PowerPoint.Table;
+ /**
+ * 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.Table;
+ /**
+ * 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.Table;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableData;
+ }
+ /**
+ * Provides the table column properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableColumnProperties {
+ /**
+ * Represents the desired width of each column in points, or is undefined.
+
+ When a table is being added, for columns whose width is undefined,
+ the column width will be calculated by evenly dividing the remaining width
+ of the table amongst those columns. If the table does not have a defined width,
+ a default column width will be used.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnWidth?: number | undefined;
+ }
+ /**
+ * Represents the properties of a merged area of cells in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableMergedAreaProperties {
+ /**
+ * Specifies the number of columns for the merged cells area.
+ Must be 1 or greater.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount: number;
+ /**
+ * Specifies the zero-based index of the column of the top left cell of the merged area.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnIndex: number;
+ /**
+ * Specifies the number of rows for the merged cells area.
+ Must be 1 or greater.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount: number;
+ /**
+ * Specifies the zero-based index of the row of the top left cell of the merged area.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowIndex: number;
+ }
+ /**
+ * Provides the table row properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableRowProperties {
+ /**
+ * Represents the desired height of each row in points, or is undefined.
+
+ When a table is being added, for rows whose height is undefined,
+ the row height will be calculated by evenly dividing the remaining height
+ of the table amongst those rows. If the table does not have a defined height,
+ a default row height will be used.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowHeight?: number | undefined;
+ }
+ /**
+ * Represents the available options when adding a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableAddOptions {
+ /**
+ * If provided, specifies properties for each column in the table.
+ The array length must be equal to the number of columns in the table.
+ Specify an empty object for columns that should use the default formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columns?: PowerPoint.TableColumnProperties[];
+ /**
+ * Specifies the height, in points, of the table.
+ A default value is used when this parameter is not provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ height?: number | undefined;
+ /**
+ * Specifies the distance, in points, from the left side of the table to the left side of the slide.
+ The table is centered horizontally when this parameter is not provided.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ left?: number | undefined;
+ /**
+ * If specified, represents an rectangular area where multiple cells appear as a single cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ mergedAreas?: PowerPoint.TableMergedAreaProperties[];
+ /**
+ * If provided, specifies properties for each row in the table.
+ The array length must be equal to the number of rows in the table.
+ Specify an empty object for rows that should use the default formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rows?: PowerPoint.TableRowProperties[];
+ /**
+ * If provided, specifies properties for each cell in the table.
+
+ This should be an 2D array with the same number of rows and columns as the table.
+ If a cell does not require specific formatting, specify an empty object for that cell.
+ Only the top left cell of a merged are can have properties specified, which will be applied
+ to the entire merged area. For the other cells in the merged area, an empty object should be provided.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ specificCellProperties?: PowerPoint.TableCellProperties[][];
+ /**
+ * Specifies the distance, in points, from the top edge of the table to the top edge of the slide.
+ A default value is used when this parameter is not provided.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ top?: number | undefined;
+ /**
+ * Specifies the formatting which applies uniformly to all of the table cells.
+
+ To apply specific formatting to individual cells, use specificCellProperties.
+
+ If both uniformCellProperties and specificCellProperties are undefined, the default formatting
+ will be used, and the default table style will be applied. The table will have the same
+ appearance as when the user adds a table through the PowerPoint UI.
+
+ To provide a plain appearance for the table, set this property to an empty object
+ and do not specify specificCellProperties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ uniformCellProperties?: PowerPoint.TableCellProperties;
+ /**
+ * If provided, specifies the values for the table.
+
+ When the table contains areas of merged cells,
+ only the top left cell of each merged area can have a
+ non-empty string value. The other cells
+ in the merged area must be an empty string.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ values?: string[][];
+ /**
+ * Specifies the width, in points, of the table.
+ A default value is used when this parameter is not provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ width?: number | undefined;
+ }
+ /**
+ * Represents the collection of shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.3]
+ */
+ 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;
/**
@@ -127400,6 +128414,16 @@ declare namespace PowerPoint {
* @returns The newly inserted shape.
*/
addGeometricShape(geometricShapeType: "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;
+ /**
+ * Create a shape group for several shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param values An array of shape IDs or `Shape` objects.
+ * @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group.
+ */
+ addGroup(values: Array): PowerPoint.Shape;
/**
* Adds a line to the slide. Returns a `Shape` object that represents the new line.
*
@@ -127423,6 +128447,19 @@ declare namespace PowerPoint {
*/
addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
/**
+ * Adds a table to the slide. Returns a `Shape` object that represents the new table.
+ Use the `Shape.table` property to get the `Table` object for the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param rowCount Number of rows in the table. Must be 1 or greater.
+ * @param columnCount Number of columns in the table. Must be 1 or greater.
+ * @param options Provides options describing the new table.
+ * @returns The newly inserted shape.
+ */
+ addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): 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
@@ -127495,6 +128532,258 @@ declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
}
+ /**
+ * Represents the available options when getting an image of a slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface SlideGetImageOptions {
+ /**
+ * The desired height of the resulting image in pixels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ height?: number;
+ /**
+ * The desired width of the resulting image in pixels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ width?: number;
+ }
+ /**
+ * Specifies the type of a slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum SlideLayoutType {
+ /**
+ * Blank layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ blank = "Blank",
+ /**
+ * Chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ chart = "Chart",
+ /**
+ * Chart and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ chartAndText = "ChartAndText",
+ /**
+ * ClipArt and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ clipArtAndText = "ClipArtAndText",
+ /**
+ * ClipArt and vertical text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ clipArtAndVerticalText = "ClipArtAndVerticalText",
+ /**
+ * Comparison layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ comparison = "Comparison",
+ /**
+ * Content with caption layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ contentWithCaption = "ContentWithCaption",
+ /**
+ * Custom layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ custom = "Custom",
+ /**
+ * Four objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ fourObjects = "FourObjects",
+ /**
+ * Large object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ largeObject = "LargeObject",
+ /**
+ * MediaClip and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ mediaClipAndText = "MediaClipAndText",
+ /**
+ * Mixed layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ mixed = "Mixed",
+ /**
+ * Object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ object = "Object",
+ /**
+ * Object and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ objectAndText = "ObjectAndText",
+ /**
+ * Object and two objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ objectAndTwoObjects = "ObjectAndTwoObjects",
+ /**
+ * Object over text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ objectOverText = "ObjectOverText",
+ /**
+ * Organization chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ organizationChart = "OrganizationChart",
+ /**
+ * Picture with caption layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ pictureWithCaption = "PictureWithCaption",
+ /**
+ * Section header layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ sectionHeader = "SectionHeader",
+ /**
+ * Table layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ table = "Table",
+ /**
+ * Text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text = "Text",
+ /**
+ * Text and chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndChart = "TextAndChart",
+ /**
+ * Text and ClipArt layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndClipArt = "TextAndClipArt",
+ /**
+ * Text and MediaClip layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndMediaClip = "TextAndMediaClip",
+ /**
+ * Text and object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndObject = "TextAndObject",
+ /**
+ * Text and two objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textAndTwoObjects = "TextAndTwoObjects",
+ /**
+ * Text over object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ textOverObject = "TextOverObject",
+ /**
+ * Title layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ title = "Title",
+ /**
+ * Title only layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ titleOnly = "TitleOnly",
+ /**
+ * Two-column text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoColumnText = "TwoColumnText",
+ /**
+ * Two objects layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjects = "TwoObjects",
+ /**
+ * Two objects and object layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjectsAndObject = "TwoObjectsAndObject",
+ /**
+ * Two objects and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjectsAndText = "TwoObjectsAndText",
+ /**
+ * Two objects over text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ twoObjectsOverText = "TwoObjectsOverText",
+ /**
+ * Vertical text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalText = "VerticalText",
+ /**
+ * Vertical title and text layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalTitleAndText = "VerticalTitleAndText",
+ /**
+ * Vertical title and text over chart layout.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
+ }
/**
* Represents the layout of a slide.
*
@@ -127532,6 +128821,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly name: string;
+ /**
+ * Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -127903,14 +129199,58 @@ declare namespace PowerPoint {
* @remarks
* [Api set: PowerPointApi 1.2]
*/
- readonly id: string;
+ readonly id: string;
+ /**
+ * Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly index: number;
+ /**
+ * Applies the specified layout to the slide, changing its design and structure according to the chosen layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param slideLayout The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master.
+ */
+ applyLayout(slideLayout: PowerPoint.SlideLayout): void;
+ /**
+ * Deletes the slide from the presentation. Does nothing if the slide does not exist.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.2]
+ */
+ delete(): void;
+ /**
+ * Exports the slide to its own presentation file, returned as Base64-encoded data.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ exportAsBase64(): OfficeExtension.ClientResult;
+ /**
+ * Renders an image of the slide. The image is scaled to fit into the desired dimensions.
+ If width and height aren't specified, the true size of the slide is used. If only one
+ of either width or height is specified, the other will be calculated to preserve aspect ratio.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param options Optional. Options to specify the desired size of the slide image.
+ * @returns A Base64 string of the slide image in PNG format.
+ */
+ getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult;
/**
- * Deletes the slide from the presentation. Does nothing if the slide does not exist.
+ * Moves the slide to a new position within the presentation.
*
* @remarks
- * [Api set: PowerPointApi 1.2]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param slideIndex The zero-based index where the slide should be moved.
*/
- delete(): void;
+ moveTo(slideIndex: number): void;
/**
* Selects the specified shapes. Existing shape selection is replaced with the new selection.
*
@@ -127996,6 +129336,15 @@ declare namespace PowerPoint {
* @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;
+ /**
+ * Groups all shapes in this collection into a single shape.
+ If the collection contains fewer than two shapes, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ * @returns The newly created grouped shape as a {@link PowerPoint.Shape}.
+ */
+ group(): PowerPoint.Shape;
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -128020,6 +129369,70 @@ declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
}
+ /**
+ * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ class ShapeGroup 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 `Shape` object associated with the group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly shape: PowerPoint.Shape;
+ /**
+ * Returns the collection of `Shape` objects in the group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly shapes: PowerPoint.ShapeScopedCollection;
+ /**
+ * Gets the unique ID of the shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly id: string;
+ /**
+ * Ungroups any grouped shapes in the specified shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ ungroup(): 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.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;
+ /**
+ * 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.ShapeGroup;
+ /**
+ * 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.ShapeGroup;
+ /**
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.ShapeGroupData;
+ }
/**
* Specifies the style for a line.
*
@@ -128471,6 +129884,38 @@ declare namespace PowerPoint {
*/
toJSON(): PowerPoint.Interfaces.TextFrameData;
}
+ /**
+ * Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ enum ShapeZOrder {
+ /**
+ * Brings the shape forward one spot in the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bringForward = "BringForward",
+ /**
+ * Brings the shape to the front of the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ bringToFront = "BringToFront",
+ /**
+ * Sends the shape backward one spot in the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ sendBackward = "SendBackward",
+ /**
+ * Sends the shape to the back of the z-order.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ sendToBack = "SendToBack",
+ }
/**
* Represents a single shape in the slide.
*
@@ -128494,6 +129939,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly fill: PowerPoint.ShapeFill;
+ /**
+ * Returns the `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly group: PowerPoint.ShapeGroup;
/**
* Returns the line formatting of this shape.
*
@@ -128501,6 +129954,22 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly lineFormat: PowerPoint.ShapeLineFormat;
+ /**
+ * Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly parentGroup: PowerPoint.Shape;
+ /**
+ * Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly placeholderFormat: PowerPoint.PlaceholderFormat;
/**
* Returns a collection of tags in the shape.
*
@@ -128509,136 +129978,360 @@ declare namespace PowerPoint {
*/
readonly tags: PowerPoint.TagCollection;
/**
- * Returns the text frame object of this shape.
+ * 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;
+ /**
+ * Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly level: 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" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
+ /**
+ * 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;
+ /**
+ * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ readonly zOrderPosition: 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;
+ /**
+ * Returns the `Table` object if this shape is a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ getTable(): PowerPoint.Table;
+ /**
+ * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
+ */
+ setZOrder(position: PowerPoint.ShapeZOrder): void;
+ /**
+ * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
+ */
+ setZOrder(position: "BringForward" | "BringToFront" | "SendBackward" | "SendToBack"): 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.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's 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;
+ }
+ /**
+ * Represents an Office.js binding that is defined in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ class Binding 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 binding identifier.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- readonly textFrame: PowerPoint.TextFrame;
+ readonly id: string;
/**
- * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
+ * Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- height: number;
+ readonly type: PowerPoint.BindingType | "Shape";
/**
- * Gets the unique ID of the shape.
+ * Deletes the binding.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.8]
*/
- readonly id: string;
+ delete(): void;
/**
- * The distance, in points, from the left side of the shape to the left side of the slide.
+ * Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- left: number;
+ getShape(): PowerPoint.Shape;
/**
- * Specifies the name of this shape.
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * @param options Provides options for which properties of the object to load.
*/
- name: string;
+ load(options?: PowerPoint.Interfaces.BindingLoadOptions): PowerPoint.Binding;
/**
- * The distance, in points, from the top edge of the shape to the top edge of the slide.
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
*/
- top: number;
+ load(propertyNames?: string | string[]): PowerPoint.Binding;
/**
- * Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * @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.
*/
- readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Binding;
/**
- * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.BindingData;
+ }
+ /**
+ * Represents the collection of all the binding objects that are part of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ class BindingCollection 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.Binding[];
+ /**
+ * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param shape Shape to which the binding is added.
+ * @param bindingType Type of binding. See `BindingType`.
+ * @param id ID of the binding.
*/
- width: number;
+ add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
/**
- * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
+ * Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param shape Shape to which the binding is added.
+ * @param bindingType Type of binding. See `BindingType`.
+ * @param id ID of the binding.
*/
- delete(): void;
+ add(shape: PowerPoint.Shape, bindingType: "Shape", id: string): PowerPoint.Binding;
/**
- * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`.
+ * Adds a new binding based on the current selection.
+ If the selection has multiple areas, the `InvalidReference` error will be returned.
*
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param bindingType Type of binding. See `BindingType`.
+ * @param id ID of the binding.
*/
- getParentSlide(): PowerPoint.Slide;
+ addFromSelection(bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
/**
- * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`.
+ * Adds a new binding based on the current selection.
+ If the selection has multiple areas, the `InvalidReference` error will be returned.
*
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param bindingType Type of binding. See `BindingType`.
+ * @param id ID of the binding.
*/
- getParentSlideLayout(): PowerPoint.SlideLayout;
+ addFromSelection(bindingType: "Shape", id: string): PowerPoint.Binding;
/**
- * 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.
+ * Gets the number of bindings in the collection.
*
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.8]
*/
- getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
+ getCount(): OfficeExtension.ClientResult;
/**
- * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`.
+ * Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID.
*
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param key ID of the binding object to be retrieved.
*/
- getParentSlideMaster(): PowerPoint.SlideMaster;
+ getItem(key: string): PowerPoint.Binding;
/**
- * 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.
+ * Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection.
*
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param index Index value of the object to be retrieved. Zero-indexed.
*/
- getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
+ getItemAt(index: number): PowerPoint.Binding;
/**
- * 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.
+ * Gets a binding object by ID. If the binding object doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
+ 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]
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param id ID of the binding object to be retrieved.
*/
- getParentSlideOrNullObject(): PowerPoint.Slide;
+ getItemOrNullObject(id: string): PowerPoint.Binding;
/**
* 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;
+ load(options?: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.BindingCollection;
/**
* 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;
+ load(propertyNames?: string | string[]): PowerPoint.BindingCollection;
/**
* 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;
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.BindingCollection;
/**
- * 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's 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;
+ * 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's passed to it.)
+ * Whereas the original `PowerPoint.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.BindingCollectionData;
}
/**
* Specifies the document property type for custom properties.
@@ -129195,7 +130888,7 @@ declare namespace PowerPoint {
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}."
+ 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]
@@ -129293,6 +130986,19 @@ declare namespace PowerPoint {
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
interface ShapeFontUpdateData {
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps**attribute.
+ *
+ * - `null`: Some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean | null;
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
@@ -129313,6 +131019,19 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean | null;
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -129340,6 +131059,58 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
size?: number | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean | null;
/**
* Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
@@ -129348,6 +131119,20 @@ declare namespace PowerPoint {
*/
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
}
+ /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
+ interface TableCellUpdateData {
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: string;
+ }
+ /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
+ interface TableCellCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
interface ShapeCollectionUpdateData {
items?: PowerPoint.Interfaces.ShapeData[];
@@ -129555,6 +131340,10 @@ declare namespace PowerPoint {
*/
width?: number;
}
+ /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
+ interface BindingCollectionUpdateData {
+ items?: PowerPoint.Interfaces.BindingData[];
+ }
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
interface CustomPropertyUpdateData {
/**
@@ -129684,6 +131473,24 @@ declare namespace PowerPoint {
interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
+ interface PlaceholderFormatData {
+ /**
+ * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
+ Returns `null` if the placeholder is empty.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
+ /**
+ * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
+ }
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
interface HyperlinkData {
/**
@@ -129732,6 +131539,19 @@ declare namespace PowerPoint {
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
interface ShapeFontData {
/**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps**attribute.
+ *
+ * - `null`: Some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean | null;
+ /**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
*
* - `true`: All the text is bold.
@@ -129751,6 +131571,19 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
color?: string | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean | null;
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
*
@@ -129763,28 +131596,148 @@ declare namespace PowerPoint {
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- italic?: boolean | null;
+ italic?: boolean | null;
+ /**
+ * Specifies the 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. Returns `null` if the `TextRange` contains text fragments with different font names.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ name?: string | null;
+ /**
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ size?: number | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean | null;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean | null;
+ /**
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains 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" | null;
+ }
+ /** An interface describing the data returned by calling `tableCell.toJSON()`. */
+ interface TableCellData {
+ /**
+ * Gets the number of table columns this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnCount?: number;
+ /**
+ * Gets the zero-based column index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ columnIndex?: number;
+ /**
+ * Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount?: number;
+ /**
+ * Gets the zero-based row index of the cell within the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowIndex?: number;
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: string;
+ }
+ /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
+ interface TableCellCollectionData {
+ items?: PowerPoint.Interfaces.TableCellData[];
+ }
+ /** An interface describing the data returned by calling `table.toJSON()`. */
+ interface TableData {
/**
- * Specifies the 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. Returns `null` if the `TextRange` contains text fragments with different font names.
+ * Gets the number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- name?: string | null;
+ columnCount?: number;
/**
- * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ * Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- size?: number | null;
+ rowCount?: number;
/**
- * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+ * Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
+ values?: string[][];
}
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
interface ShapeCollectionData {
@@ -129806,6 +131759,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: string;
+ /**
+ * Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
}
/** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
interface SlideLayoutCollectionData {
@@ -129858,11 +131818,28 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: string;
+ /**
+ * Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: number;
}
/** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
interface ShapeScopedCollectionData {
items?: PowerPoint.Interfaces.ShapeData[];
}
+ /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
+ interface ShapeGroupData {
+ /**
+ * Gets the unique ID of the shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: string;
+ }
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
interface ShapeLineFormatData {
/**
@@ -130036,6 +132013,19 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: number;
+ /**
+ * Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: number;
/**
* Specifies the name of this shape.
*
@@ -130064,6 +132054,35 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: number;
+ /**
+ * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: number;
+ }
+ /** An interface describing the data returned by calling `binding.toJSON()`. */
+ interface BindingData {
+ /**
+ * Represents the binding identifier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: string;
+ /**
+ * Returns the type of the binding. See `BindingType` for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: PowerPoint.BindingType | "Shape";
+ }
+ /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
+ interface BindingCollectionData {
+ items?: PowerPoint.Interfaces.BindingData[];
}
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
interface CustomPropertyData {
@@ -130291,6 +132310,33 @@ declare namespace PowerPoint {
*/
namespaceUri?: boolean;
}
+ /**
+ * Represents the properties of a `placeholder` shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface PlaceholderFormatLoadOptions {
+ /**
+ 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 type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
+ Returns `null` if the placeholder is empty.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ containedType?: boolean;
+ /**
+ * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: boolean;
+ }
/**
* Represents a single hyperlink.
*
@@ -130315,132 +132361,341 @@ declare namespace PowerPoint {
* @remarks
* [Api set: PowerPointApi 1.6]
*/
- screenTip?: boolean;
+ 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 fill formatting of a shape object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ 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 font attributes, such as font name, font size, and color, for a shape's TextRange object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ 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;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **All Caps** attribute.
+ *
+ * - `false`: None of the text has the **All Caps**attribute.
+ *
+ * - `null`: Some, but not all, of the text has the **All Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ allCaps?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+ *
+ * - `true`: All the text is bold.
+ *
+ * - `false`: None of the text is bold.
+ *
+ * - `null`: Returned if some, but not all, of the text is bold.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bold?: boolean;
+ /**
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ color?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Double strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Double strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ doubleStrikethrough?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+ *
+ * - `true`: All the text is italicized.
+ *
+ * - `false`: None of the text is italicized.
+ *
+ * - `null`: Returned if some, but not all, of the text is italicized.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ italic?: boolean;
+ /**
+ * Specifies the 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. Returns `null` if the `TextRange` contains text fragments with different font names.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ name?: boolean;
+ /**
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ size?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Small Caps** attribute.
+ *
+ * - `false`: None of the text has the **Small Caps** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ smallCaps?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Strikethrough** attribute.
+ *
+ * - `false`: None of the text has the **Strikethrough** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ strikethrough?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Subscript** attribute.
+ *
+ * - `false`: None of the text has the **Subscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ subscript?: boolean;
+ /**
+ * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
+ *
+ * - `true`: All the text has the **Superscript** attribute.
+ *
+ * - `false`: None of the text has the **Superscript** attribute.
+ *
+ * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ superscript?: boolean;
+ /**
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ underline?: boolean;
}
/**
- * Represents a collection of hyperlinks.
+ * Represents a table.
*
* @remarks
- * [Api set: PowerPointApi 1.6]
+ * [Api set: PowerPointApi 1.8]
*/
- interface HyperlinkCollectionLoadOptions {
+ interface TableCellLoadOptions {
/**
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.
+ * Gets the number of table columns this cell spans across.
+ Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi 1.6]
+ * [Api set: PowerPointApi 1.8]
*/
- address?: boolean;
+ columnCount?: boolean;
/**
- * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.
+ * Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi 1.6]
- */
- screenTip?: boolean;
- }
- /**
- * Represents the fill formatting of a shape object.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- 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`).
+ * [Api set: PowerPointApi 1.8]
*/
- $all?: boolean;
+ columnIndex?: 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").
+ * Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- foregroundColor?: boolean;
+ rowCount?: 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.
+ * Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- transparency?: boolean;
+ rowIndex?: boolean;
/**
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
+ * Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- type?: boolean;
+ text?: boolean;
}
/**
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
+ * Represents a collection of table cells.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- interface ShapeFontLoadOptions {
+ interface TableCellCollectionLoadOptions {
/**
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 whether the text in the `TextRange` is set to bold. The possible values are as follows:
- *
- * - `true`: All the text is bold.
- *
- * - `false`: None of the text is bold.
- *
- * - `null`: Returned if some, but not all, of the text is bold.
+ * For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
+ Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- bold?: boolean;
+ columnCount?: boolean;
/**
- * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
+ * For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- color?: boolean;
+ columnIndex?: boolean;
/**
- * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- *
- * - `true`: All the text is italicized.
+ * For EACH ITEM in the collection: Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
*
- * - `false`: None of the text is italicized.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowCount?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table.
*
- * - `null`: Returned if some, but not all, of the text is italicized.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ rowIndex?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- italic?: boolean;
+ text?: boolean;
+ }
+ /**
+ * Represents a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface TableLoadOptions {
/**
- * Specifies the 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. Returns `null` if the `TextRange` contains text fragments with different font names.
+ 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 number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- name?: boolean;
+ columnCount?: boolean;
/**
- * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
+ * Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- size?: boolean;
+ rowCount?: boolean;
/**
- * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+ * Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- underline?: boolean;
+ values?: boolean;
}
/**
* Represents the collection of shapes.
@@ -130460,6 +132715,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -130467,6 +132730,22 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -130495,6 +132774,19 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: boolean;
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -130523,6 +132815,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: boolean;
}
/**
* Represents the layout of a slide.
@@ -130549,6 +132849,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+ /**
+ * Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: boolean;
}
/**
* Represents the collection of layouts provided by the Slide Master for slides.
@@ -130575,6 +132882,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
name?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the type of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: boolean;
}
/**
* Represents the Slide Master of a slide.
@@ -130686,6 +133000,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+ /**
+ * Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: boolean;
}
/**
* Represents a collection of shapes.
@@ -130705,6 +133026,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
* For EACH ITEM in the collection: Returns the line formatting of this shape.
*
@@ -130712,6 +133041,22 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.5]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* For EACH ITEM in the collection: Returns the text frame object of this shape.
*
@@ -130740,6 +133085,19 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
left?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: boolean;
/**
* For EACH ITEM in the collection: Specifies the name of this shape.
*
@@ -130768,6 +133126,40 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: boolean;
+ }
+ /**
+ * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface ShapeGroupLoadOptions {
+ /**
+ 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 `Shape` object associated with the group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ shape?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * Gets the unique ID of the shape group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: boolean;
}
/**
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
@@ -131010,6 +133402,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+ /**
+ * Returns the `ShapeGroup` associated with the shape.
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
* Returns the line formatting of this shape.
*
@@ -131017,6 +133417,22 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
+ /**
+ * Returns the parent group of this shape.
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * Returns the properties that apply specifically to this placeholder.
+ If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* Returns the text frame object of this shape.
*
@@ -131046,6 +133462,19 @@ declare namespace PowerPoint {
*/
left?: boolean;
/**
+ * Returns the level of the specified shape.
+
+ - A level of 0 means the shape isn't part of a group.
+
+ - A level of 1 means the shape is part of a top-level group.
+
+ - A level greater than 1 indicates the shape is a nested group.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ level?: boolean;
+ /**
* Specifies the name of this shape.
*
* @remarks
@@ -131073,6 +133502,66 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
width?: boolean;
+ /**
+ * Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
+ each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ zOrderPosition?: boolean;
+ }
+ /**
+ * Represents an Office.js binding that is defined in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface BindingLoadOptions {
+ /**
+ 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 binding identifier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: boolean;
+ /**
+ * Returns the type of the binding. See `BindingType` for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents the collection of all the binding objects that are part of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ interface BindingCollectionLoadOptions {
+ /**
+ 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: Represents the binding identifier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ id?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ type?: boolean;
}
/**
* Represents a custom property.
@@ -131263,6 +133752,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: boolean;
}
/**
* Represents a collection of slides in the presentation.
@@ -131296,6 +133792,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.2]
*/
id?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ index?: boolean;
}
/**
* Represents the collection of Slide Masters in the presentation.
diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts
index fd03d834cf..3216dfd320 100644
--- a/generate-docs/script-inputs/office_preview.d.ts
+++ b/generate-docs/script-inputs/office_preview.d.ts
@@ -133419,8 +133419,7 @@ declare namespace PowerPoint {
* Returns a collection of bindings that are associated with the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly bindings: PowerPoint.BindingCollection;
/**
@@ -133576,15 +133575,13 @@ declare namespace PowerPoint {
* Represents the possible binding types.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum BindingType {
/**
* Represents a shape binding.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
shape = "Shape",
}
@@ -133827,148 +133824,127 @@ declare namespace PowerPoint {
* Specifies the type of a placeholder.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum PlaceholderType {
/**
* The placeholder is unsupported.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
unsupported = "Unsupported",
/**
* The placeholder is for a date.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
date = "Date",
/**
* The placeholder is for a slide number.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
slideNumber = "SlideNumber",
/**
* The placeholder is for a footer.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
footer = "Footer",
/**
* The placeholder is for a header.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
header = "Header",
/**
* The placeholder is for a title.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
title = "Title",
/**
* The placeholder is for a body.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
body = "Body",
/**
* The placeholder is for a center title.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
centerTitle = "CenterTitle",
/**
* The placeholder is for a subtitle.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subtitle = "Subtitle",
/**
* The placeholder is for a vertical title.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalTitle = "VerticalTitle",
/**
* The placeholder is for a vertical body.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalBody = "VerticalBody",
/**
* The placeholder is for generic content.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
content = "Content",
/**
* The placeholder is for a chart.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
chart = "Chart",
/**
* The placeholder is for a table.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
table = "Table",
/**
* The placeholder is for an online picture.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
onlinePicture = "OnlinePicture",
/**
* The placeholder is for a SmartArt.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smartArt = "SmartArt",
/**
* The placeholder is for media.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
media = "Media",
/**
* The placeholder is for generic vertical content.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalContent = "VerticalContent",
/**
* The placeholder is for a picture.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
picture = "Picture",
/**
* The placeholder is for a cameo.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
cameo = "Cameo",
}
@@ -134098,8 +134074,7 @@ declare namespace PowerPoint {
* Represents the properties of a `placeholder` shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
class PlaceholderFormat extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -134109,16 +134084,14 @@ declare namespace PowerPoint {
Returns `null` if the placeholder is empty.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
/**
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
/**
@@ -135604,8 +135577,7 @@ declare namespace PowerPoint {
* Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param base64EncodedImage A string that is a Base64 encoding of the image data.
*/
@@ -135775,8 +135747,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps: boolean | null;
/**
@@ -135809,8 +135780,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough: boolean | null;
/**
@@ -135850,8 +135820,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps: boolean | null;
/**
@@ -135864,8 +135833,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough: boolean | null;
/**
@@ -135878,8 +135846,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript: boolean | null;
/**
@@ -135892,8 +135859,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript: boolean | null;
/**
@@ -135934,104 +135900,91 @@ declare namespace PowerPoint {
* Represents the font attributes, such as font name, size, and color.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface FontProperties {
/**
* Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean | undefined;
/**
* Represents the bold status of font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bold?: boolean | undefined;
/**
* Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
color?: string | undefined;
/**
* Represents the double-strikethrough status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean | undefined;
/**
* Represents the italic status of font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
italic?: boolean | undefined;
/**
* Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
name?: string | undefined;
/**
* Represents the font size in points (e.g., 11).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
size?: number | undefined;
/**
* Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean | undefined;
/**
* Represents the strikethrough status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean | undefined;
/**
* Represents the subscript status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean | undefined;
/**
* Represents the superscript status of the font.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean | undefined;
/**
* Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;
}
@@ -136039,24 +135992,21 @@ declare namespace PowerPoint {
* Represents a sequence of one or more characters with the same font attributes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TextRun {
/**
* The font attributes (such as font name, font size, and color) applied to this text run.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
font?: PowerPoint.FontProperties;
/**
* The text of this text run.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text: string;
}
@@ -136110,8 +136060,7 @@ declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
class TableCell extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -136121,16 +136070,14 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly columnCount: number;
/**
* Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly columnIndex: number;
/**
@@ -136138,24 +136085,21 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly rowCount: number;
/**
* Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly rowIndex: number;
/**
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text: string;
/**
@@ -136189,8 +136133,7 @@ declare namespace PowerPoint {
* Represents a collection of table cells.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
class TableCellCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -136201,8 +136144,7 @@ declare namespace PowerPoint {
* Gets the number of table cells in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
* @returns The number of table cells in the collection.
*/
getCount(): OfficeExtension.ClientResult;
@@ -136210,8 +136152,7 @@ declare namespace PowerPoint {
* Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](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 BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param row Row index value of the table cell to be retrieved, as a zero-based index.
* @param column Column index value of the table cell to be retrieved, as a zero-based index.
@@ -136246,24 +136187,21 @@ declare namespace PowerPoint {
* Represents the fill formatting of a table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface FillProperties {
/**
* Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
color?: string | undefined;
/**
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
transparency?: number | undefined;
}
@@ -136271,40 +136209,35 @@ declare namespace PowerPoint {
* Represents the properties for a table cell border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface BorderProperties {
/**
* Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
color?: string | undefined;
/**
* Represents the dash style of the line.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
/**
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
transparency?: number | undefined;
/**
* Represents the weight of the line, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
weight?: number | undefined;
}
@@ -136312,56 +136245,49 @@ declare namespace PowerPoint {
* Represents the borders of a table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableCellBorders {
/**
* Represents the bottom border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bottom?: PowerPoint.BorderProperties;
/**
* Represents the diagonal border (top-left to bottom-right).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
diagonalDown?: PowerPoint.BorderProperties;
/**
* Represents the diagonal border (bottom-left to top-right).
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
diagonalUp?: PowerPoint.BorderProperties;
/**
* Represents the left border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
left?: PowerPoint.BorderProperties;
/**
* Represents the right border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
right?: PowerPoint.BorderProperties;
/**
* Represents the top border.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
top?: PowerPoint.BorderProperties;
}
@@ -136369,40 +136295,35 @@ declare namespace PowerPoint {
* Represents the margins of a table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableCellMargins {
/**
* Specifies the bottom margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bottom?: number | undefined;
/**
* Specifies the left margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
left?: number | undefined;
/**
* Specifies the right margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
right?: number | undefined;
/**
* Specifies the top margin in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
top?: number | undefined;
}
@@ -136410,56 +136331,49 @@ declare namespace PowerPoint {
* Represents the table cell properties to update.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableCellProperties {
/**
* Specifies the border formatting of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
borders?: PowerPoint.TableCellBorders;
/**
* Specifies the fill formatting of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
fill?: PowerPoint.FillProperties;
/**
* Specifies the font formatting of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
font?: PowerPoint.FontProperties;
/**
* Represents the horizontal alignment of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
/**
* Represents the indent level of the text in the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
indentLevel?: number | undefined;
/**
* Specifies the margin settings in the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
margins?: PowerPoint.TableCellMargins;
/**
@@ -136468,8 +136382,7 @@ declare namespace PowerPoint {
If a portion of the text requires different formatting, use the `textRuns` property instead.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: string;
/**
@@ -136477,16 +136390,14 @@ declare namespace PowerPoint {
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textRuns?: PowerPoint.TextRun[];
/**
* Represents the vertical alignment of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
}
@@ -136494,8 +136405,7 @@ declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
class Table extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -136504,32 +136414,28 @@ declare namespace PowerPoint {
* Gets the number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly columnCount: number;
/**
* Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly rowCount: number;
/**
* Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly values: string[][];
/**
* Gets the cell at the specified `rowIndex` and `columnIndex`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param rowIndex The zero-based row index of the cell.
* @param columnIndex The zero-based column index of the cell.
@@ -136540,8 +136446,7 @@ declare namespace PowerPoint {
* Gets a collection of cells that represent the merged areas of the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
* @returns a `TableCellCollection` with cells that represent the merged areas of the table.
*/
getMergedAreas(): PowerPoint.TableCellCollection;
@@ -136549,8 +136454,7 @@ declare namespace PowerPoint {
* Gets the shape object for the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getShape(): PowerPoint.Shape;
/**
@@ -136584,8 +136488,7 @@ declare namespace PowerPoint {
* Provides the table column properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableColumnProperties {
/**
@@ -136597,8 +136500,7 @@ declare namespace PowerPoint {
a default column width will be used.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnWidth?: number | undefined;
}
@@ -136606,8 +136508,7 @@ declare namespace PowerPoint {
* Represents the properties of a merged area of cells in a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableMergedAreaProperties {
/**
@@ -136615,16 +136516,14 @@ declare namespace PowerPoint {
Must be 1 or greater.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount: number;
/**
* Specifies the zero-based index of the column of the top left cell of the merged area.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex: number;
/**
@@ -136632,16 +136531,14 @@ declare namespace PowerPoint {
Must be 1 or greater.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount: number;
/**
* Specifies the zero-based index of the row of the top left cell of the merged area.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex: number;
}
@@ -136649,8 +136546,7 @@ declare namespace PowerPoint {
* Provides the table row properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableRowProperties {
/**
@@ -136662,8 +136558,7 @@ declare namespace PowerPoint {
a default row height will be used.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowHeight?: number | undefined;
}
@@ -136671,8 +136566,7 @@ declare namespace PowerPoint {
* Represents the available options when adding a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableAddOptions {
/**
@@ -136681,8 +136575,7 @@ declare namespace PowerPoint {
Specify an empty object for columns that should use the default formatting.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columns?: PowerPoint.TableColumnProperties[];
/**
@@ -136691,8 +136584,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a negative value.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
height?: number | undefined;
/**
@@ -136700,16 +136592,14 @@ declare namespace PowerPoint {
The table is centered horizontally when this parameter is not provided.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
left?: number | undefined;
/**
* If specified, represents an rectangular area where multiple cells appear as a single cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
mergedAreas?: PowerPoint.TableMergedAreaProperties[];
/**
@@ -136718,8 +136608,7 @@ declare namespace PowerPoint {
Specify an empty object for rows that should use the default formatting.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rows?: PowerPoint.TableRowProperties[];
/**
@@ -136731,8 +136620,7 @@ declare namespace PowerPoint {
to the entire merged area. For the other cells in the merged area, an empty object should be provided.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
specificCellProperties?: PowerPoint.TableCellProperties[][];
/**
@@ -136740,8 +136628,7 @@ declare namespace PowerPoint {
A default value is used when this parameter is not provided.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
top?: number | undefined;
/**
@@ -136757,8 +136644,7 @@ declare namespace PowerPoint {
and do not specify specificCellProperties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
uniformCellProperties?: PowerPoint.TableCellProperties;
/**
@@ -136770,8 +136656,7 @@ declare namespace PowerPoint {
in the merged area must be an empty string.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
values?: string[][];
/**
@@ -136780,8 +136665,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a negative value.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
width?: number | undefined;
}
@@ -136822,8 +136706,7 @@ declare namespace PowerPoint {
* Create a shape group for several shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param values An array of shape IDs or `Shape` objects.
* @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group.
@@ -136856,8 +136739,7 @@ declare namespace PowerPoint {
Use the `Shape.table` property to get the `Table` object for the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param rowCount Number of rows in the table. Must be 1 or greater.
* @param columnCount Number of columns in the table. Must be 1 or greater.
@@ -136942,24 +136824,21 @@ declare namespace PowerPoint {
* Represents the available options when getting an image of a slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface SlideGetImageOptions {
/**
* The desired height of the resulting image in pixels.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
height?: number;
/**
* The desired width of the resulting image in pixels.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
width?: number;
}
@@ -136967,267 +136846,229 @@ declare namespace PowerPoint {
* Specifies the type of a slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum SlideLayoutType {
/**
* Blank layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
blank = "Blank",
/**
* Chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
chart = "Chart",
/**
* Chart and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
chartAndText = "ChartAndText",
/**
* ClipArt and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
clipArtAndText = "ClipArtAndText",
/**
* ClipArt and vertical text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
clipArtAndVerticalText = "ClipArtAndVerticalText",
/**
* Comparison layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
comparison = "Comparison",
/**
* Content with caption layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
contentWithCaption = "ContentWithCaption",
/**
* Custom layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
custom = "Custom",
/**
* Four objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
fourObjects = "FourObjects",
/**
* Large object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
largeObject = "LargeObject",
/**
* MediaClip and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
mediaClipAndText = "MediaClipAndText",
/**
* Mixed layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
mixed = "Mixed",
/**
* Object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
object = "Object",
/**
* Object and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
objectAndText = "ObjectAndText",
/**
* Object and two objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
objectAndTwoObjects = "ObjectAndTwoObjects",
/**
* Object over text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
objectOverText = "ObjectOverText",
/**
* Organization chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
organizationChart = "OrganizationChart",
/**
* Picture with caption layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
pictureWithCaption = "PictureWithCaption",
/**
* Section header layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
sectionHeader = "SectionHeader",
/**
* Table layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
table = "Table",
/**
* Text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text = "Text",
/**
* Text and chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndChart = "TextAndChart",
/**
* Text and ClipArt layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndClipArt = "TextAndClipArt",
/**
* Text and MediaClip layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndMediaClip = "TextAndMediaClip",
/**
* Text and object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndObject = "TextAndObject",
/**
* Text and two objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textAndTwoObjects = "TextAndTwoObjects",
/**
* Text over object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
textOverObject = "TextOverObject",
/**
* Title layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
title = "Title",
/**
* Title only layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
titleOnly = "TitleOnly",
/**
* Two-column text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoColumnText = "TwoColumnText",
/**
* Two objects layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjects = "TwoObjects",
/**
* Two objects and object layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjectsAndObject = "TwoObjectsAndObject",
/**
* Two objects and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjectsAndText = "TwoObjectsAndText",
/**
* Two objects over text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
twoObjectsOverText = "TwoObjectsOverText",
/**
* Vertical text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalText = "VerticalText",
/**
* Vertical title and text layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalTitleAndText = "VerticalTitleAndText",
/**
* Vertical title and text over chart layout.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
}
@@ -137272,8 +137113,7 @@ declare namespace PowerPoint {
* Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
/**
@@ -137652,16 +137492,14 @@ declare namespace PowerPoint {
* Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly index: number;
/**
* Applies the specified layout to the slide, changing its design and structure according to the chosen layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param slideLayout The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master.
*/
@@ -137677,8 +137515,7 @@ declare namespace PowerPoint {
* Exports the slide to its own presentation file, returned as Base64-encoded data.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
exportAsBase64(): OfficeExtension.ClientResult;
/**
@@ -137687,19 +137524,17 @@ declare namespace PowerPoint {
of either width or height is specified, the other will be calculated to preserve aspect ratio.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param options Optional. Options to specify the desired size of the slide image.
- * @returns A base64 string of the slide image in PNG format.
+ * @returns A Base64 string of the slide image in PNG format.
*/
getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult;
/**
* Moves the slide to a new position within the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param slideIndex The zero-based index where the slide should be moved.
*/
@@ -137794,8 +137629,7 @@ declare namespace PowerPoint {
If the collection contains fewer than two shapes, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
* @returns The newly created grouped shape as a {@link PowerPoint.Shape}.
*/
group(): PowerPoint.Shape;
@@ -137827,8 +137661,7 @@ declare namespace PowerPoint {
* Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
class ShapeGroup extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -137837,32 +137670,28 @@ declare namespace PowerPoint {
* Returns the `Shape` object associated with the group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly shape: PowerPoint.Shape;
/**
* Returns the collection of `Shape` objects in the group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly shapes: PowerPoint.ShapeScopedCollection;
/**
* Gets the unique ID of the shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly id: string;
/**
* Ungroups any grouped shapes in the specified shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
ungroup(): void;
/**
@@ -138347,36 +138176,31 @@ declare namespace PowerPoint {
* Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
enum ShapeZOrder {
/**
* Brings the shape forward one spot in the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bringForward = "BringForward",
/**
* Brings the shape to the front of the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
bringToFront = "BringToFront",
/**
* Sends the shape backward one spot in the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
sendBackward = "SendBackward",
/**
* Sends the shape to the back of the z-order.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
sendToBack = "SendToBack",
}
@@ -138408,8 +138232,7 @@ declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly group: PowerPoint.ShapeGroup;
/**
@@ -138424,8 +138247,7 @@ declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly parentGroup: PowerPoint.Shape;
/**
@@ -138433,8 +138255,7 @@ declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly placeholderFormat: PowerPoint.PlaceholderFormat;
/**
@@ -138482,8 +138303,7 @@ declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly level: number;
/**
@@ -138519,8 +138339,7 @@ declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly zOrderPosition: number;
/**
@@ -138576,16 +138395,14 @@ declare namespace PowerPoint {
* Returns the `Table` object if this shape is a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getTable(): PowerPoint.Table;
/**
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
*/
@@ -138594,8 +138411,7 @@ declare namespace PowerPoint {
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
*/
@@ -138631,8 +138447,7 @@ declare namespace PowerPoint {
* Represents an Office.js binding that is defined in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
class Binding extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -138641,32 +138456,28 @@ declare namespace PowerPoint {
* Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly id: string;
/**
* Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
readonly type: PowerPoint.BindingType | "Shape";
/**
* Deletes the binding.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
delete(): void;
/**
* Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getShape(): PowerPoint.Shape;
/**
@@ -138700,8 +138511,7 @@ declare namespace PowerPoint {
* Represents the collection of all the binding objects that are part of the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
class BindingCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -138712,8 +138522,7 @@ declare namespace PowerPoint {
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param shape Shape to which the binding is added.
* @param bindingType Type of binding. See `BindingType`.
@@ -138724,8 +138533,7 @@ declare namespace PowerPoint {
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param shape Shape to which the binding is added.
* @param bindingType Type of binding. See `BindingType`.
@@ -138737,8 +138545,7 @@ declare namespace PowerPoint {
If the selection has multiple areas, the `InvalidReference` error will be returned.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param bindingType Type of binding. See `BindingType`.
* @param id ID of the binding.
@@ -138749,8 +138556,7 @@ declare namespace PowerPoint {
If the selection has multiple areas, the `InvalidReference` error will be returned.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param bindingType Type of binding. See `BindingType`.
* @param id ID of the binding.
@@ -138760,16 +138566,14 @@ declare namespace PowerPoint {
* Gets the number of bindings in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
getCount(): OfficeExtension.ClientResult;
/**
* Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param key ID of the binding object to be retrieved.
*/
@@ -138778,8 +138582,7 @@ declare namespace PowerPoint {
* Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param index Index value of the object to be retrieved. Zero-indexed.
*/
@@ -138789,8 +138592,7 @@ declare namespace PowerPoint {
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 BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*
* @param id ID of the binding object to be retrieved.
*/
@@ -139374,7 +139176,7 @@ declare namespace PowerPoint {
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}."
+ 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]
@@ -139482,8 +139284,7 @@ declare namespace PowerPoint {
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean | null;
/**
@@ -139516,8 +139317,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean | null;
/**
@@ -139557,8 +139357,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean | null;
/**
@@ -139571,8 +139370,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean | null;
/**
@@ -139585,8 +139383,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean | null;
/**
@@ -139599,8 +139396,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean | null;
/**
@@ -139617,8 +139413,7 @@ declare namespace PowerPoint {
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: string;
}
@@ -139973,16 +139768,14 @@ declare namespace PowerPoint {
Returns `null` if the placeholder is empty.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
/**
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
}
@@ -140043,8 +139836,7 @@ declare namespace PowerPoint {
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean | null;
/**
@@ -140077,8 +139869,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean | null;
/**
@@ -140118,8 +139909,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean | null;
/**
@@ -140132,8 +139922,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean | null;
/**
@@ -140146,8 +139935,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean | null;
/**
@@ -140160,8 +139948,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean | null;
/**
@@ -140179,16 +139966,14 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: number;
/**
* Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex?: number;
/**
@@ -140196,24 +139981,21 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: number;
/**
* Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex?: number;
/**
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: string;
}
@@ -140227,24 +140009,21 @@ declare namespace PowerPoint {
* Gets the number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: number;
/**
* Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: number;
/**
* Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
values?: string[][];
}
@@ -140272,8 +140051,7 @@ declare namespace PowerPoint {
* Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
}
@@ -140332,8 +140110,7 @@ declare namespace PowerPoint {
* Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: number;
}
@@ -140347,8 +140124,7 @@ declare namespace PowerPoint {
* Gets the unique ID of the shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: string;
}
@@ -140535,8 +140311,7 @@ declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: number;
/**
@@ -140572,8 +140347,7 @@ declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: number;
}
@@ -140583,16 +140357,14 @@ declare namespace PowerPoint {
* Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: string;
/**
* Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: PowerPoint.BindingType | "Shape";
}
@@ -140830,8 +140602,7 @@ declare namespace PowerPoint {
* Represents the properties of a `placeholder` shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface PlaceholderFormatLoadOptions {
/**
@@ -140843,16 +140614,14 @@ declare namespace PowerPoint {
Returns `null` if the placeholder is empty.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
containedType?: boolean;
/**
* Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -140962,8 +140731,7 @@ declare namespace PowerPoint {
* - `null`: Some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
allCaps?: boolean;
/**
@@ -140996,8 +140764,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
doubleStrikethrough?: boolean;
/**
@@ -141037,8 +140804,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
smallCaps?: boolean;
/**
@@ -141051,8 +140817,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
strikethrough?: boolean;
/**
@@ -141065,8 +140830,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
subscript?: boolean;
/**
@@ -141079,8 +140843,7 @@ declare namespace PowerPoint {
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
superscript?: boolean;
/**
@@ -141095,8 +140858,7 @@ declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableCellLoadOptions {
/**
@@ -141108,16 +140870,14 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: boolean;
/**
* Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex?: boolean;
/**
@@ -141125,24 +140885,21 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: boolean;
/**
* Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex?: boolean;
/**
* Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: boolean;
}
@@ -141150,8 +140907,7 @@ declare namespace PowerPoint {
* Represents a collection of table cells.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableCellCollectionLoadOptions {
/**
@@ -141163,16 +140919,14 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: boolean;
/**
* For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnIndex?: boolean;
/**
@@ -141180,24 +140934,21 @@ declare namespace PowerPoint {
Will be greater than or equal to 1.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: boolean;
/**
* For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowIndex?: boolean;
/**
* For EACH ITEM in the collection: Specifies the text content of the table cell.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
text?: boolean;
}
@@ -141205,8 +140956,7 @@ declare namespace PowerPoint {
* Represents a table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface TableLoadOptions {
/**
@@ -141217,24 +140967,21 @@ declare namespace PowerPoint {
* Gets the number of columns in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
columnCount?: boolean;
/**
* Gets the number of rows in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
rowCount?: boolean;
/**
* Gets all of the values in the table.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
values?: boolean;
}
@@ -141261,8 +141008,7 @@ declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
@@ -141277,8 +141023,7 @@ declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
@@ -141286,8 +141031,7 @@ declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
@@ -141328,8 +141072,7 @@ declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: boolean;
/**
@@ -141365,8 +141108,7 @@ declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: boolean;
}
@@ -141399,8 +141141,7 @@ declare namespace PowerPoint {
* Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -141433,8 +141174,7 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the type of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -141552,8 +141292,7 @@ declare namespace PowerPoint {
* Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: boolean;
}
@@ -141580,8 +141319,7 @@ declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
@@ -141596,8 +141334,7 @@ declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
@@ -141605,8 +141342,7 @@ declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
@@ -141647,8 +141383,7 @@ declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: boolean;
/**
@@ -141684,8 +141419,7 @@ declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: boolean;
}
@@ -141693,8 +141427,7 @@ declare namespace PowerPoint {
* Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface ShapeGroupLoadOptions {
/**
@@ -141705,16 +141438,14 @@ declare namespace PowerPoint {
* Returns the `Shape` object associated with the group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
shape?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
* Gets the unique ID of the shape group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: boolean;
}
@@ -141964,8 +141695,7 @@ declare namespace PowerPoint {
If the shape type isn't `group`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
@@ -141980,8 +141710,7 @@ declare namespace PowerPoint {
If the shape isn't part of a group, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
@@ -141989,8 +141718,7 @@ declare namespace PowerPoint {
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
@@ -142031,8 +141759,7 @@ declare namespace PowerPoint {
- A level greater than 1 indicates the shape is a nested group.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
level?: boolean;
/**
@@ -142068,8 +141795,7 @@ declare namespace PowerPoint {
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
zOrderPosition?: boolean;
}
@@ -142077,8 +141803,7 @@ declare namespace PowerPoint {
* Represents an Office.js binding that is defined in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface BindingLoadOptions {
/**
@@ -142089,16 +141814,14 @@ declare namespace PowerPoint {
* Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: boolean;
/**
* Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -142106,8 +141829,7 @@ declare namespace PowerPoint {
* Represents the collection of all the binding objects that are part of the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
interface BindingCollectionLoadOptions {
/**
@@ -142118,16 +141840,14 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Represents the binding identifier.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
id?: boolean;
/**
* For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
type?: boolean;
}
@@ -142324,8 +142044,7 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: boolean;
}
@@ -142365,8 +142084,7 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.8]
*/
index?: boolean;
}
diff --git a/generate-docs/scripts/midprocessor.ts b/generate-docs/scripts/midprocessor.ts
index 1ca08f5ecb..b4b765b792 100644
--- a/generate-docs/scripts/midprocessor.ts
+++ b/generate-docs/scripts/midprocessor.ts
@@ -8,7 +8,7 @@ const CURRENT_EXCEL_RELEASE = 18;
const OLDEST_EXCEL_RELEASE_WITH_CUSTOM_FUNCTIONS = 9;
const CURRENT_OUTLOOK_RELEASE = 15;
const CURRENT_WORD_RELEASE = 9;
-const CURRENT_POWERPOINT_RELEASE = 7;
+const CURRENT_POWERPOINT_RELEASE = 8;
tryCatch(async () => {
// ----
diff --git a/generate-docs/scripts/postprocessor.ts b/generate-docs/scripts/postprocessor.ts
index 1ff6efe7cd..4f85417910 100644
--- a/generate-docs/scripts/postprocessor.ts
+++ b/generate-docs/scripts/postprocessor.ts
@@ -158,7 +158,7 @@ tryCatch(async () => {
const hostVersionMap = [{host: "excel", versions: 19}, /*not including online*/
{host: "onenote", versions: 1},
{host: "outlook", versions: 16},
- {host: "powerpoint", versions: 8},
+ {host: "powerpoint", versions: 9},
{host: "visio", versions: 1},
{host: "word", versions: 10}]; /* not including online or desktop*/
diff --git a/generate-docs/scripts/preprocessor.ts b/generate-docs/scripts/preprocessor.ts
index 5129de2d42..d6afbb7031 100644
--- a/generate-docs/scripts/preprocessor.ts
+++ b/generate-docs/scripts/preprocessor.ts
@@ -159,7 +159,7 @@ tryCatch(async () => {
console.log("create file: powerpoint.d.ts (release)");
makeDtsAndClearJsonIfNew(
- '../api-extractor-inputs-powerpoint-release/PowerPoint_1_7/powerpoint.d.ts',
+ '../api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts',
handleCommonImports(handleLiteralParameterOverloads(dtsBuilder.extractDtsSection(releaseDefinitions, "Begin PowerPoint APIs", "End PowerPoint APIs")), "Other", true),
"powerpoint",
forceRebuild