diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json
index e4faa208a4..2044de385c 100644
--- a/.openpublishing.publish.config.json
+++ b/.openpublishing.publish.config.json
@@ -59,6 +59,7 @@
"powerpoint-js-1.7",
"powerpoint-js-1.8",
"powerpoint-js-1.9",
+ "powerpoint-js-1.10",
"visio-js-1.1",
"word-js-preview",
"word-js-1.1",
@@ -339,6 +340,10 @@
"ReferenceTOC": "docs/docs-ref-autogen/powerpoint_1_9/toc.yml",
"ConceptualTOCUrl": "/office/dev/add-ins/toc.json"
},
+ {
+ "ReferenceTOC": "docs/docs-ref-autogen/powerpoint_1_10/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 cf1e2ccd61..ab2d2591b8 100644
--- a/docs/docfx.json
+++ b/docs/docfx.json
@@ -714,6 +714,18 @@
"src": "docs-ref-autogen/powerpoint_1_9",
"dest": "api"
},
+ {
+ "files": ["**/toc.yml"],
+ "group": "powerpoint-js-1.10",
+ "src": "docs-ref-autogen/powerpoint_1_10",
+ "dest": "api/office-js-docs-reference"
+ },
+ {
+ "files": ["**/*.md", "**/*.yml"],
+ "group": "powerpoint-js-1.10",
+ "src": "docs-ref-autogen/powerpoint_1_10",
+ "dest": "api"
+ },
{
"files": ["**/toc.yml"],
"group": "visio-js-1.1",
@@ -1157,6 +1169,10 @@
"dest": "powerpoint-js-1.9",
"moniker_range": "powerpoint-js-1.9"
},
+ "powerpoint-js-1.10": {
+ "dest": "powerpoint-js-1.10",
+ "moniker_range": "powerpoint-js-1.10"
+ },
"visio-js-1.1": {
"dest": "visio-js-1.1",
"moniker_range": "visio-js-1.1"
diff --git a/docs/docs-ref-autogen/common/toc.yml b/docs/docs-ref-autogen/common/toc.yml
index 3e8bd8470c..6ae84e0467 100644
--- a/docs/docs-ref-autogen/common/toc.yml
+++ b/docs/docs-ref-autogen/common/toc.yml
@@ -846,6 +846,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/common_preview/toc.yml b/docs/docs-ref-autogen/common_preview/toc.yml
index 3e8bd8470c..6ae84e0467 100644
--- a/docs/docs-ref-autogen/common_preview/toc.yml
+++ b/docs/docs-ref-autogen/common_preview/toc.yml
@@ -846,6 +846,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml
index 8538a1d1bf..d64fc04080 100644
--- a/docs/docs-ref-autogen/excel/toc.yml
+++ b/docs/docs-ref-autogen/excel/toc.yml
@@ -2062,6 +2062,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 b1dce8ecd6..02672201e1 100644
--- a/docs/docs-ref-autogen/excel_1_1/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_1/toc.yml
@@ -988,6 +988,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 127c36f0f7..6b7daad97e 100644
--- a/docs/docs-ref-autogen/excel_1_10/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_10/toc.yml
@@ -1672,6 +1672,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 e09d5ad9a5..2011e27e36 100644
--- a/docs/docs-ref-autogen/excel_1_11/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_11/toc.yml
@@ -1684,6 +1684,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 c03029882e..42ce7a3565 100644
--- a/docs/docs-ref-autogen/excel_1_12/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_12/toc.yml
@@ -1730,6 +1730,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 dee44f0afe..db201c9be2 100644
--- a/docs/docs-ref-autogen/excel_1_13/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_13/toc.yml
@@ -1740,6 +1740,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 19ae2399a4..39669c1519 100644
--- a/docs/docs-ref-autogen/excel_1_14/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_14/toc.yml
@@ -1758,6 +1758,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 cde25ed693..3d511559b7 100644
--- a/docs/docs-ref-autogen/excel_1_15/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_15/toc.yml
@@ -1762,6 +1762,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 a94985c454..cd14670a36 100644
--- a/docs/docs-ref-autogen/excel_1_16/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_16/toc.yml
@@ -1892,6 +1892,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 e42af177db..983e836ca1 100644
--- a/docs/docs-ref-autogen/excel_1_17/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_17/toc.yml
@@ -1898,6 +1898,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 53ef40130e..db187df96c 100644
--- a/docs/docs-ref-autogen/excel_1_18/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_18/toc.yml
@@ -1916,6 +1916,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel_1_19/toc.yml b/docs/docs-ref-autogen/excel_1_19/toc.yml
index acc386342e..7cecee09ed 100644
--- a/docs/docs-ref-autogen/excel_1_19/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_19/toc.yml
@@ -1960,6 +1960,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 175d147796..6f4cb60a40 100644
--- a/docs/docs-ref-autogen/excel_1_2/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_2/toc.yml
@@ -1085,6 +1085,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel_1_20/toc.yml b/docs/docs-ref-autogen/excel_1_20/toc.yml
index 554360f842..0e738e8598 100644
--- a/docs/docs-ref-autogen/excel_1_20/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_20/toc.yml
@@ -1964,6 +1964,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 a795aa7386..bd61d40b42 100644
--- a/docs/docs-ref-autogen/excel_1_3/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_3/toc.yml
@@ -1093,6 +1093,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 c112af2652..568d027428 100644
--- a/docs/docs-ref-autogen/excel_1_4/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_4/toc.yml
@@ -1101,6 +1101,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 888dda3227..82420824f8 100644
--- a/docs/docs-ref-autogen/excel_1_5/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_5/toc.yml
@@ -1109,6 +1109,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 bfb099866e..01414187f3 100644
--- a/docs/docs-ref-autogen/excel_1_6/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_6/toc.yml
@@ -1191,6 +1191,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 a87fac3a51..b4b4801cab 100644
--- a/docs/docs-ref-autogen/excel_1_7/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_7/toc.yml
@@ -1293,6 +1293,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 0943ca42bd..29820d6675 100644
--- a/docs/docs-ref-autogen/excel_1_8/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_8/toc.yml
@@ -1387,6 +1387,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 bb7732abd8..3e2e120523 100644
--- a/docs/docs-ref-autogen/excel_1_9/toc.yml
+++ b/docs/docs-ref-autogen/excel_1_9/toc.yml
@@ -1628,6 +1628,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml b/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml
index 154624a405..88afc822f7 100644
--- a/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml
+++ b/docs/docs-ref-autogen/excel_desktop_1_1/toc.yml
@@ -1970,6 +1970,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/excel_online/toc.yml b/docs/docs-ref-autogen/excel_online/toc.yml
index 0eddeadeb0..200e84f5aa 100644
--- a/docs/docs-ref-autogen/excel_online/toc.yml
+++ b/docs/docs-ref-autogen/excel_online/toc.yml
@@ -1980,6 +1980,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/onenote/toc.yml b/docs/docs-ref-autogen/onenote/toc.yml
index d21813f928..540c785195 100644
--- a/docs/docs-ref-autogen/onenote/toc.yml
+++ b/docs/docs-ref-autogen/onenote/toc.yml
@@ -950,6 +950,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml
index 59a85cc1c1..7606d10fc1 100644
--- a/docs/docs-ref-autogen/outlook/toc.yml
+++ b/docs/docs-ref-autogen/outlook/toc.yml
@@ -1078,6 +1078,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 ad5cad4dca..fa7d8c6e83 100644
--- a/docs/docs-ref-autogen/outlook_1_1/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml
@@ -924,6 +924,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 de5b363bf7..0a329d6b91 100644
--- a/docs/docs-ref-autogen/outlook_1_10/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml
@@ -1024,6 +1024,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 8936d290bc..c5da2a1fb7 100644
--- a/docs/docs-ref-autogen/outlook_1_11/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml
@@ -1026,6 +1026,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 00b7bbcec2..89e3dff338 100644
--- a/docs/docs-ref-autogen/outlook_1_12/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml
@@ -1028,6 +1028,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 c60b671719..b201278d8d 100644
--- a/docs/docs-ref-autogen/outlook_1_13/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml
@@ -1040,6 +1040,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 edef193045..6dc8a8eb70 100644
--- a/docs/docs-ref-autogen/outlook_1_14/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml
@@ -1054,6 +1054,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 14e8bf276a..2d05b021e8 100644
--- a/docs/docs-ref-autogen/outlook_1_15/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_15/toc.yml
@@ -1060,6 +1060,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 9cc0901141..91a40c0df5 100644
--- a/docs/docs-ref-autogen/outlook_1_2/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml
@@ -926,6 +926,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 0d29cb40fb..1509f01604 100644
--- a/docs/docs-ref-autogen/outlook_1_3/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml
@@ -934,6 +934,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 0d29cb40fb..1509f01604 100644
--- a/docs/docs-ref-autogen/outlook_1_4/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml
@@ -934,6 +934,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 5fde41c402..2f87866741 100644
--- a/docs/docs-ref-autogen/outlook_1_5/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml
@@ -944,6 +944,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 5fde41c402..2f87866741 100644
--- a/docs/docs-ref-autogen/outlook_1_6/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml
@@ -944,6 +944,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 6948f876b6..7a2b3aee0e 100644
--- a/docs/docs-ref-autogen/outlook_1_7/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml
@@ -974,6 +974,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 7cb3873aa9..36a4c5cf02 100644
--- a/docs/docs-ref-autogen/outlook_1_8/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml
@@ -1008,6 +1008,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 7cb3873aa9..36a4c5cf02 100644
--- a/docs/docs-ref-autogen/outlook_1_9/toc.yml
+++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml
@@ -1008,6 +1008,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/overview/overview.md b/docs/docs-ref-autogen/overview/overview.md
index a5e6cb283d..04e59501aa 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: 10/28/2025
+ms.date: 12/16/2025
---
# Office Add-ins JavaScript API reference
@@ -101,6 +101,7 @@ The following is a list of APIs for the [supported Office host applications](/of
PowerPoint APIs
- PowerPointApi Preview
+ - PowerPointApi 1.10
- PowerPointApi 1.9
- PowerPointApi 1.8
- PowerPointApi 1.7
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.adjustments.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.adjustments.yml
index c6d4f764a6..6d6dcb884d 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.adjustments.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.adjustments.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Adjustments
summary: Represents the adjustment values for a shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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: count
summary: Specifies the number of adjustment points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly count: number;'
@@ -53,11 +53,11 @@ methods:
Gets the adjustment value at the specified zero-based index. Throws an
`InvalidArgument` exception when the index is out of range.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'get(index: number): OfficeExtension.ClientResult;'
@@ -77,7 +77,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- 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: 'load(propertyNames?: string | string[]): PowerPoint.Adjustments;'
@@ -124,7 +124,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -155,11 +155,11 @@ methods:
Sets the adjustment value at the specified zero-based index. Throws an
`InvalidArgument` exception when the index is out of range.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'set(index: number, value: number): void;'
@@ -188,7 +188,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.AdjustmentsData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bulletformat.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bulletformat.yml
index 4b14d4952a..af70ca5f1a 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bulletformat.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bulletformat.yml
@@ -80,11 +80,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -146,11 +146,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.bulletstyle.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bulletstyle.yml
index f21159cda6..8c515f3d39 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bulletstyle.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bulletstyle.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.BulletStyle
summary: Specifies the style of a bullet.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: alphabetLowercaseParenthesesBoth
@@ -19,8 +19,8 @@ fields:
Lowercase alphabetical characters with both parentheses.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"AlphabetLowercaseParenthesesBoth"'
- name: alphabetLowercaseParenthesisRight
@@ -30,8 +30,8 @@ fields:
Lowercase alphabetical characters with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"AlphabetLowercaseParenthesisRight"'
- name: alphabetLowercasePeriod
@@ -41,8 +41,8 @@ fields:
Lowercase alphabetical characters with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"AlphabetLowercasePeriod"'
- name: alphabetUppercaseParenthesesBoth
@@ -52,8 +52,8 @@ fields:
Uppercase alphabetical characters with both parentheses.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"AlphabetUppercaseParenthesesBoth"'
- name: alphabetUppercaseParenthesisRight
@@ -63,8 +63,8 @@ fields:
Uppercase alphabetical characters with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"AlphabetUppercaseParenthesisRight"'
- name: alphabetUppercasePeriod
@@ -74,8 +74,8 @@ fields:
Uppercase alphabetical characters with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"AlphabetUppercasePeriod"'
- name: arabicAbjadDash
@@ -85,8 +85,8 @@ fields:
Arabic Abjad alphabet with a dash.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicAbjadDash"'
- name: arabicAlphabetDash
@@ -96,8 +96,8 @@ fields:
Arabic alphabet with a dash.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicAlphabetDash"'
- name: arabicDoubleBytePeriod
@@ -107,8 +107,8 @@ fields:
Double-byte Arabic numbering scheme with double-byte period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicDoubleBytePeriod"'
- name: arabicDoubleBytePlain
@@ -118,8 +118,8 @@ fields:
Double-byte Arabic numbering scheme (no punctuation).
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicDoubleBytePlain"'
- name: arabicNumeralParenthesesBoth
@@ -129,8 +129,8 @@ fields:
Arabic numerals with both parentheses.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicNumeralParenthesesBoth"'
- name: arabicNumeralParenthesisRight
@@ -140,8 +140,8 @@ fields:
Arabic numerals with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicNumeralParenthesisRight"'
- name: arabicNumeralPeriod
@@ -151,8 +151,8 @@ fields:
Arabic numerals with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicNumeralPeriod"'
- name: arabicNumeralPlain
@@ -162,8 +162,8 @@ fields:
Arabic numerals.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ArabicNumeralPlain"'
- name: circleNumberDoubleBytePlain
@@ -173,8 +173,8 @@ fields:
Double-byte circled number for values up to 10.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"CircleNumberDoubleBytePlain"'
- name: circleNumberWideDoubleByteBlackPlain
@@ -185,8 +185,8 @@ fields:
Shadow color number with circular background of normal text color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"CircleNumberWideDoubleByteBlackPlain"'
- name: circleNumberWideDoubleByteWhitePlain
@@ -197,8 +197,8 @@ fields:
Text colored number with same color circle drawn around it.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"CircleNumberWideDoubleByteWhitePlain"'
- name: hebrewAlphabetDash
@@ -208,8 +208,8 @@ fields:
Hebrew alphabet with a dash.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"HebrewAlphabetDash"'
- name: hindiAlphabet1Period
@@ -219,8 +219,8 @@ fields:
Hindi alphabet (consonants) with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"HindiAlphabet1Period"'
- name: hindiAlphabetPeriod
@@ -230,8 +230,8 @@ fields:
Hindi alphabet (vowels) with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"HindiAlphabetPeriod"'
- name: hindiNumeralParenthesisRight
@@ -241,8 +241,8 @@ fields:
Hindi numerals with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"HindiNumeralParenthesisRight"'
- name: hindiNumeralPeriod
@@ -252,8 +252,8 @@ fields:
Hindi numerals with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"HindiNumeralPeriod"'
- name: kanjiKoreanPeriod
@@ -263,8 +263,8 @@ fields:
Japanese/Korean numbers with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"KanjiKoreanPeriod"'
- name: kanjiKoreanPlain
@@ -274,8 +274,8 @@ fields:
Japanese/Korean numbers without a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"KanjiKoreanPlain"'
- name: kanjiSimplifiedChineseDoubleBytePeriod
@@ -286,8 +286,8 @@ fields:
Kanji Simplified Chinese with double-byte period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"KanjiSimplifiedChineseDoubleBytePeriod"'
- name: romanLowercaseParenthesesBoth
@@ -297,8 +297,8 @@ fields:
Lowercase Roman numerals with both parentheses.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"RomanLowercaseParenthesesBoth"'
- name: romanLowercaseParenthesisRight
@@ -308,8 +308,8 @@ fields:
Lowercase Roman numerals with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"RomanLowercaseParenthesisRight"'
- name: romanLowercasePeriod
@@ -319,8 +319,8 @@ fields:
Lowercase Roman numerals with period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"RomanLowercasePeriod"'
- name: romanUppercaseParenthesesBoth
@@ -330,8 +330,8 @@ fields:
Uppercase Roman numerals with both parentheses.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"RomanUppercaseParenthesesBoth"'
- name: romanUppercaseParenthesisRight
@@ -341,8 +341,8 @@ fields:
Uppercase Roman numerals with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"RomanUppercaseParenthesisRight"'
- name: romanUppercasePeriod
@@ -352,8 +352,8 @@ fields:
Uppercase Roman numerals with period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"RomanUppercasePeriod"'
- name: simplifiedChinesePeriod
@@ -363,8 +363,8 @@ fields:
Simplified Chinese with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SimplifiedChinesePeriod"'
- name: simplifiedChinesePlain
@@ -374,8 +374,8 @@ fields:
Simplified Chinese without a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SimplifiedChinesePlain"'
- name: thaiAlphabetParenthesesBoth
@@ -385,8 +385,8 @@ fields:
Thai alphabet with both parentheses.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ThaiAlphabetParenthesesBoth"'
- name: thaiAlphabetParenthesisRight
@@ -396,8 +396,8 @@ fields:
Thai alphabet with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ThaiAlphabetParenthesisRight"'
- name: thaiAlphabetPeriod
@@ -407,8 +407,8 @@ fields:
Thai alphabet with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ThaiAlphabetPeriod"'
- name: thaiNumeralParenthesesBoth
@@ -418,8 +418,8 @@ fields:
Thai numerals with both parentheses.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ThaiNumeralParenthesesBoth"'
- name: thaiNumeralParenthesisRight
@@ -429,8 +429,8 @@ fields:
Thai numerals with closing parenthesis.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ThaiNumeralParenthesisRight"'
- name: thaiNumeralPeriod
@@ -440,8 +440,8 @@ fields:
Thai numerals with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ThaiNumeralPeriod"'
- name: traditionalChinesePeriod
@@ -451,8 +451,8 @@ fields:
Traditional Chinese with a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TraditionalChinesePeriod"'
- name: traditionalChinesePlain
@@ -462,8 +462,8 @@ fields:
Traditional Chinese without a period.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TraditionalChinesePlain"'
- name: unsupported
@@ -473,7 +473,7 @@ fields:
Style is unsupported.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bullettype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bullettype.yml
index 948cd5231a..f45ee3e7c6 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bullettype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.bullettype.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.BulletType
summary: Specifies the type of a bullet.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: none
@@ -19,8 +19,8 @@ fields:
No bullets.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"None"'
- name: numbered
@@ -30,8 +30,8 @@ fields:
Numbered bullet (e.g., 1, 2, 3 or a, b, c).
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Numbered"'
- name: unnumbered
@@ -41,8 +41,8 @@ fields:
Symbol-based bullet (e.g., disc, circle, square).
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Unnumbered"'
- name: unsupported
@@ -52,7 +52,7 @@ fields:
Type is unsupported.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.custompropertycollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.custompropertycollection.yml
index 3ced0237be..543cbe9a76 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.custompropertycollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.custompropertycollection.yml
@@ -141,11 +141,11 @@ methods:
Gets a `CustomProperty` by its zero-based index in the collection. Throws
an `InvalidArgument` exception when the index is out of range.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getItemAt(index: number): PowerPoint.CustomProperty;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartcollection.yml
index 6568c5d920..c61dd871f8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartcollection.yml
@@ -140,11 +140,11 @@ methods:
Gets a `CustomXmlPart` by its zero-based index in the collection. Throws
an `InvalidArgument` exception when the index is out of range.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getItemAt(index: number): PowerPoint.CustomXmlPart;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartscopedcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartscopedcollection.yml
index 497f9ea53b..d33950a871 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartscopedcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.customxmlpartscopedcollection.yml
@@ -91,11 +91,11 @@ methods:
Gets a `CustomXmlPart` by its zero-based index in the collection. Throws
an `InvalidArgument` exception when the index is out of range.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getItemAt(index: number): PowerPoint.CustomXmlPart;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlink.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlink.yml
index 3cc63b0ad6..fed3c280af 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlink.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlink.yml
@@ -97,11 +97,11 @@ properties:
[PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";'
@@ -116,11 +116,11 @@ methods:
fullName: delete()
summary: Deletes the hyperlink.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'delete(): void;'
@@ -141,11 +141,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getLinkedShapeOrNullObject(): PowerPoint.Shape;'
@@ -169,11 +169,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkaddoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkaddoptions.yml
index b2153afd0f..7e79893a8b 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkaddoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkaddoptions.yml
@@ -7,11 +7,11 @@ summary: >-
Represents the available options when adding a
[PowerPoint.Hyperlink](xref:powerpoint!PowerPoint.Hyperlink:class).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -23,11 +23,11 @@ properties:
Specifies the address of the hyperlink, which can be a URL, a file name or
file path, or an email address with the `mailto` URI scheme.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'address?: string;'
@@ -39,11 +39,11 @@ properties:
fullName: screenTip
summary: Specifies the string displayed when hovering over the hyperlink.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'screenTip?: string;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkcollection.yml
index 8bc26db297..bd8e2ae423 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkcollection.yml
@@ -78,11 +78,11 @@ methods:
hyperlink may appear anywhere in the collection and is not guaranteed to
be added at the end.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.hyperlinkscopedcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkscopedcollection.yml
index 9799971d1c..45e8502515 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkscopedcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinkscopedcollection.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.HyperlinkScopedCollection
summary: Represents a scoped collection of hyperlinks.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.Hyperlink[];'
@@ -48,11 +48,11 @@ methods:
fullName: getCount()
summary: Gets the number of hyperlinks in the collection.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getCount(): OfficeExtension.ClientResult;'
@@ -67,11 +67,11 @@ methods:
Gets a hyperlink using its zero-based index in the collection. Throws an
`InvalidArgument` exception when the index is out of range.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getItemAt(index: number): PowerPoint.Hyperlink;'
@@ -91,7 +91,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: >-
@@ -144,7 +144,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -177,7 +177,7 @@ methods:
from the collection's items.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinktype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinktype.yml
index 8f61d0e151..d0fe89d69f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinktype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.hyperlinktype.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.HyperlinkType
summary: Specifies the type of object that a hyperlink is applied to.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: shape
@@ -19,8 +19,8 @@ fields:
Specifies that the hyperlink is applied to a Shape.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Shape"'
- name: textRange
@@ -30,7 +30,7 @@ fields:
Specifies that the hyperlink is applied to a TextRange.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"TextRange"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
index fc67c2fd25..156e164901 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -18,11 +18,11 @@ properties:
fullName: count
summary: Specifies the number of adjustment points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'count?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsloadoptions.yml
index a9f51fdab0..143757c5c3 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.adjustmentsloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.AdjustmentsLoadOptions
summary: Represents the adjustment values for a shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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: count
summary: Specifies the number of adjustment points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'count?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatdata.yml
index 664f8d96b0..8a532edb62 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatdata.yml
@@ -23,11 +23,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -89,11 +89,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.bulletformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml
index 37c6e77dcd..79a23da81c 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml
@@ -43,11 +43,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'style?: boolean;'
@@ -64,11 +64,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.bulletformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml
index cd5d7f0982..1658f7a1e6 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml
@@ -23,11 +23,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -89,11 +89,11 @@ properties:
[PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
includes text fragments with different bullet formatting properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.hyperlinkcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml
index 9ba6bd1270..2b56afc127 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml
@@ -80,11 +80,11 @@ properties:
[PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.hyperlinkdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkdata.yml
index 8935de44c3..07bd09540d 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkdata.yml
@@ -55,11 +55,11 @@ properties:
[PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml
index ec66fb82ee..5f5a406c08 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml
@@ -72,11 +72,11 @@ properties:
[PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.hyperlinkscopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionloadoptions.yml
index 02c556ae2b..599e277898 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionloadoptions.yml
@@ -6,11 +6,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions
summary: Represents a scoped collection of hyperlinks.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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;'
@@ -45,7 +45,7 @@ properties:
1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'address?: boolean;'
@@ -64,7 +64,7 @@ properties:
1.6](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'screenTip?: boolean;'
@@ -81,11 +81,11 @@ properties:
[PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetupdata.yml
index 29cbc57c3b..260606857e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetupdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -18,11 +18,11 @@ properties:
fullName: slideHeight
summary: Specifies the height of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideHeight?: number;'
@@ -34,11 +34,11 @@ properties:
fullName: slideWidth
summary: Specifies the width of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideWidth?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetuploadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetuploadoptions.yml
index 1db2f13dc6..70a9a9e5a0 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetuploadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetuploadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.PageSetupLoadOptions
summary: Represents the page setup information for the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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: slideHeight
summary: Specifies the height of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideHeight?: boolean;'
@@ -51,11 +51,11 @@ properties:
fullName: slideWidth
summary: Specifies the width of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideWidth?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
index 696e57aeea..11a48919d8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -18,11 +18,11 @@ properties:
fullName: slideHeight
summary: Specifies the height of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideHeight?: number;'
@@ -34,11 +34,11 @@ properties:
fullName: slideWidth
summary: Specifies the width of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideWidth?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatdata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatdata.yml
index acb6d0c42f..544a93d185 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatdata.yml
@@ -46,11 +46,11 @@ properties:
fullName: indentLevel
summary: Represents the indent level of the paragraph.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'indentLevel?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml
index edd5dcbcad..9b7481a0e8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml
@@ -84,11 +84,11 @@ properties:
fullName: indentLevel
summary: Represents the indent level of the paragraph.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'indentLevel?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml
index b9c3dd584b..178958ca46 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml
@@ -47,11 +47,11 @@ properties:
fullName: indentLevel
summary: Represents the indent level of the paragraph.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'indentLevel?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.presentationloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.presentationloadoptions.yml
index c7c066754d..9f8790cfbb 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.presentationloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.presentationloadoptions.yml
@@ -58,11 +58,11 @@ properties:
Returns the page setup information whose properties control slide setup
attributes for the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;'
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 d37e1466ff..1a4abc4808 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
@@ -38,11 +38,11 @@ properties:
For EACH ITEM in the collection: Returns an `Adjustments` object that
contains adjustment values for all the adjustments in this shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;'
@@ -65,11 +65,11 @@ properties:
with vision or cognitive impairments who may not be able to see or
understand the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextDescription?: boolean;'
@@ -91,11 +91,11 @@ properties:
and is used to determine whether they wish to hear the description of the
content.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextTitle?: boolean;'
@@ -110,11 +110,11 @@ properties:
For EACH ITEM in the collection: Gets the creation ID of the shape.
Returns `null` if the shape has no creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'creationId?: boolean;'
@@ -212,11 +212,11 @@ properties:
stylistic borders). People using screen readers will hear these are
decorative so they know they aren't missing any important information.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isDecorative?: boolean;'
@@ -357,11 +357,11 @@ properties:
the shape around the z-axis. A positive value indicates clockwise
rotation, and a negative value indicates counterclockwise rotation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rotation?: boolean;'
@@ -434,11 +434,11 @@ properties:
fullName: visible
summary: 'For EACH ITEM in the collection: Specifies if the shape is visible.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'visible?: 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 6f088d97d1..20563c65aa 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapedata.yml
@@ -23,11 +23,11 @@ properties:
with vision or cognitive impairments who may not be able to see or
understand the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextDescription?: string;'
@@ -48,11 +48,11 @@ properties:
and is used to determine whether they wish to hear the description of the
content.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextTitle?: string;'
@@ -66,11 +66,11 @@ properties:
Gets the creation ID of the shape. Returns `null` if the shape has no
creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'creationId?: string | null;'
@@ -122,11 +122,11 @@ properties:
stylistic borders). People using screen readers will hear these are
decorative so they know they aren't missing any important information.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isDecorative?: boolean;'
@@ -198,11 +198,11 @@ properties:
positive value indicates clockwise rotation, and a negative value
indicates counterclockwise rotation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rotation?: number;'
@@ -259,11 +259,11 @@ properties:
fullName: visible
summary: Specifies if the shape is visible.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'visible?: boolean;'
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 8a3b6697ca..58ba5a03d8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegroupdata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -20,11 +20,11 @@ properties:
Gets the creation ID of the shape group. Returns `null` if the shape group
has no creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'creationId?: string | null;'
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 f08233396f..7d486c9066 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
@@ -39,11 +39,11 @@ properties:
Gets the creation ID of the shape group. Returns `null` if the shape group
has no creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'creationId?: boolean;'
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 1ac4658d66..f0acf59a0d 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
@@ -37,11 +37,11 @@ properties:
Returns an `Adjustments` object that contains adjustment values for all
the adjustments in this shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;'
@@ -64,11 +64,11 @@ properties:
with vision or cognitive impairments who may not be able to see or
understand the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextDescription?: boolean;'
@@ -89,11 +89,11 @@ properties:
and is used to determine whether they wish to hear the description of the
content.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextTitle?: boolean;'
@@ -107,11 +107,11 @@ properties:
Gets the creation ID of the shape. Returns `null` if the shape has no
creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'creationId?: boolean;'
@@ -204,11 +204,11 @@ properties:
stylistic borders). People using screen readers will hear these are
decorative so they know they aren't missing any important information.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isDecorative?: boolean;'
@@ -341,11 +341,11 @@ properties:
positive value indicates clockwise rotation, and a negative value
indicates counterclockwise rotation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rotation?: boolean;'
@@ -417,11 +417,11 @@ properties:
fullName: visible
summary: Specifies if the shape is visible.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'visible?: 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 84ac1cc3fd..9f4706347a 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
@@ -39,11 +39,11 @@ properties:
For EACH ITEM in the collection: Returns an `Adjustments` object that
contains adjustment values for all the adjustments in this shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;'
@@ -66,11 +66,11 @@ properties:
with vision or cognitive impairments who may not be able to see or
understand the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextDescription?: boolean;'
@@ -92,11 +92,11 @@ properties:
and is used to determine whether they wish to hear the description of the
content.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextTitle?: boolean;'
@@ -111,11 +111,11 @@ properties:
For EACH ITEM in the collection: Gets the creation ID of the shape.
Returns `null` if the shape has no creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'creationId?: boolean;'
@@ -217,11 +217,11 @@ properties:
stylistic borders). People using screen readers will hear these are
decorative so they know they aren't missing any important information.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isDecorative?: boolean;'
@@ -365,11 +365,11 @@ properties:
the shape around the z-axis. A positive value indicates clockwise
rotation, and a negative value indicates counterclockwise rotation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rotation?: boolean;'
@@ -445,11 +445,11 @@ properties:
fullName: visible
summary: 'For EACH ITEM in the collection: Specifies if the shape is visible.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'visible?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeupdatedata.yml
index 03e51904ab..3a104eaa2a 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapeupdatedata.yml
@@ -25,11 +25,11 @@ properties:
with vision or cognitive impairments who may not be able to see or
understand the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextDescription?: string;'
@@ -50,11 +50,11 @@ properties:
and is used to determine whether they wish to hear the description of the
content.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextTitle?: string;'
@@ -90,11 +90,11 @@ properties:
stylistic borders). People using screen readers will hear these are
decorative so they know they aren't missing any important information.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isDecorative?: boolean;'
@@ -143,11 +143,11 @@ properties:
positive value indicates clockwise rotation, and a negative value
indicates counterclockwise rotation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rotation?: number;'
@@ -177,11 +177,11 @@ properties:
fullName: visible
summary: Specifies if the shape is visible.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'visible?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
index be757f7e04..3b0fa350de 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -21,11 +21,11 @@ properties:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden?: boolean;'
@@ -38,11 +38,11 @@ properties:
fullName: isMasterBackgroundFollowed
summary: Specifies if the slide background follows the slide master background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
index f419ff3883..5ad8af0897 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -21,11 +21,11 @@ properties:
[PowerPoint.SlideBackgroundFillType](xref:powerpoint!PowerPoint.SlideBackgroundFillType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundfillloadoptions.yml
index d136b14945..b37b612878 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundfillloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundfillloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions
summary: Represents the fill formatting of a slide background object.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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;'
@@ -40,11 +40,11 @@ properties:
[PowerPoint.SlideBackgroundFillType](xref:powerpoint!PowerPoint.SlideBackgroundFillType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
index 0b2371d009..98f2f10180 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -19,11 +19,11 @@ properties:
fullName: type
summary: Specifies the type of gradient fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundgradientfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillloadoptions.yml
index ff416a8f44..4234d2c276 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillloadoptions.yml
@@ -9,11 +9,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
gradient fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -28,7 +28,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -41,11 +41,11 @@ properties:
fullName: type
summary: Specifies the type of gradient fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
index 607dac777c..b1fb0e6735 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -20,11 +20,11 @@ properties:
fullName: type
summary: Specifies the type of gradient fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundloadoptions.yml
index ee5cfeca22..d3f1700831 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.SlideBackgroundLoadOptions
summary: Represents a background of a slide.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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;'
@@ -38,11 +38,11 @@ properties:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden?: boolean;'
@@ -54,11 +54,11 @@ properties:
fullName: fill
summary: Returns the fill formatting of the background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;'
@@ -74,11 +74,11 @@ properties:
fullName: isMasterBackgroundFollowed
summary: Specifies if the slide background follows the slide master background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
index dabb531cd2..0d4f4b0996 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -21,11 +21,11 @@ properties:
Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
"white").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'backgroundColor?: string;'
@@ -40,11 +40,11 @@ properties:
Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'foregroundColor?: string;'
@@ -57,11 +57,11 @@ properties:
fullName: pattern
summary: Specifies the pattern type.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundpatternfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillloadoptions.yml
index dd79ab1210..a32afb9f19 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillloadoptions.yml
@@ -9,11 +9,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
pattern fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -28,7 +28,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -43,11 +43,11 @@ properties:
Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
"white").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'backgroundColor?: boolean;'
@@ -62,11 +62,11 @@ properties:
Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'foregroundColor?: boolean;'
@@ -79,11 +79,11 @@ properties:
fullName: pattern
summary: Specifies the pattern type.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'pattern?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
index 90e3901173..8ddabbd5e3 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -22,11 +22,11 @@ properties:
Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
"white").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'backgroundColor?: string;'
@@ -41,11 +41,11 @@ properties:
Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'foregroundColor?: string;'
@@ -58,11 +58,11 @@ properties:
fullName: pattern
summary: Specifies the pattern type.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
index 57adfc0ebe..75a27942c2 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -22,11 +22,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillloadoptions.yml
index 63c3b4094d..6b576849bb 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillloadoptions.yml
@@ -9,11 +9,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
picture or texture fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -28,7 +28,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -43,11 +43,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
index a2bc1da7ac..63da5880f5 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -22,11 +22,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
index c7f41c78a1..b396fc5014 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -20,11 +20,11 @@ properties:
Specifies the fill color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color?: string;'
@@ -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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillloadoptions.yml
index 78dcd5a570..0cdc93763e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillloadoptions.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
solid fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -27,7 +27,7 @@ properties:
(such as `Range.format.fill.color`).
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
@@ -42,11 +42,11 @@ properties:
Specifies the fill color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color?: boolean;'
@@ -61,11 +61,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
index 7b1d2eee3e..e6ee606189 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -21,11 +21,11 @@ properties:
Specifies the fill color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color?: string;'
@@ -40,11 +40,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
index 9085e1b1ff..dbe912a142 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -21,11 +21,11 @@ properties:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden?: boolean;'
@@ -38,11 +38,11 @@ properties:
fullName: isMasterBackgroundFollowed
summary: Specifies if the slide background follows the slide master background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed?: 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 046743020a..24c852f885 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
@@ -36,11 +36,11 @@ properties:
fullName: background
summary: 'For EACH ITEM in the collection: Gets the background of the slide.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
index 590a7ee4cc..47a311abfc 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -21,11 +21,11 @@ properties:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden?: boolean;'
@@ -40,11 +40,11 @@ properties:
Specifies if the slide layout background follows the slide master
background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundloadoptions.yml
index 5cb09f1250..82c0d79f2d 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions
summary: Represents the background of a slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden?: boolean;'
@@ -56,11 +56,11 @@ properties:
fullName: fill
summary: Returns the fill formatting of the background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;'
@@ -78,11 +78,11 @@ properties:
Specifies if the slide layout background follows the slide master
background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed?: boolean;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
index 63b77d4dd1..4cbf285af3 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -21,11 +21,11 @@ properties:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden?: boolean;'
@@ -40,11 +40,11 @@ properties:
Specifies if the slide layout background follows the slide master
background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed?: boolean;'
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 54d8ffadf0..e2f5e2cf60 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
@@ -37,11 +37,11 @@ properties:
fullName: background
summary: 'For EACH ITEM in the collection: Gets the background of the slide layout.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;'
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 4d61897865..432efc5bf3 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
@@ -35,11 +35,11 @@ properties:
fullName: background
summary: Gets the background of the slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;'
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 231d7dfc8f..dba826b3fc 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slideloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slideloadoptions.yml
@@ -35,11 +35,11 @@ properties:
fullName: background
summary: Gets the background of the slide.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterbackgroundloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterbackgroundloadoptions.yml
index 4e2850b3cb..7da7d7b4a3 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterbackgroundloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterbackgroundloadoptions.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions
summary: Represents the background of a slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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;'
@@ -37,11 +37,11 @@ properties:
fullName: fill
summary: Returns the fill formatting of the background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml
index 5a3dfd1538..02a1c87065 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml
@@ -37,11 +37,11 @@ properties:
fullName: background
summary: 'For EACH ITEM in the collection: Gets the background of the Slide Master.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml
index 87e8bb8474..ea4840da36 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml
@@ -35,11 +35,11 @@ properties:
fullName: background
summary: Gets the background of the Slide Master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;'
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 6253bf14d9..af174bc6e2 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
@@ -37,11 +37,11 @@ properties:
fullName: background
summary: 'For EACH ITEM in the collection: Gets the background of the slide.'
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.pagesetup.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.pagesetup.yml
index 8b8464fcd8..c7a3838d5a 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.pagesetup.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.pagesetup.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.PageSetup
summary: Represents the page setup information for the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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: slideHeight
summary: Specifies the height of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideHeight: number;'
@@ -50,11 +50,11 @@ properties:
fullName: slideWidth
summary: Specifies the width of the slides in the presentation, in points.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'slideWidth: number;'
@@ -70,7 +70,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- 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: 'load(propertyNames?: string | string[]): PowerPoint.PageSetup;'
@@ -117,7 +117,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -155,7 +155,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.PageSetupData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.paragraphformat.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.paragraphformat.yml
index f7732b7306..e41504dad3 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.paragraphformat.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.paragraphformat.yml
@@ -121,11 +121,11 @@ properties:
fullName: indentLevel
summary: Represents the indent level of the paragraph.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'indentLevel: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml
index c09aebda62..dfdc5fa502 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.presentation.yml
@@ -162,11 +162,11 @@ properties:
Returns the page setup information whose properties control slide setup
attributes for the presentation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly pageSetup: PowerPoint.PageSetup;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml
index 46591f1432..61cf4778e9 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shape.yml
@@ -50,11 +50,11 @@ properties:
Returns an `Adjustments` object that contains adjustment values for all
the adjustments in this shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly adjustments: PowerPoint.Adjustments;'
@@ -73,11 +73,11 @@ properties:
with vision or cognitive impairments who may not be able to see or
understand the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextDescription: string;'
@@ -98,11 +98,11 @@ properties:
and is used to determine whether they wish to hear the description of the
content.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'altTextTitle: string;'
@@ -131,11 +131,11 @@ properties:
Gets the creation ID of the shape. Returns `null` if the shape has no
creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly creationId: string | null;'
@@ -337,11 +337,11 @@ properties:
stylistic borders). People using screen readers will hear these are
decorative so they know they aren't missing any important information.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isDecorative: boolean;'
@@ -544,11 +544,11 @@ properties:
positive value indicates clockwise rotation, and a negative value
indicates counterclockwise rotation.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'rotation: number;'
@@ -705,11 +705,11 @@ properties:
fullName: visible
summary: Specifies if the shape is visible.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'visible: boolean;'
@@ -905,11 +905,11 @@ methods:
fullName: getImageAsBase64(options)
summary: Renders an image of the shape.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -1129,11 +1129,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getTextFrameOrNullObject(): PowerPoint.TextFrame;'
@@ -1226,11 +1226,11 @@ methods:
Sets a hyperlink on this `Shape` with the specified options. This will
delete any existing hyperlink on this `Shape`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.shapegetimageformattype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegetimageformattype.yml
index 6a16d65a28..b6a7e188c7 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegetimageformattype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegetimageformattype.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.ShapeGetImageFormatType
summary: Represents the format of an image.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: png
@@ -19,7 +19,7 @@ fields:
The picture is in PNG format.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Png"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegetimageoptions.yml
index 3b49af07bb..94a42172ec 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegetimageoptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegetimageoptions.yml
@@ -11,11 +11,11 @@ summary: >-
The resulting dimensions will automatically be clamped to the maximum
supported size if too large.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -25,11 +25,11 @@ properties:
fullName: format
summary: The desired format of the resulting image.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'format?: PowerPoint.ShapeGetImageFormatType | "Png";'
@@ -47,11 +47,11 @@ properties:
Throws an `InvalidArgument` exception when set with a non-positive
integer.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'height?: number;'
@@ -67,11 +67,11 @@ properties:
Throws an `InvalidArgument` exception when set with a non-positive
integer.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.shapegroup.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegroup.yml
index 093387929d..09b3299daf 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegroup.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.shapegroup.yml
@@ -75,11 +75,11 @@ properties:
Gets the creation ID of the shape group. Returns `null` if the shape group
has no creation ID.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly creationId: string | null;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml
index 7e269330f0..0407d6a694 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml
@@ -40,11 +40,11 @@ properties:
fullName: background
summary: Gets the background of the slide.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly background: PowerPoint.SlideBackground;'
@@ -201,11 +201,11 @@ properties:
fullName: themeColorScheme
summary: Returns the `ThemeColorScheme` of the slide.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly themeColorScheme: PowerPoint.ThemeColorScheme;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackground.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackground.yml
index ba48010743..e30e422179 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackground.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackground.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.SlideBackground
summary: Represents a background of a slide.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -21,11 +21,11 @@ properties:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden: boolean;'
@@ -40,7 +40,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -52,11 +52,11 @@ properties:
fullName: fill
summary: Returns the fill formatting of the background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly fill: PowerPoint.SlideBackgroundFill;'
@@ -68,11 +68,11 @@ properties:
fullName: isMasterBackgroundFollowed
summary: Specifies if the slide background follows the slide master background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed: boolean;'
@@ -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.SlideBackground;'
@@ -135,7 +135,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -164,11 +164,11 @@ methods:
fullName: reset()
summary: Resets the fill formatting of the slide background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'reset(): void;'
@@ -190,7 +190,7 @@ methods:
copies of any loaded child properties from the original object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfill.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfill.yml
index 2ab995b196..5bb779755f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfill.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfill.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.SlideBackgroundFill
summary: Represents the fill formatting of a slide background object.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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;'
@@ -37,11 +37,11 @@ properties:
[PowerPoint.SlideBackgroundFillType](xref:powerpoint!PowerPoint.SlideBackgroundFillType:enum)
for details.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -64,11 +64,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;'
@@ -87,11 +87,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;'
@@ -111,11 +111,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -139,11 +139,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;'
@@ -159,7 +159,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -184,7 +184,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundFill;'
@@ -206,7 +206,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -237,11 +237,11 @@ methods:
Sets the fill formatting of the slide background to a gradient fill. This
changes the fill type to `gradient`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -265,11 +265,11 @@ methods:
Sets the fill formatting of the slide background to a pattern fill. This
changes the fill type to `pattern`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -294,11 +294,11 @@ methods:
Sets the fill formatting of the slide background to a picture or texture
fill. This changes the fill type to `pictureOrTexture`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -322,11 +322,11 @@ methods:
Sets the fill formatting of the slide background to a solid fill. This
changes the fill type to `solid`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -357,7 +357,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.SlideBackgroundFillData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfilltype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfilltype.yml
index 979e904641..ff05636ef8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfilltype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundfilltype.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: gradient
@@ -22,8 +22,8 @@ fields:
Specifies that the slide background should have gradient fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Gradient"'
- name: pattern
@@ -33,8 +33,8 @@ fields:
Specifies that the slide background should have pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Pattern"'
- name: pictureOrTexture
@@ -44,8 +44,8 @@ fields:
Specifies that the slide background should have picture or texture fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"PictureOrTexture"'
- name: solid
@@ -55,8 +55,8 @@ fields:
Specifies that the slide background should have regular solid fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Solid"'
- name: unsupported
@@ -66,7 +66,7 @@ fields:
Unsupported slide background fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfill.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfill.yml
index 627f40d54c..055c210a0e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfill.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfill.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
gradient fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -25,7 +25,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -37,11 +37,11 @@ properties:
fullName: type
summary: Specifies the type of gradient fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -62,7 +62,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -88,7 +88,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -112,7 +112,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -151,7 +151,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfilloptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfilloptions.yml
index ad7ec24a7b..d5aa8b7e77 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfilloptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfilloptions.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
gradient fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -22,11 +22,11 @@ properties:
fullName: type
summary: If provided, specifies the type of gradient fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundgradientfilltype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfilltype.yml
index 0da9871403..21dd196466 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfilltype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundgradientfilltype.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackgroundGradientFill](xref:powerpoint!PowerPoint.SlideBackgroundGradientFill:class).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: linear
@@ -22,8 +22,8 @@ fields:
Linear gradient fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Linear"'
- name: path
@@ -33,8 +33,8 @@ fields:
Path gradient fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Path"'
- name: radial
@@ -44,8 +44,8 @@ fields:
Radial gradient fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Radial"'
- name: rectangular
@@ -55,8 +55,8 @@ fields:
Rectangular gradient fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Rectangular"'
- name: shadeFromTitle
@@ -67,8 +67,8 @@ fields:
Shade from title gradient fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ShadeFromTitle"'
- name: unsupported
@@ -78,7 +78,7 @@ fields:
Unsupported gradient fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfill.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfill.yml
index f258cbc47a..6ac7a05d99 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfill.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfill.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
pattern fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -24,11 +24,11 @@ properties:
Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
"white").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'backgroundColor: string;'
@@ -43,7 +43,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -57,11 +57,11 @@ properties:
Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'foregroundColor: string;'
@@ -73,11 +73,11 @@ properties:
fullName: pattern
summary: Specifies the pattern type.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -124,7 +124,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -150,7 +150,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -174,7 +174,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -213,7 +213,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfilloptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfilloptions.yml
index 6fd9f8fe96..bac8a898c8 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfilloptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfilloptions.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
pattern fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -25,11 +25,11 @@ properties:
If provided, specifies the background color in HTML color format (e.g.,
"\#FFFFFF" or "white").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'backgroundColor?: string;'
@@ -44,11 +44,11 @@ properties:
If provided, specifies the foreground color in HTML color format (e.g.,
"\#FFA500" or "orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'foregroundColor?: string;'
@@ -60,11 +60,11 @@ properties:
fullName: pattern
summary: If provided, specifies the pattern type.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidebackgroundpatternfilltype.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfilltype.yml
index 7f6c2707df..32aa94097e 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfilltype.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpatternfilltype.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackgroundPatternFill](xref:powerpoint!PowerPoint.SlideBackgroundPatternFill:class).
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: cross
@@ -22,8 +22,8 @@ fields:
Cross pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Cross"'
- name: darkDownwardDiagonal
@@ -34,8 +34,8 @@ fields:
Dark downward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DarkDownwardDiagonal"'
- name: darkHorizontal
@@ -45,8 +45,8 @@ fields:
Dark horizontal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DarkHorizontal"'
- name: darkUpwardDiagonal
@@ -57,8 +57,8 @@ fields:
Dark upward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DarkUpwardDiagonal"'
- name: darkVertical
@@ -68,8 +68,8 @@ fields:
Dark vertical pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DarkVertical"'
- name: dashedDownwardDiagonal
@@ -80,8 +80,8 @@ fields:
Dashed downward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DashedDownwardDiagonal"'
- name: dashedHorizontal
@@ -92,8 +92,8 @@ fields:
Dashed horizontal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DashedHorizontal"'
- name: dashedUpwardDiagonal
@@ -104,8 +104,8 @@ fields:
Dashed upward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DashedUpwardDiagonal"'
- name: dashedVertical
@@ -115,8 +115,8 @@ fields:
Dashed vertical pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DashedVertical"'
- name: diagonalBrick
@@ -126,8 +126,8 @@ fields:
Diagonal brick pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DiagonalBrick"'
- name: diagonalCross
@@ -137,8 +137,8 @@ fields:
Diagonal cross pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DiagonalCross"'
- name: divot
@@ -148,8 +148,8 @@ fields:
Divot pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Divot"'
- name: dottedDiamond
@@ -159,8 +159,8 @@ fields:
Dotted diamond pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DottedDiamond"'
- name: dottedGrid
@@ -170,8 +170,8 @@ fields:
Dotted grid pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DottedGrid"'
- name: downwardDiagonal
@@ -182,8 +182,8 @@ fields:
Downward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"DownwardDiagonal"'
- name: horizontal
@@ -193,8 +193,8 @@ fields:
Horizontal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Horizontal"'
- name: horizontalBrick
@@ -205,8 +205,8 @@ fields:
Horizontal brick pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"HorizontalBrick"'
- name: largeCheckerBoard
@@ -217,8 +217,8 @@ fields:
Large checker board pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LargeCheckerBoard"'
- name: largeConfetti
@@ -228,8 +228,8 @@ fields:
Large confetti pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LargeConfetti"'
- name: largeGrid
@@ -239,8 +239,8 @@ fields:
Large grid pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LargeGrid"'
- name: lightDownwardDiagonal
@@ -251,8 +251,8 @@ fields:
Light downward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LightDownwardDiagonal"'
- name: lightHorizontal
@@ -263,8 +263,8 @@ fields:
Light horizontal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LightHorizontal"'
- name: lightUpwardDiagonal
@@ -275,8 +275,8 @@ fields:
Light upward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LightUpwardDiagonal"'
- name: lightVertical
@@ -286,8 +286,8 @@ fields:
Light vertical pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"LightVertical"'
- name: narrowHorizontal
@@ -298,8 +298,8 @@ fields:
Narrow horizontal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"NarrowHorizontal"'
- name: narrowVertical
@@ -309,8 +309,8 @@ fields:
Narrow vertical pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"NarrowVertical"'
- name: outlinedDiamond
@@ -321,8 +321,8 @@ fields:
Outlined diamond pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"OutlinedDiamond"'
- name: percent10
@@ -332,8 +332,8 @@ fields:
10 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent10"'
- name: percent20
@@ -343,8 +343,8 @@ fields:
20 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent20"'
- name: percent25
@@ -354,8 +354,8 @@ fields:
25 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent25"'
- name: percent30
@@ -365,8 +365,8 @@ fields:
30 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent30"'
- name: percent40
@@ -376,8 +376,8 @@ fields:
40 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent40"'
- name: percent5
@@ -387,8 +387,8 @@ fields:
5 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent5"'
- name: percent50
@@ -398,8 +398,8 @@ fields:
50 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent50"'
- name: percent60
@@ -409,8 +409,8 @@ fields:
60 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent60"'
- name: percent70
@@ -420,8 +420,8 @@ fields:
70 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent70"'
- name: percent75
@@ -431,8 +431,8 @@ fields:
75 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent75"'
- name: percent80
@@ -442,8 +442,8 @@ fields:
80 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent80"'
- name: percent90
@@ -453,8 +453,8 @@ fields:
90 percent pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Percent90"'
- name: plaid
@@ -464,8 +464,8 @@ fields:
Plaid pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Plaid"'
- name: shingle
@@ -475,8 +475,8 @@ fields:
Shingle pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Shingle"'
- name: smallCheckerBoard
@@ -487,8 +487,8 @@ fields:
Small checker board pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SmallCheckerBoard"'
- name: smallConfetti
@@ -498,8 +498,8 @@ fields:
Small confetti pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SmallConfetti"'
- name: smallGrid
@@ -509,8 +509,8 @@ fields:
Small grid pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SmallGrid"'
- name: solidDiamond
@@ -520,8 +520,8 @@ fields:
Solid diamond pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"SolidDiamond"'
- name: sphere
@@ -531,8 +531,8 @@ fields:
Sphere pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Sphere"'
- name: trellis
@@ -542,8 +542,8 @@ fields:
Trellis pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Trellis"'
- name: unsupported
@@ -553,8 +553,8 @@ fields:
Unsupported pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Unsupported"'
- name: upwardDiagonal
@@ -564,8 +564,8 @@ fields:
Upward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"UpwardDiagonal"'
- name: vertical
@@ -575,8 +575,8 @@ fields:
Vertical pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Vertical"'
- name: wave
@@ -586,8 +586,8 @@ fields:
Wave pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Wave"'
- name: weave
@@ -597,8 +597,8 @@ fields:
Weave pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Weave"'
- name: wideDownwardDiagonal
@@ -609,8 +609,8 @@ fields:
Wide downward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"WideDownwardDiagonal"'
- name: wideUpwardDiagonal
@@ -621,8 +621,8 @@ fields:
Wide upward diagonal pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"WideUpwardDiagonal"'
- name: zigZag
@@ -632,7 +632,7 @@ fields:
Zig zag pattern fill.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"ZigZag"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefill.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefill.yml
index 36eeda1b4c..8e3f1f6bc4 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefill.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefill.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
picture or texture fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -25,7 +25,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -40,11 +40,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency: number;'
@@ -60,7 +60,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -89,7 +89,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -116,7 +116,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -149,11 +149,11 @@ methods:
fullName: setImage(base64EncodedImage)
summary: Sets the image used to fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'setImage(base64EncodedImage: string): void;'
@@ -180,7 +180,7 @@ methods:
original object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions.yml
index 84a5ab986a..9fc83c3f37 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
picture or texture fill options.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -23,11 +23,11 @@ properties:
fullName: imageBase64
summary: If provided, specifies the Base64-encoded image data for the fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'imageBase64?: string;'
@@ -42,11 +42,11 @@ properties:
If provided, 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfill.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfill.yml
index 3496d3fb76..09a75d3fdb 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfill.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfill.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
solid fill properties.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -24,11 +24,11 @@ properties:
Specifies the fill color in HTML color format (e.g., "\#FFA500" or
"orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color: string;'
@@ -43,7 +43,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -57,11 +57,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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency: number;'
@@ -77,7 +77,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -103,7 +103,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -127,7 +127,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -166,7 +166,7 @@ methods:
object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfilloptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfilloptions.yml
index 384dd25121..4e05b7fc7c 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfilloptions.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidebackgroundsolidfilloptions.yml
@@ -8,11 +8,11 @@ summary: >-
[PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
solid fill.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -24,11 +24,11 @@ properties:
If provided, specifies the fill color in HTML color format (e.g.,
"\#FFA500" or "orange").
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'color?: string;'
@@ -42,11 +42,11 @@ properties:
If provided, 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'transparency?: number;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidecollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidecollection.yml
index c1ca6e4924..33a8beb5c4 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidecollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidecollection.yml
@@ -131,11 +131,11 @@ methods:
`InvalidArgument` exception if provided slide IDs or `Slide` objects are
not found in this collection.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.slidelayout.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayout.yml
index 26deace0a6..0c4ec75cd2 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayout.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayout.yml
@@ -49,11 +49,11 @@ properties:
fullName: background
summary: Gets the background of the slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly background: PowerPoint.SlideLayoutBackground;'
@@ -174,11 +174,11 @@ properties:
fullName: themeColorScheme
summary: Returns the `ThemeColorScheme` of the slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly themeColorScheme: PowerPoint.ThemeColorScheme;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayoutbackground.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayoutbackground.yml
index 04dec67b01..b226a11575 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayoutbackground.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidelayoutbackground.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.SlideLayoutBackground
summary: Represents the background of a slide layout.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
type: class
properties:
@@ -22,11 +22,11 @@ properties:
Specifies whether the slide layout background fill hides or displays
background graphic objects from the slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'areBackgroundGraphicsHidden: boolean;'
@@ -41,7 +41,7 @@ properties:
process to the Office host application's process.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
@@ -53,11 +53,11 @@ properties:
fullName: fill
summary: Returns the fill formatting of the background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly fill: PowerPoint.SlideBackgroundFill;'
@@ -72,11 +72,11 @@ properties:
Specifies if the slide layout background follows the slide master
background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'isMasterBackgroundFollowed: boolean;'
@@ -92,7 +92,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -117,7 +117,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -141,7 +141,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -170,11 +170,11 @@ methods:
fullName: reset()
summary: Resets the fill formatting of the slide layout background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'reset(): void;'
@@ -196,7 +196,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.SlideLayoutBackgroundData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemaster.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemaster.yml
index 31c9eead6d..dcb1f7c31d 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemaster.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemaster.yml
@@ -49,11 +49,11 @@ properties:
fullName: background
summary: Gets the background of the Slide Master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly background: PowerPoint.SlideMasterBackground;'
@@ -190,11 +190,11 @@ properties:
fullName: themeColorScheme
summary: Returns the `ThemeColorScheme` of the Slide Master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly themeColorScheme: PowerPoint.ThemeColorScheme;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemasterbackground.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemasterbackground.yml
index 0d77f49428..c71586482d 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemasterbackground.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidemasterbackground.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.SlideMasterBackground
summary: Represents the background of a slide master.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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: fill
summary: Returns the fill formatting of the background.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly fill: PowerPoint.SlideBackgroundFill;'
@@ -54,7 +54,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -79,7 +79,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -103,7 +103,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
@@ -141,7 +141,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.SlideMasterBackgroundData;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidescopedcollection.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidescopedcollection.yml
index 03e2f49eef..966f3bc47f 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidescopedcollection.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidescopedcollection.yml
@@ -85,11 +85,11 @@ methods:
Exports all slides in this collection to their 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'exportAsBase64Presentation(): OfficeExtension.ClientResult;'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrange.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrange.yml
index a8cb566f12..26d08bad49 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrange.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textrange.yml
@@ -94,11 +94,11 @@ properties:
fullName: hyperlinks
summary: Returns a collection of hyperlinks that exist on this `TextRange`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;'
@@ -354,11 +354,11 @@ methods:
Sets a hyperlink on this `TextRange` with the specified options. This will
delete all existing hyperlinks on this `TextRange`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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.themecolor.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.themecolor.yml
index df017d13ab..ff58878d32 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.themecolor.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.themecolor.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.ThemeColor
summary: Specifies the theme colors used in PowerPoint.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: accent1
@@ -19,8 +19,8 @@ fields:
Specifies the Accent 1 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Accent1"'
- name: accent2
@@ -30,8 +30,8 @@ fields:
Specifies the Accent 2 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Accent2"'
- name: accent3
@@ -41,8 +41,8 @@ fields:
Specifies the Accent 3 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Accent3"'
- name: accent4
@@ -52,8 +52,8 @@ fields:
Specifies the Accent 4 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Accent4"'
- name: accent5
@@ -63,8 +63,8 @@ fields:
Specifies the Accent 5 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Accent5"'
- name: accent6
@@ -74,8 +74,8 @@ fields:
Specifies the Accent 6 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Accent6"'
- name: dark1
@@ -85,8 +85,8 @@ fields:
Specifies the Dark 1 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Dark1"'
- name: dark2
@@ -96,8 +96,8 @@ fields:
Specifies the Dark 2 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Dark2"'
- name: followedHyperlink
@@ -107,8 +107,8 @@ fields:
Specifies the clicked hyperlink theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"FollowedHyperlink"'
- name: hyperlink
@@ -118,8 +118,8 @@ fields:
Specifies the hyperlink theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Hyperlink"'
- name: light1
@@ -129,8 +129,8 @@ fields:
Specifies the Light 1 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Light1"'
- name: light2
@@ -140,8 +140,8 @@ fields:
Specifies the Light 2 theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Light2"'
- name: mixed
@@ -151,8 +151,8 @@ fields:
Specifies a mixed theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"Mixed"'
- name: none
@@ -162,7 +162,7 @@ fields:
Specifies no theme color.
- * \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
value: '"None"'
diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.themecolorscheme.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.themecolorscheme.yml
index 3fdd79974a..1cd0ad45cd 100644
--- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.themecolorscheme.yml
+++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.themecolorscheme.yml
@@ -5,11 +5,11 @@ package: powerpoint!
fullName: PowerPoint.ThemeColorScheme
summary: Represents a theme color scheme.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/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,11 +35,11 @@ methods:
fullName: getThemeColor(color)
summary: Gets the color value for the specified `ThemeColor`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -58,11 +58,11 @@ methods:
fullName: getThemeColor(color)
summary: Gets the color value for the specified `ThemeColor`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -86,11 +86,11 @@ methods:
fullName: setThemeColor(color, rgbColor)
summary: Sets the color value for the specified `ThemeColor`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;'
@@ -112,11 +112,11 @@ methods:
fullName: setThemeColor(color, rgbColor)
summary: Sets the color value for the specified `ThemeColor`.
remarks: >-
- \[ [API set: PowerPointApi BETA (PREVIEW
- ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
\]
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: >-
@@ -154,7 +154,7 @@ methods:
shallow copies of any loaded child properties from the original object.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: |-
diff --git a/docs/docs-ref-autogen/powerpoint/toc.yml b/docs/docs-ref-autogen/powerpoint/toc.yml
index 711a4177f6..84e46bbe61 100644
--- a/docs/docs-ref-autogen/powerpoint/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint/toc.yml
@@ -1061,6 +1061,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 18a29b013e..e26ca34b1b 100644
--- a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint.yml
@@ -10,6 +10,7 @@ classes:
enums:
- powerpoint!PowerPoint.ErrorCodes:enum
interfaces:
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.BindingData:interface
@@ -35,9 +36,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
@@ -56,12 +62,31 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideLayoutData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_1/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_1/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_1/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.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 8b05bce389..4fe2a5d1b4 100644
--- a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml
@@ -858,6 +858,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint.yml
new file mode 100644
index 0000000000..87003e1fe0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint.yml
@@ -0,0 +1,458 @@
+### 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.HyperlinkAddOptions:interface
+ - powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsLoadOptions: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.BorderData:interface
+ - powerpoint!PowerPoint.Interfaces.BorderLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BordersData:interface
+ - powerpoint!PowerPoint.Interfaces.BordersLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.BorderUpdateData: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.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.MarginsData:interface
+ - powerpoint!PowerPoint.Interfaces.MarginsLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData: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.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions: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.TableColumnCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableColumnCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableColumnCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableColumnData:interface
+ - powerpoint!PowerPoint.Interfaces.TableColumnLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableColumnUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableData:interface
+ - powerpoint!PowerPoint.Interfaces.TableLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableRowCollectionData:interface
+ - powerpoint!PowerPoint.Interfaces.TableRowCollectionLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableRowCollectionUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableRowData:interface
+ - powerpoint!PowerPoint.Interfaces.TableRowLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableRowUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.TableStyleSettingsData:interface
+ - powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData: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.ShapeGetImageOptions:interface
+ - powerpoint!PowerPoint.SlideBackgroundGradientFillOptions:interface
+ - powerpoint!PowerPoint.SlideBackgroundPatternFillOptions:interface
+ - powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFillOptions:interface
+ - powerpoint!PowerPoint.SlideBackgroundSolidFillOptions:interface
+ - powerpoint!PowerPoint.SlideGetImageOptions:interface
+ - powerpoint!PowerPoint.TableAddOptions:interface
+ - powerpoint!PowerPoint.TableCellBorders:interface
+ - powerpoint!PowerPoint.TableCellMargins:interface
+ - powerpoint!PowerPoint.TableCellProperties:interface
+ - powerpoint!PowerPoint.TableClearOptions:interface
+ - powerpoint!PowerPoint.TableColumnProperties:interface
+ - powerpoint!PowerPoint.TableMergedAreaProperties:interface
+ - powerpoint!PowerPoint.TableRowProperties:interface
+ - powerpoint!PowerPoint.TextRun:interface
+classes:
+ - powerpoint!PowerPoint.Adjustments:class
+ - powerpoint!PowerPoint.Application:class
+ - powerpoint!PowerPoint.Binding:class
+ - powerpoint!PowerPoint.BindingCollection:class
+ - powerpoint!PowerPoint.Border:class
+ - powerpoint!PowerPoint.Borders: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.HyperlinkScopedCollection:class
+ - powerpoint!PowerPoint.Margins:class
+ - powerpoint!PowerPoint.PageSetup: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.SlideBackground:class
+ - powerpoint!PowerPoint.SlideBackgroundFill:class
+ - powerpoint!PowerPoint.SlideBackgroundGradientFill:class
+ - powerpoint!PowerPoint.SlideBackgroundPatternFill:class
+ - powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill:class
+ - powerpoint!PowerPoint.SlideBackgroundSolidFill:class
+ - powerpoint!PowerPoint.SlideCollection:class
+ - powerpoint!PowerPoint.SlideLayout:class
+ - powerpoint!PowerPoint.SlideLayoutBackground:class
+ - powerpoint!PowerPoint.SlideLayoutCollection:class
+ - powerpoint!PowerPoint.SlideMaster:class
+ - powerpoint!PowerPoint.SlideMasterBackground:class
+ - powerpoint!PowerPoint.SlideMasterCollection:class
+ - powerpoint!PowerPoint.SlideScopedCollection:class
+ - powerpoint!PowerPoint.Table:class
+ - powerpoint!PowerPoint.TableCell:class
+ - powerpoint!PowerPoint.TableCellCollection:class
+ - powerpoint!PowerPoint.TableColumn:class
+ - powerpoint!PowerPoint.TableColumnCollection:class
+ - powerpoint!PowerPoint.TableRow:class
+ - powerpoint!PowerPoint.TableRowCollection:class
+ - powerpoint!PowerPoint.TableStyleSettings:class
+ - powerpoint!PowerPoint.Tag:class
+ - powerpoint!PowerPoint.TagCollection:class
+ - powerpoint!PowerPoint.TextFrame:class
+ - powerpoint!PowerPoint.TextRange:class
+ - powerpoint!PowerPoint.ThemeColorScheme:class
+enums:
+ - powerpoint!PowerPoint.BindingType:enum
+ - powerpoint!PowerPoint.BulletStyle:enum
+ - powerpoint!PowerPoint.BulletType:enum
+ - powerpoint!PowerPoint.ConnectorType:enum
+ - powerpoint!PowerPoint.DocumentPropertyType:enum
+ - powerpoint!PowerPoint.ErrorCodes:enum
+ - powerpoint!PowerPoint.GeometricShapeType:enum
+ - powerpoint!PowerPoint.HyperlinkType: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.ShapeGetImageFormatType:enum
+ - powerpoint!PowerPoint.ShapeLineDashStyle:enum
+ - powerpoint!PowerPoint.ShapeLineStyle:enum
+ - powerpoint!PowerPoint.ShapeType:enum
+ - powerpoint!PowerPoint.ShapeZOrder:enum
+ - powerpoint!PowerPoint.SlideBackgroundFillType:enum
+ - powerpoint!PowerPoint.SlideBackgroundGradientFillType:enum
+ - powerpoint!PowerPoint.SlideBackgroundPatternFillType:enum
+ - powerpoint!PowerPoint.SlideLayoutType:enum
+ - powerpoint!PowerPoint.TableStyle:enum
+ - powerpoint!PowerPoint.TextVerticalAlignment:enum
+ - powerpoint!PowerPoint.ThemeColor: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
+ prepopulated 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.
+ The maximum length of the string is 71,680,000 characters.
+ 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: >-
+
+
+ #### 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...
+ });
+
+ ```
+ - 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_10/powerpoint/powerpoint.addslideoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.addslideoptions.yml
new file mode 100644
index 0000000000..8d5c80bc2e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.adjustments.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.adjustments.yml
new file mode 100644
index 0000000000..6d6dcb884d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.adjustments.yml
@@ -0,0 +1,200 @@
+### YamlMime:TSType
+name: PowerPoint.Adjustments
+uid: powerpoint!PowerPoint.Adjustments:class
+package: powerpoint!
+fullName: PowerPoint.Adjustments
+summary: Represents the adjustment values for a shape.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.Adjustments#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: count
+ uid: powerpoint!PowerPoint.Adjustments#count:member
+ package: powerpoint!
+ fullName: count
+ summary: Specifies the number of adjustment points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly count: number;'
+ return:
+ type: number
+methods:
+ - name: get(index)
+ uid: powerpoint!PowerPoint.Adjustments#get:member(1)
+ package: powerpoint!
+ fullName: get(index)
+ summary: >-
+ Gets the adjustment value at the specified zero-based index. Throws an
+ `InvalidArgument` exception when the index is out of range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'get(index: number): OfficeExtension.ClientResult;'
+ parameters:
+ - id: index
+ description: The index of the adjustment to retrieve.
+ type: number
+ return:
+ type: <number>
+ description: The adjustment value at the given index.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Adjustments#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.AdjustmentsLoadOptions):
+ PowerPoint.Adjustments;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Adjustments#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.Adjustments;'
+ 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.Adjustments#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.Adjustments;
+ 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: set(index, value)
+ uid: powerpoint!PowerPoint.Adjustments#set:member(1)
+ package: powerpoint!
+ fullName: set(index, value)
+ summary: >-
+ Sets the adjustment value at the specified zero-based index. Throws an
+ `InvalidArgument` exception when the index is out of range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'set(index: number, value: number): void;'
+ parameters:
+ - id: index
+ description: The index of the adjustment to set.
+ type: number
+ - id: value
+ description: The adjustment value to set.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.Adjustments#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.Adjustments`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.AdjustmentsData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.application.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.application.yml
new file mode 100644
index 0000000000..5380c92d76
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.application.yml
@@ -0,0 +1,80 @@
+### YamlMime:TSType
+name: PowerPoint.Application
+uid: powerpoint!PowerPoint.Application:class
+package: powerpoint!
+fullName: PowerPoint.Application
+summary: Represents the PowerPoint application that manages the presentation.
+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_10/powerpoint/powerpoint.binding.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.binding.yml
new file mode 100644
index 0000000000..37d82977e9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.binding.yml
@@ -0,0 +1,245 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ async function getShapeForBindingId(bindingId: string):
+ Promise {
+ // Gets shape associated with binding ID.
+ return PowerPoint.run(async (context) => {
+ const binding = context.presentation.bindings.getItem(bindingId);
+ const shape = binding.getShape();
+ return shape;
+ });
+ }
+
+ ```
+
+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. Throws an error if the
+ binding isn't of the correct type.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/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/binding-to-shapes.yaml
+
+
+ async function getShapeForBindingId(bindingId: string):
+ Promise {
+ // Gets shape associated with binding ID.
+ return PowerPoint.run(async (context) => {
+ const binding = context.presentation.bindings.getItem(bindingId);
+ const shape = binding.getShape();
+ return shape;
+ });
+ }
+
+ ```
+
+ 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_10/powerpoint/powerpoint.bindingcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bindingcollection.yml
new file mode 100644
index 0000000000..9b4872873b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bindingcollection.yml
@@ -0,0 +1,461 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ // Loads bindings.
+
+ await PowerPoint.run(async (context) => {
+ const bindings = context.presentation.bindings;
+ bindings.load("items");
+ await context.sync();
+
+ const bindingCount = bindings.items.length;
+ if (bindingCount === 0) {
+ console.log(`There are no bindings.`);
+ } else if (bindingCount === 1) {
+ console.log("There's 1 binding.");
+ } else {
+ console.log(`There are ${bindingCount} bindings.`);
+ }
+
+ bindings.items.forEach((binding) => {
+ getShapeForBindingId(binding.id).then((shape) => {
+ if (shape) {
+ console.log(`Binding ID: ${binding.id} refers to shape ID ${shape.id}`);
+ } else {
+ console.log(`Binding ID: ${binding.id} doesn't refers to shape.`);
+ }
+ });
+ });
+
+ populateBindingsDropdown(bindings.items);
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ // Inserts an image with binding.
+
+ await PowerPoint.run(async (context) => {
+ const bindingId = (document.getElementById("temp-binding-id") as HTMLInputElement).value;
+ const slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const myShape = slide.shapes.addGeometricShape(PowerPoint.GeometricShapeType.rectangle, {
+ top: 100,
+ left: 30,
+ width: 200,
+ height: 200
+ });
+
+ myShape.fill.setImage(flowerImage);
+ context.presentation.bindings.add(myShape, PowerPoint.BindingType.shape, bindingId);
+ await context.sync();
+
+ const bindingsDropdown = document.getElementById("bindings-dropdown") as HTMLSelectElement;
+
+ const option = new Option(`Binding ${bindingId}`, bindingId);
+
+ // When a binding ID already exists, the binding is updated to refer to the new shape
+ // so select the existing item rather than add a new one.
+ const foundIndex = findDropdownItem(bindingsDropdown, option.text);
+ if (foundIndex < 0) {
+ bindingsDropdown.add(option);
+ bindingsDropdown.selectedIndex = bindingsDropdown.options.length - 1;
+ } else {
+ bindingsDropdown.selectedIndex = foundIndex;
+ }
+ });
+
+ ```
+
+ 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, bindingType, id)
+ uid: powerpoint!PowerPoint.BindingCollection#add:member(2)
+ 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: "Shape", 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: '"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(bindingType, id)
+ uid: powerpoint!PowerPoint.BindingCollection#addFromSelection:member(2)
+ 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: "Shape", id: string): PowerPoint.Binding;'
+ parameters:
+ - id: bindingType
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ async function getShapeForBindingId(bindingId: string):
+ Promise {
+ // Gets shape associated with binding ID.
+ return PowerPoint.run(async (context) => {
+ const binding = context.presentation.bindings.getItem(bindingId);
+ const shape = binding.getShape();
+ return shape;
+ });
+ }
+
+ ```
+
+ 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_10/powerpoint/powerpoint.bindingtype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bindingtype.yml
new file mode 100644
index 0000000000..f474e5b05a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bindingtype.yml
@@ -0,0 +1,68 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ // Inserts an image with binding.
+
+ await PowerPoint.run(async (context) => {
+ const bindingId = (document.getElementById("temp-binding-id") as HTMLInputElement).value;
+ const slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const myShape = slide.shapes.addGeometricShape(PowerPoint.GeometricShapeType.rectangle, {
+ top: 100,
+ left: 30,
+ width: 200,
+ height: 200
+ });
+
+ myShape.fill.setImage(flowerImage);
+ context.presentation.bindings.add(myShape, PowerPoint.BindingType.shape, bindingId);
+ await context.sync();
+
+ const bindingsDropdown = document.getElementById("bindings-dropdown") as HTMLSelectElement;
+
+ const option = new Option(`Binding ${bindingId}`, bindingId);
+
+ // When a binding ID already exists, the binding is updated to refer to the new shape
+ // so select the existing item rather than add a new one.
+ const foundIndex = findDropdownItem(bindingsDropdown, option.text);
+ if (foundIndex < 0) {
+ bindingsDropdown.add(option);
+ bindingsDropdown.selectedIndex = bindingsDropdown.options.length - 1;
+ } else {
+ bindingsDropdown.selectedIndex = foundIndex;
+ }
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.border.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.border.yml
new file mode 100644
index 0000000000..d4f24cdcc8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.border.yml
@@ -0,0 +1,208 @@
+### YamlMime:TSType
+name: PowerPoint.Border
+uid: powerpoint!PowerPoint.Border:class
+package: powerpoint!
+fullName: PowerPoint.Border
+summary: Represents the properties for a table cell border.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.Border#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.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color: string | undefined;'
+ return:
+ type: string | undefined
+ - name: context
+ uid: powerpoint!PowerPoint.Border#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.Border#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: Represents the dash style of the line.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Border#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.9](/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.Border#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: Represents the weight of the line, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'weight: number | undefined;'
+ return:
+ type: number | undefined
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Border#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.BorderLoadOptions):
+ PowerPoint.Border;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Border#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.Border;'
+ 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.Border#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.Border;
+ 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.Border#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.Border`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.BorderData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.BorderData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.borderproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.borderproperties.yml
new file mode 100644
index 0000000000..88a910cb07
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.borderproperties.yml
@@ -0,0 +1,235 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'weight?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.borders.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.borders.yml
new file mode 100644
index 0000000000..9297caf2eb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.borders.yml
@@ -0,0 +1,229 @@
+### YamlMime:TSType
+name: PowerPoint.Borders
+uid: powerpoint!PowerPoint.Borders:class
+package: powerpoint!
+fullName: PowerPoint.Borders
+summary: Represents the borders for a table cell.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: bottom
+ uid: powerpoint!PowerPoint.Borders#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Gets the bottom border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly bottom: PowerPoint.Border;'
+ return:
+ type:
+ - name: context
+ uid: powerpoint!PowerPoint.Borders#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: diagonalDown
+ uid: powerpoint!PowerPoint.Borders#diagonalDown:member
+ package: powerpoint!
+ fullName: diagonalDown
+ summary: Gets the diagonal border (top-left to bottom-right).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly diagonalDown: PowerPoint.Border;'
+ return:
+ type:
+ - name: diagonalUp
+ uid: powerpoint!PowerPoint.Borders#diagonalUp:member
+ package: powerpoint!
+ fullName: diagonalUp
+ summary: Gets the diagonal border (bottom-left to top-right).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly diagonalUp: PowerPoint.Border;'
+ return:
+ type:
+ - name: left
+ uid: powerpoint!PowerPoint.Borders#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Gets the left border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly left: PowerPoint.Border;'
+ return:
+ type:
+ - name: right
+ uid: powerpoint!PowerPoint.Borders#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Gets the right border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly right: PowerPoint.Border;'
+ return:
+ type:
+ - name: top
+ uid: powerpoint!PowerPoint.Borders#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Gets the top border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly top: PowerPoint.Border;'
+ return:
+ type:
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Borders#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.BordersLoadOptions):
+ PowerPoint.Borders;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Borders#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.Borders;'
+ 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.Borders#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.Borders;
+ 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.Borders#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.Borders`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.BordersData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.BordersData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bulletformat.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bulletformat.yml
new file mode 100644
index 0000000000..af70ca5f1a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bulletformat.yml
@@ -0,0 +1,286 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Gets navigational (complex) properties of the selected text range.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
+ await context.sync();
+
+ console.log("Font properties of selected text range:");
+ console.log(`\tallCaps: ${textRange.font.allCaps}`);
+ console.log(`\tbold: ${textRange.font.bold}`);
+ console.log(`\tcolor: ${textRange.font.color}`);
+ console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
+ console.log(`\titalic: ${textRange.font.italic}`);
+ console.log(`\tname: ${textRange.font.name}`);
+ console.log(`\tsize: ${textRange.font.size}`);
+ console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
+ console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
+ console.log(`\tsubscript: ${textRange.font.subscript}`);
+ console.log(`\tsuperscript: ${textRange.font.superscript}`);
+ console.log(`\tunderline: ${textRange.font.underline}`);
+
+ console.log("Paragraph format properties of selected text range:");
+ console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
+ console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
+ });
+
+ ```
+
+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: style
+ uid: powerpoint!PowerPoint.BulletFormat#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ Specifies the style of the bullets in the paragraph. See
+ [PowerPoint.BulletStyle](xref:powerpoint!PowerPoint.BulletStyle:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style: PowerPoint.BulletStyle | "Unsupported" |
+ "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" |
+ "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" |
+ "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" |
+ "RomanLowercasePeriod" | "RomanUppercasePeriod" |
+ "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight"
+ | "AlphabetUppercaseParenthesesBoth" |
+ "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" |
+ "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" |
+ "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" |
+ "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" |
+ "CircleNumberWideDoubleByteWhitePlain" |
+ "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" |
+ "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" |
+ "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" |
+ "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" |
+ "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" |
+ "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" |
+ "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" |
+ "HindiAlphabetPeriod" | "HindiNumeralPeriod" |
+ "KanjiSimplifiedChineseDoubleBytePeriod" |
+ "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ return:
+ type: >-
+ | "Unsupported"
+ | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" |
+ "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" |
+ "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" |
+ "RomanLowercasePeriod" | "RomanUppercasePeriod" |
+ "AlphabetLowercaseParenthesesBoth" |
+ "AlphabetLowercaseParenthesisRight" |
+ "AlphabetUppercaseParenthesesBoth" |
+ "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" |
+ "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" |
+ "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" |
+ "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" |
+ "CircleNumberWideDoubleByteWhitePlain" |
+ "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" |
+ "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash"
+ | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" |
+ "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" |
+ "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" |
+ "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" |
+ "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" |
+ "HindiAlphabetPeriod" | "HindiNumeralPeriod" |
+ "KanjiSimplifiedChineseDoubleBytePeriod" |
+ "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null
+ - name: type
+ uid: powerpoint!PowerPoint.BulletFormat#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Specifies the type of the bullets in the paragraph. See
+ [PowerPoint.BulletType](xref:powerpoint!PowerPoint.BulletType:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" |
+ "Unnumbered" | null;
+ return:
+ type: >-
+ | "Unsupported" |
+ "None" | "Numbered" | "Unnumbered" | null
+ - 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 [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ 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 | null;'
+ return:
+ type: boolean | null
+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_10/powerpoint/powerpoint.bulletstyle.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bulletstyle.yml
new file mode 100644
index 0000000000..8c515f3d39
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bulletstyle.yml
@@ -0,0 +1,479 @@
+### YamlMime:TSEnum
+name: PowerPoint.BulletStyle
+uid: powerpoint!PowerPoint.BulletStyle:enum
+package: powerpoint!
+fullName: PowerPoint.BulletStyle
+summary: Specifies the style of a bullet.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: alphabetLowercaseParenthesesBoth
+ uid: powerpoint!PowerPoint.BulletStyle.alphabetLowercaseParenthesesBoth:member
+ package: powerpoint!
+ summary: >-
+ Lowercase alphabetical characters with both parentheses.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AlphabetLowercaseParenthesesBoth"'
+ - name: alphabetLowercaseParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.alphabetLowercaseParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Lowercase alphabetical characters with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AlphabetLowercaseParenthesisRight"'
+ - name: alphabetLowercasePeriod
+ uid: powerpoint!PowerPoint.BulletStyle.alphabetLowercasePeriod:member
+ package: powerpoint!
+ summary: >-
+ Lowercase alphabetical characters with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AlphabetLowercasePeriod"'
+ - name: alphabetUppercaseParenthesesBoth
+ uid: powerpoint!PowerPoint.BulletStyle.alphabetUppercaseParenthesesBoth:member
+ package: powerpoint!
+ summary: >-
+ Uppercase alphabetical characters with both parentheses.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AlphabetUppercaseParenthesesBoth"'
+ - name: alphabetUppercaseParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.alphabetUppercaseParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Uppercase alphabetical characters with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AlphabetUppercaseParenthesisRight"'
+ - name: alphabetUppercasePeriod
+ uid: powerpoint!PowerPoint.BulletStyle.alphabetUppercasePeriod:member
+ package: powerpoint!
+ summary: >-
+ Uppercase alphabetical characters with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"AlphabetUppercasePeriod"'
+ - name: arabicAbjadDash
+ uid: powerpoint!PowerPoint.BulletStyle.arabicAbjadDash:member
+ package: powerpoint!
+ summary: >-
+ Arabic Abjad alphabet with a dash.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicAbjadDash"'
+ - name: arabicAlphabetDash
+ uid: powerpoint!PowerPoint.BulletStyle.arabicAlphabetDash:member
+ package: powerpoint!
+ summary: >-
+ Arabic alphabet with a dash.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicAlphabetDash"'
+ - name: arabicDoubleBytePeriod
+ uid: powerpoint!PowerPoint.BulletStyle.arabicDoubleBytePeriod:member
+ package: powerpoint!
+ summary: >-
+ Double-byte Arabic numbering scheme with double-byte period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicDoubleBytePeriod"'
+ - name: arabicDoubleBytePlain
+ uid: powerpoint!PowerPoint.BulletStyle.arabicDoubleBytePlain:member
+ package: powerpoint!
+ summary: >-
+ Double-byte Arabic numbering scheme (no punctuation).
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicDoubleBytePlain"'
+ - name: arabicNumeralParenthesesBoth
+ uid: powerpoint!PowerPoint.BulletStyle.arabicNumeralParenthesesBoth:member
+ package: powerpoint!
+ summary: >-
+ Arabic numerals with both parentheses.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicNumeralParenthesesBoth"'
+ - name: arabicNumeralParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.arabicNumeralParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Arabic numerals with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicNumeralParenthesisRight"'
+ - name: arabicNumeralPeriod
+ uid: powerpoint!PowerPoint.BulletStyle.arabicNumeralPeriod:member
+ package: powerpoint!
+ summary: >-
+ Arabic numerals with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicNumeralPeriod"'
+ - name: arabicNumeralPlain
+ uid: powerpoint!PowerPoint.BulletStyle.arabicNumeralPlain:member
+ package: powerpoint!
+ summary: >-
+ Arabic numerals.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ArabicNumeralPlain"'
+ - name: circleNumberDoubleBytePlain
+ uid: powerpoint!PowerPoint.BulletStyle.circleNumberDoubleBytePlain:member
+ package: powerpoint!
+ summary: >-
+ Double-byte circled number for values up to 10.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CircleNumberDoubleBytePlain"'
+ - name: circleNumberWideDoubleByteBlackPlain
+ uid: >-
+ powerpoint!PowerPoint.BulletStyle.circleNumberWideDoubleByteBlackPlain:member
+ package: powerpoint!
+ summary: >-
+ Shadow color number with circular background of normal text color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CircleNumberWideDoubleByteBlackPlain"'
+ - name: circleNumberWideDoubleByteWhitePlain
+ uid: >-
+ powerpoint!PowerPoint.BulletStyle.circleNumberWideDoubleByteWhitePlain:member
+ package: powerpoint!
+ summary: >-
+ Text colored number with same color circle drawn around it.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"CircleNumberWideDoubleByteWhitePlain"'
+ - name: hebrewAlphabetDash
+ uid: powerpoint!PowerPoint.BulletStyle.hebrewAlphabetDash:member
+ package: powerpoint!
+ summary: >-
+ Hebrew alphabet with a dash.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HebrewAlphabetDash"'
+ - name: hindiAlphabet1Period
+ uid: powerpoint!PowerPoint.BulletStyle.hindiAlphabet1Period:member
+ package: powerpoint!
+ summary: >-
+ Hindi alphabet (consonants) with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HindiAlphabet1Period"'
+ - name: hindiAlphabetPeriod
+ uid: powerpoint!PowerPoint.BulletStyle.hindiAlphabetPeriod:member
+ package: powerpoint!
+ summary: >-
+ Hindi alphabet (vowels) with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HindiAlphabetPeriod"'
+ - name: hindiNumeralParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.hindiNumeralParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Hindi numerals with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HindiNumeralParenthesisRight"'
+ - name: hindiNumeralPeriod
+ uid: powerpoint!PowerPoint.BulletStyle.hindiNumeralPeriod:member
+ package: powerpoint!
+ summary: >-
+ Hindi numerals with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HindiNumeralPeriod"'
+ - name: kanjiKoreanPeriod
+ uid: powerpoint!PowerPoint.BulletStyle.kanjiKoreanPeriod:member
+ package: powerpoint!
+ summary: >-
+ Japanese/Korean numbers with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"KanjiKoreanPeriod"'
+ - name: kanjiKoreanPlain
+ uid: powerpoint!PowerPoint.BulletStyle.kanjiKoreanPlain:member
+ package: powerpoint!
+ summary: >-
+ Japanese/Korean numbers without a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"KanjiKoreanPlain"'
+ - name: kanjiSimplifiedChineseDoubleBytePeriod
+ uid: >-
+ powerpoint!PowerPoint.BulletStyle.kanjiSimplifiedChineseDoubleBytePeriod:member
+ package: powerpoint!
+ summary: >-
+ Kanji Simplified Chinese with double-byte period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"KanjiSimplifiedChineseDoubleBytePeriod"'
+ - name: romanLowercaseParenthesesBoth
+ uid: powerpoint!PowerPoint.BulletStyle.romanLowercaseParenthesesBoth:member
+ package: powerpoint!
+ summary: >-
+ Lowercase Roman numerals with both parentheses.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RomanLowercaseParenthesesBoth"'
+ - name: romanLowercaseParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.romanLowercaseParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Lowercase Roman numerals with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RomanLowercaseParenthesisRight"'
+ - name: romanLowercasePeriod
+ uid: powerpoint!PowerPoint.BulletStyle.romanLowercasePeriod:member
+ package: powerpoint!
+ summary: >-
+ Lowercase Roman numerals with period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RomanLowercasePeriod"'
+ - name: romanUppercaseParenthesesBoth
+ uid: powerpoint!PowerPoint.BulletStyle.romanUppercaseParenthesesBoth:member
+ package: powerpoint!
+ summary: >-
+ Uppercase Roman numerals with both parentheses.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RomanUppercaseParenthesesBoth"'
+ - name: romanUppercaseParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.romanUppercaseParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Uppercase Roman numerals with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RomanUppercaseParenthesisRight"'
+ - name: romanUppercasePeriod
+ uid: powerpoint!PowerPoint.BulletStyle.romanUppercasePeriod:member
+ package: powerpoint!
+ summary: >-
+ Uppercase Roman numerals with period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"RomanUppercasePeriod"'
+ - name: simplifiedChinesePeriod
+ uid: powerpoint!PowerPoint.BulletStyle.simplifiedChinesePeriod:member
+ package: powerpoint!
+ summary: >-
+ Simplified Chinese with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SimplifiedChinesePeriod"'
+ - name: simplifiedChinesePlain
+ uid: powerpoint!PowerPoint.BulletStyle.simplifiedChinesePlain:member
+ package: powerpoint!
+ summary: >-
+ Simplified Chinese without a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SimplifiedChinesePlain"'
+ - name: thaiAlphabetParenthesesBoth
+ uid: powerpoint!PowerPoint.BulletStyle.thaiAlphabetParenthesesBoth:member
+ package: powerpoint!
+ summary: >-
+ Thai alphabet with both parentheses.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThaiAlphabetParenthesesBoth"'
+ - name: thaiAlphabetParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.thaiAlphabetParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Thai alphabet with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThaiAlphabetParenthesisRight"'
+ - name: thaiAlphabetPeriod
+ uid: powerpoint!PowerPoint.BulletStyle.thaiAlphabetPeriod:member
+ package: powerpoint!
+ summary: >-
+ Thai alphabet with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThaiAlphabetPeriod"'
+ - name: thaiNumeralParenthesesBoth
+ uid: powerpoint!PowerPoint.BulletStyle.thaiNumeralParenthesesBoth:member
+ package: powerpoint!
+ summary: >-
+ Thai numerals with both parentheses.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThaiNumeralParenthesesBoth"'
+ - name: thaiNumeralParenthesisRight
+ uid: powerpoint!PowerPoint.BulletStyle.thaiNumeralParenthesisRight:member
+ package: powerpoint!
+ summary: >-
+ Thai numerals with closing parenthesis.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThaiNumeralParenthesisRight"'
+ - name: thaiNumeralPeriod
+ uid: powerpoint!PowerPoint.BulletStyle.thaiNumeralPeriod:member
+ package: powerpoint!
+ summary: >-
+ Thai numerals with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThaiNumeralPeriod"'
+ - name: traditionalChinesePeriod
+ uid: powerpoint!PowerPoint.BulletStyle.traditionalChinesePeriod:member
+ package: powerpoint!
+ summary: >-
+ Traditional Chinese with a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TraditionalChinesePeriod"'
+ - name: traditionalChinesePlain
+ uid: powerpoint!PowerPoint.BulletStyle.traditionalChinesePlain:member
+ package: powerpoint!
+ summary: >-
+ Traditional Chinese without a period.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TraditionalChinesePlain"'
+ - name: unsupported
+ uid: powerpoint!PowerPoint.BulletStyle.unsupported:member
+ package: powerpoint!
+ summary: >-
+ Style is unsupported.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bullettype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bullettype.yml
new file mode 100644
index 0000000000..f45ee3e7c6
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.bullettype.yml
@@ -0,0 +1,58 @@
+### YamlMime:TSEnum
+name: PowerPoint.BulletType
+uid: powerpoint!PowerPoint.BulletType:enum
+package: powerpoint!
+fullName: PowerPoint.BulletType
+summary: Specifies the type of a bullet.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: none
+ uid: powerpoint!PowerPoint.BulletType.none:member
+ package: powerpoint!
+ summary: >-
+ No bullets.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"None"'
+ - name: numbered
+ uid: powerpoint!PowerPoint.BulletType.numbered:member
+ package: powerpoint!
+ summary: >-
+ Numbered bullet (e.g., 1, 2, 3 or a, b, c).
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Numbered"'
+ - name: unnumbered
+ uid: powerpoint!PowerPoint.BulletType.unnumbered:member
+ package: powerpoint!
+ summary: >-
+ Symbol-based bullet (e.g., disc, circle, square).
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unnumbered"'
+ - name: unsupported
+ uid: powerpoint!PowerPoint.BulletType.unsupported:member
+ package: powerpoint!
+ summary: >-
+ Type is unsupported.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.connectortype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.connectortype.yml
new file mode 100644
index 0000000000..0b5da712ac
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.connectortype.yml
@@ -0,0 +1,81 @@
+### 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_10/powerpoint/powerpoint.customproperty.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.customproperty.yml
new file mode 100644
index 0000000000..1101e615dc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.custompropertycollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.custompropertycollection.yml
new file mode 100644
index 0000000000..543cbe9a76
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.custompropertycollection.yml
@@ -0,0 +1,294 @@
+### 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: getItemAt(index)
+ uid: powerpoint!PowerPoint.CustomPropertyCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ Gets a `CustomProperty` by its zero-based index in the collection. Throws
+ an `InvalidArgument` exception when the index is out of range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.CustomProperty;'
+ parameters:
+ - id: index
+ description: The index of the custom property in the collection.
+ type: number
+ return:
+ type:
+ description: The custom property at the given index.
+ - 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_10/powerpoint/powerpoint.customxmlpart.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.customxmlpart.yml
new file mode 100644
index 0000000000..0fc0ba9bb3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.customxmlpartcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.customxmlpartcollection.yml
new file mode 100644
index 0000000000..c61dd871f8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.customxmlpartcollection.yml
@@ -0,0 +1,290 @@
+### 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: getItemAt(index)
+ uid: powerpoint!PowerPoint.CustomXmlPartCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ Gets a `CustomXmlPart` by its zero-based index in the collection. Throws
+ an `InvalidArgument` exception when the index is out of range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: index
+ description: The index of the custom XML part in the collection.
+ type: number
+ return:
+ type:
+ description: The custom XML part at the given index.
+ - 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_10/powerpoint/powerpoint.customxmlpartscopedcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.customxmlpartscopedcollection.yml
new file mode 100644
index 0000000000..d33950a871
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.customxmlpartscopedcollection.yml
@@ -0,0 +1,288 @@
+### 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: getItemAt(index)
+ uid: powerpoint!PowerPoint.CustomXmlPartScopedCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ Gets a `CustomXmlPart` by its zero-based index in the collection. Throws
+ an `InvalidArgument` exception when the index is out of range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.CustomXmlPart;'
+ parameters:
+ - id: index
+ description: The index of the custom XML part in the collection.
+ type: number
+ return:
+ type:
+ description: The custom XML part at the given index.
+ - 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_10/powerpoint/powerpoint.documentproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.documentproperties.yml
new file mode 100644
index 0000000000..f600fb1581
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.documentpropertytype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.documentpropertytype.yml
new file mode 100644
index 0000000000..21c0e6c9a7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.errorcodes.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.errorcodes.yml
new file mode 100644
index 0000000000..5a99a70369
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.fillproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.fillproperties.yml
new file mode 100644
index 0000000000..e4f55707fd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.fillproperties.yml
@@ -0,0 +1,147 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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_10/powerpoint/powerpoint.fontproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.fontproperties.yml
new file mode 100644
index 0000000000..c6a9e6ab92
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.fontproperties.yml
@@ -0,0 +1,564 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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_10/powerpoint/powerpoint.geometricshapetype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.geometricshapetype.yml
new file mode 100644
index 0000000000..fd70f99d52
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.hyperlink.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlink.yml
new file mode 100644
index 0000000000..fed3c280af
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlink.yml
@@ -0,0 +1,286 @@
+### 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 address of the hyperlink, which can be a URL, a file name or
+ file path, or an email address with the `mailto` URI scheme.
+ 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
+ - name: type
+ uid: powerpoint!PowerPoint.Hyperlink#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of object that the hyperlink is applied to. See
+ [PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";'
+ return:
+ type: >-
+ | "TextRange"
+ | "Shape"
+methods:
+ - name: delete()
+ uid: powerpoint!PowerPoint.Hyperlink#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: Deletes the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: ''
+ - name: getLinkedShapeOrNullObject()
+ uid: powerpoint!PowerPoint.Hyperlink#getLinkedShapeOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getLinkedShapeOrNullObject()
+ summary: >-
+ Returns the [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)
+ object that the hyperlink is applied to. If the hyperlink is not of type
+ `shape`, or it is within a domain that does not currently support
+ a [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class), 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkedShapeOrNullObject(): PowerPoint.Shape;'
+ return:
+ type:
+ description: ''
+ - name: getLinkedTextRangeOrNullObject()
+ uid: powerpoint!PowerPoint.Hyperlink#getLinkedTextRangeOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getLinkedTextRangeOrNullObject()
+ summary: >-
+ Returns the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class) object
+ that the hyperlink is applied to. If the hyperlink is not of type
+ `textRange`, or it is within a domain that does not currently
+ support a
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class), 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;'
+ return:
+ type:
+ description: ''
+ - 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_10/powerpoint/powerpoint.hyperlinkaddoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinkaddoptions.yml
new file mode 100644
index 0000000000..7e79893a8b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinkaddoptions.yml
@@ -0,0 +1,51 @@
+### YamlMime:TSType
+name: PowerPoint.HyperlinkAddOptions
+uid: powerpoint!PowerPoint.HyperlinkAddOptions:interface
+package: powerpoint!
+fullName: PowerPoint.HyperlinkAddOptions
+summary: >-
+ Represents the available options when adding a
+ [PowerPoint.Hyperlink](xref:powerpoint!PowerPoint.Hyperlink:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: address
+ uid: powerpoint!PowerPoint.HyperlinkAddOptions#address:member
+ package: powerpoint!
+ fullName: address
+ summary: >-
+ Specifies the address of the hyperlink, which can be a URL, a file name or
+ file path, or an email address with the `mailto` URI scheme.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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.HyperlinkAddOptions#screenTip:member
+ package: powerpoint!
+ fullName: screenTip
+ summary: Specifies the string displayed when hovering over the hyperlink.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.hyperlinkcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinkcollection.yml
new file mode 100644
index 0000000000..bd8e2ae423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinkcollection.yml
@@ -0,0 +1,252 @@
+### 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: add(target, options)
+ uid: powerpoint!PowerPoint.HyperlinkCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(target, options)
+ summary: >-
+ Adds a hyperlink to the specified target with the given options. If the
+ target already contains any hyperlinks, they will be deleted. The new
+ hyperlink may appear anywhere in the collection and is not guaranteed to
+ be added at the end.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ add(target: TextRange | Shape, options?:
+ PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
+ parameters:
+ - id: target
+ description: >-
+ The target to add the hyperlink to. Can be a
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ or a [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class).
+ type: >-
+ |
+ - id: options
+ description: Optional. The options for the hyperlink.
+ type:
+ return:
+ type:
+ description: >-
+ The newly created
+ [PowerPoint.Hyperlink](xref:powerpoint!PowerPoint.Hyperlink:class)
+ object.
+ - 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. Throws an
+ `InvalidArgument` exception 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.
+ - 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_10/powerpoint/powerpoint.hyperlinkscopedcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinkscopedcollection.yml
new file mode 100644
index 0000000000..45e8502515
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinkscopedcollection.yml
@@ -0,0 +1,190 @@
+### YamlMime:TSType
+name: PowerPoint.HyperlinkScopedCollection
+uid: powerpoint!PowerPoint.HyperlinkScopedCollection:class
+package: powerpoint!
+fullName: PowerPoint.HyperlinkScopedCollection
+summary: Represents a scoped collection of hyperlinks.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.HyperlinkScopedCollection#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.HyperlinkScopedCollection#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.HyperlinkScopedCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of hyperlinks in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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.HyperlinkScopedCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: >-
+ Gets a hyperlink using its zero-based index in the collection. Throws an
+ `InvalidArgument` exception when the index is out of range.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.HyperlinkScopedCollection#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.HyperlinkScopedCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.HyperlinkScopedCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.HyperlinkScopedCollection#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.HyperlinkScopedCollection;
+ 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.HyperlinkScopedCollection#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.HyperlinkScopedCollection;
+ 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.HyperlinkScopedCollection#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.HyperlinkScopedCollection` object is an API object, the
+ `toJSON` method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) 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.HyperlinkScopedCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinktype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinktype.yml
new file mode 100644
index 0000000000..d0fe89d69f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.hyperlinktype.yml
@@ -0,0 +1,36 @@
+### YamlMime:TSEnum
+name: PowerPoint.HyperlinkType
+uid: powerpoint!PowerPoint.HyperlinkType:enum
+package: powerpoint!
+fullName: PowerPoint.HyperlinkType
+summary: Specifies the type of object that a hyperlink is applied to.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: shape
+ uid: powerpoint!PowerPoint.HyperlinkType.shape:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the hyperlink is applied to a Shape.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Shape"'
+ - name: textRange
+ uid: powerpoint!PowerPoint.HyperlinkType.textRange:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the hyperlink is applied to a TextRange.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"TextRange"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.insertslideformatting.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.insertslideformatting.yml
new file mode 100644
index 0000000000..c052ef8203
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.insertslideoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.insertslideoptions.yml
new file mode 100644
index 0000000000..92a015898a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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 aren't 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` isn't 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` isn't provided, the slides will be inserted at the
+ beginning of the presentation. If `targetSlideId` is invalid or if it's
+ 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_10/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..156e164901
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: count
+ uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData#count:member
+ package: powerpoint!
+ fullName: count
+ summary: Specifies the number of adjustment points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'count?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.adjustmentsloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.adjustmentsloadoptions.yml
new file mode 100644
index 0000000000..143757c5c3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.adjustmentsloadoptions.yml
@@ -0,0 +1,47 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsLoadOptions
+summary: Represents the adjustment values for a shape.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.AdjustmentsLoadOptions#$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: count
+ uid: powerpoint!PowerPoint.Interfaces.AdjustmentsLoadOptions#count:member
+ package: powerpoint!
+ fullName: count
+ summary: Specifies the number of adjustment points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'count?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bindingcollectiondata.yml
new file mode 100644
index 0000000000..2f372dcb02
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bindingcollectionloadoptions.yml
new file mode 100644
index 0000000000..9fab8d724f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bindingcollectionupdatedata.yml
new file mode 100644
index 0000000000..67824cf593
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.bindingdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bindingdata.yml
new file mode 100644
index 0000000000..29ff917fca
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.bindingloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bindingloadoptions.yml
new file mode 100644
index 0000000000..c46636dbe7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.borderdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.borderdata.yml
new file mode 100644
index 0000000000..09a530a9ad
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.borderdata.yml
@@ -0,0 +1,90 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BorderData
+uid: powerpoint!PowerPoint.Interfaces.BorderData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BorderData
+summary: >-
+ An interface describing the data returned by calling `border.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.BorderData#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.9](/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.Interfaces.BorderData#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: Represents the dash style of the line.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.BorderData#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.9](/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.Interfaces.BorderData#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: Represents the weight of the line, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.borderloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.borderloadoptions.yml
new file mode 100644
index 0000000000..0432cf2219
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.borderloadoptions.yml
@@ -0,0 +1,99 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BorderLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.BorderLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BorderLoadOptions
+summary: Represents the properties for a table cell border.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.BorderLoadOptions#$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.BorderLoadOptions#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.9](/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.BorderLoadOptions#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: Represents the dash style of the line.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'dashStyle?: boolean;'
+ return:
+ type: boolean
+ - name: transparency
+ uid: powerpoint!PowerPoint.Interfaces.BorderLoadOptions#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.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: boolean;'
+ return:
+ type: boolean
+ - name: weight
+ uid: powerpoint!PowerPoint.Interfaces.BorderLoadOptions#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: Represents the weight of the line, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.bordersdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bordersdata.yml
new file mode 100644
index 0000000000..1b8f6e1f2b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bordersdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BordersData
+uid: powerpoint!PowerPoint.Interfaces.BordersData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BordersData
+summary: >-
+ An interface describing the data returned by calling `borders.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bordersloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bordersloadoptions.yml
new file mode 100644
index 0000000000..9c01c5de8f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bordersloadoptions.yml
@@ -0,0 +1,139 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BordersLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BordersLoadOptions
+summary: Represents the borders for a table cell.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions#$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: bottom
+ uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Gets the bottom border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottom?: PowerPoint.Interfaces.BorderLoadOptions;'
+ return:
+ type: >-
+
+ - name: diagonalDown
+ uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions#diagonalDown:member
+ package: powerpoint!
+ fullName: diagonalDown
+ summary: Gets the diagonal border (top-left to bottom-right).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;'
+ return:
+ type: >-
+
+ - name: diagonalUp
+ uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions#diagonalUp:member
+ package: powerpoint!
+ fullName: diagonalUp
+ summary: Gets the diagonal border (bottom-left to top-right).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;'
+ return:
+ type: >-
+
+ - name: left
+ uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Gets the left border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: PowerPoint.Interfaces.BorderLoadOptions;'
+ return:
+ type: >-
+
+ - name: right
+ uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Gets the right border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'right?: PowerPoint.Interfaces.BorderLoadOptions;'
+ return:
+ type: >-
+
+ - name: top
+ uid: powerpoint!PowerPoint.Interfaces.BordersLoadOptions#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Gets the top border.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: PowerPoint.Interfaces.BorderLoadOptions;'
+ return:
+ type: >-
+
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.borderupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.borderupdatedata.yml
new file mode 100644
index 0000000000..2ad5231dff
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.borderupdatedata.yml
@@ -0,0 +1,90 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.BorderUpdateData
+uid: powerpoint!PowerPoint.Interfaces.BorderUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.BorderUpdateData
+summary: >-
+ An interface for updating data on the `Border` object, for use in
+ `border.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.BorderUpdateData#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.9](/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.Interfaces.BorderUpdateData#dashStyle:member
+ package: powerpoint!
+ fullName: dashStyle
+ summary: Represents the dash style of the line.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.BorderUpdateData#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.9](/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.Interfaces.BorderUpdateData#weight:member
+ package: powerpoint!
+ fullName: weight
+ summary: Represents the weight of the line, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.bulletformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bulletformatdata.yml
new file mode 100644
index 0000000000..8a532edb62
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bulletformatdata.yml
@@ -0,0 +1,124 @@
+### 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: style
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatData#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ Specifies the style of the bullets in the paragraph. See
+ [PowerPoint.BulletStyle](xref:powerpoint!PowerPoint.BulletStyle:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style?: PowerPoint.BulletStyle | "Unsupported" |
+ "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" |
+ "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" |
+ "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" |
+ "RomanLowercasePeriod" | "RomanUppercasePeriod" |
+ "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight"
+ | "AlphabetUppercaseParenthesesBoth" |
+ "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" |
+ "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" |
+ "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" |
+ "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" |
+ "CircleNumberWideDoubleByteWhitePlain" |
+ "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" |
+ "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" |
+ "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" |
+ "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" |
+ "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" |
+ "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" |
+ "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" |
+ "HindiAlphabetPeriod" | "HindiNumeralPeriod" |
+ "KanjiSimplifiedChineseDoubleBytePeriod" |
+ "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ return:
+ type: >-
+ | "Unsupported"
+ | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" |
+ "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" |
+ "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" |
+ "RomanLowercasePeriod" | "RomanUppercasePeriod" |
+ "AlphabetLowercaseParenthesesBoth" |
+ "AlphabetLowercaseParenthesisRight" |
+ "AlphabetUppercaseParenthesesBoth" |
+ "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" |
+ "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" |
+ "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" |
+ "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" |
+ "CircleNumberWideDoubleByteWhitePlain" |
+ "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" |
+ "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash"
+ | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" |
+ "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" |
+ "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" |
+ "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" |
+ "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" |
+ "HindiAlphabetPeriod" | "HindiNumeralPeriod" |
+ "KanjiSimplifiedChineseDoubleBytePeriod" |
+ "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Specifies the type of the bullets in the paragraph. See
+ [PowerPoint.BulletType](xref:powerpoint!PowerPoint.BulletType:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" |
+ "Unnumbered" | null;
+ return:
+ type: >-
+ | "Unsupported" |
+ "None" | "Numbered" | "Unnumbered" | null
+ - 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 [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ 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 | null;'
+ return:
+ type: boolean | null
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml
new file mode 100644
index 0000000000..79a23da81c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bulletformatloadoptions.yml
@@ -0,0 +1,95 @@
+### 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: style
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ Specifies the style of the bullets in the paragraph. See
+ [PowerPoint.BulletStyle](xref:powerpoint!PowerPoint.BulletStyle:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'style?: boolean;'
+ return:
+ type: boolean
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Specifies the type of the bullets in the paragraph. See
+ [PowerPoint.BulletType](xref:powerpoint!PowerPoint.BulletType:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: 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 [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ 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_10/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml
new file mode 100644
index 0000000000..1658f7a1e6
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.bulletformatupdatedata.yml
@@ -0,0 +1,124 @@
+### 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: style
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData#style:member
+ package: powerpoint!
+ fullName: style
+ summary: >-
+ Specifies the style of the bullets in the paragraph. See
+ [PowerPoint.BulletStyle](xref:powerpoint!PowerPoint.BulletStyle:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style?: PowerPoint.BulletStyle | "Unsupported" |
+ "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" |
+ "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" |
+ "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" |
+ "RomanLowercasePeriod" | "RomanUppercasePeriod" |
+ "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight"
+ | "AlphabetUppercaseParenthesesBoth" |
+ "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" |
+ "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" |
+ "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" |
+ "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" |
+ "CircleNumberWideDoubleByteWhitePlain" |
+ "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" |
+ "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" |
+ "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" |
+ "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" |
+ "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" |
+ "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" |
+ "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" |
+ "HindiAlphabetPeriod" | "HindiNumeralPeriod" |
+ "KanjiSimplifiedChineseDoubleBytePeriod" |
+ "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ return:
+ type: >-
+ | "Unsupported"
+ | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" |
+ "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" |
+ "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" |
+ "RomanLowercasePeriod" | "RomanUppercasePeriod" |
+ "AlphabetLowercaseParenthesesBoth" |
+ "AlphabetLowercaseParenthesisRight" |
+ "AlphabetUppercaseParenthesesBoth" |
+ "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" |
+ "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" |
+ "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" |
+ "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" |
+ "CircleNumberWideDoubleByteWhitePlain" |
+ "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" |
+ "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash"
+ | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" |
+ "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" |
+ "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" |
+ "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" |
+ "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" |
+ "HindiAlphabetPeriod" | "HindiNumeralPeriod" |
+ "KanjiSimplifiedChineseDoubleBytePeriod" |
+ "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.BulletFormatUpdateData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Specifies the type of the bullets in the paragraph. See
+ [PowerPoint.BulletType](xref:powerpoint!PowerPoint.BulletType:enum) for
+ details. Returns `null` if the
+ [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ includes text fragments with different bullet formatting properties.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" |
+ "Unnumbered" | null;
+ return:
+ type: >-
+ | "Unsupported" |
+ "None" | "Numbered" | "Unnumbered" | null
+ - 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 [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class)
+ 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 | null;'
+ return:
+ type: boolean | null
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.collectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.collectionloadoptions.yml
new file mode 100644
index 0000000000..10cc45dd2d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.custompropertycollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.custompropertycollectiondata.yml
new file mode 100644
index 0000000000..a62ea2d5f3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.custompropertycollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.custompropertycollectionloadoptions.yml
new file mode 100644
index 0000000000..61e7618aa4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.custompropertycollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.custompropertycollectionupdatedata.yml
new file mode 100644
index 0000000000..30677e389a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.custompropertydata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.custompropertydata.yml
new file mode 100644
index 0000000000..64ff37d266
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.custompropertyloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.custompropertyloadoptions.yml
new file mode 100644
index 0000000000..743a0e32bb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.custompropertyupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.custompropertyupdatedata.yml
new file mode 100644
index 0000000000..7225c8a34c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartcollectiondata.yml
new file mode 100644
index 0000000000..da0fd365be
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartcollectionloadoptions.yml
new file mode 100644
index 0000000000..eb2c27d2c0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartcollectionupdatedata.yml
new file mode 100644
index 0000000000..e31e2f3f36
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartdata.yml
new file mode 100644
index 0000000000..8a1d41fbbb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartloadoptions.yml
new file mode 100644
index 0000000000..6361f4e321
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectiondata.yml
new file mode 100644
index 0000000000..fa1a74efa2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionloadoptions.yml
new file mode 100644
index 0000000000..d139b41d42
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.customxmlpartscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..4f9d2c8176
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.documentpropertiesdata.yml
new file mode 100644
index 0000000000..556231d99b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.documentpropertiesloadoptions.yml
new file mode 100644
index 0000000000..b5e14080c1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.documentpropertiesupdatedata.yml
new file mode 100644
index 0000000000..b44d82bcd2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.hyperlinkcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkcollectiondata.yml
new file mode 100644
index 0000000000..70854c2712
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml
new file mode 100644
index 0000000000..2b56afc127
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkcollectionloadoptions.yml
@@ -0,0 +1,92 @@
+### 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 address of the hyperlink,
+ which can be a URL, a file name or file path, or an email address with the
+ `mailto` URI scheme.
+ 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
+ - name: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkCollectionLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ For EACH ITEM in the collection: Returns the type of object that the
+ hyperlink is applied to. See
+ [PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.interfaces.hyperlinkcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkcollectionupdatedata.yml
new file mode 100644
index 0000000000..26ff6e3d6b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.hyperlinkdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkdata.yml
new file mode 100644
index 0000000000..07bd09540d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkdata.yml
@@ -0,0 +1,69 @@
+### 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 address of the hyperlink, which can be a URL, a file name or
+ file path, or an email address with the `mailto` URI scheme.
+ 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
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of object that the hyperlink is applied to. See
+ [PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";'
+ return:
+ type: >-
+ | "TextRange"
+ | "Shape"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml
new file mode 100644
index 0000000000..5f5a406c08
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkloadoptions.yml
@@ -0,0 +1,84 @@
+### 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 address of the hyperlink, which can be a URL, a file name or
+ file path, or an email address with the `mailto` URI scheme.
+ 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
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the type of object that the hyperlink is applied to. See
+ [PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionloadoptions.yml
new file mode 100644
index 0000000000..599e277898
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionloadoptions.yml
@@ -0,0 +1,93 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions
+uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions
+summary: Represents a scoped collection of hyperlinks.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions#$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.HyperlinkScopedCollectionLoadOptions#address:member
+ package: powerpoint!
+ fullName: address
+ summary: >-
+ For EACH ITEM in the collection: Specifies the address of the hyperlink,
+ which can be a URL, a file name or file path, or an email address with the
+ `mailto` URI scheme.
+ 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.HyperlinkScopedCollectionLoadOptions#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
+ - name: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ For EACH ITEM in the collection: Returns the type of object that the
+ hyperlink is applied to. See
+ [PowerPoint.HyperlinkType](xref:powerpoint!PowerPoint.HyperlinkType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_10/powerpoint/powerpoint.interfaces.hyperlinkupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkupdatedata.yml
new file mode 100644
index 0000000000..4269aa6876
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.hyperlinkupdatedata.yml
@@ -0,0 +1,48 @@
+### 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 address of the hyperlink, which can be a URL, a file name or
+ file path, or an email address with the `mailto` URI scheme.
+ 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_10/powerpoint/powerpoint.interfaces.marginsdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.marginsdata.yml
new file mode 100644
index 0000000000..83851b044a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.marginsdata.yml
@@ -0,0 +1,78 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.MarginsData
+uid: powerpoint!PowerPoint.Interfaces.MarginsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.MarginsData
+summary: >-
+ An interface describing the data returned by calling `margins.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: bottom
+ uid: powerpoint!PowerPoint.Interfaces.MarginsData#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Specifies the bottom margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.MarginsData#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Specifies the left margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.MarginsData#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Specifies the right margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.MarginsData#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Specifies the top margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.marginsloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.marginsloadoptions.yml
new file mode 100644
index 0000000000..3e014c5eb4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.marginsloadoptions.yml
@@ -0,0 +1,95 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.MarginsLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.MarginsLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.MarginsLoadOptions
+summary: Represents the margins of a table cell.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.MarginsLoadOptions#$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: bottom
+ uid: powerpoint!PowerPoint.Interfaces.MarginsLoadOptions#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Specifies the bottom margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottom?: boolean;'
+ return:
+ type: boolean
+ - name: left
+ uid: powerpoint!PowerPoint.Interfaces.MarginsLoadOptions#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Specifies the left margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'left?: boolean;'
+ return:
+ type: boolean
+ - name: right
+ uid: powerpoint!PowerPoint.Interfaces.MarginsLoadOptions#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Specifies the right margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'right?: boolean;'
+ return:
+ type: boolean
+ - name: top
+ uid: powerpoint!PowerPoint.Interfaces.MarginsLoadOptions#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Specifies the top margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.marginsupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.marginsupdatedata.yml
new file mode 100644
index 0000000000..7c59a3ba16
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.marginsupdatedata.yml
@@ -0,0 +1,78 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.MarginsUpdateData
+uid: powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.MarginsUpdateData
+summary: >-
+ An interface for updating data on the `Margins` object, for use in
+ `margins.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: bottom
+ uid: powerpoint!PowerPoint.Interfaces.MarginsUpdateData#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Specifies the bottom margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.MarginsUpdateData#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Specifies the left margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.MarginsUpdateData#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Specifies the right margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.MarginsUpdateData#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Specifies the top margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..260606857e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: slideHeight
+ uid: powerpoint!PowerPoint.Interfaces.PageSetupData#slideHeight:member
+ package: powerpoint!
+ fullName: slideHeight
+ summary: Specifies the height of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideHeight?: number;'
+ return:
+ type: number
+ - name: slideWidth
+ uid: powerpoint!PowerPoint.Interfaces.PageSetupData#slideWidth:member
+ package: powerpoint!
+ fullName: slideWidth
+ summary: Specifies the width of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideWidth?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetuploadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetuploadoptions.yml
new file mode 100644
index 0000000000..70a9a9e5a0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetuploadoptions.yml
@@ -0,0 +1,63 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.PageSetupLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupLoadOptions
+summary: Represents the page setup information for the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.PageSetupLoadOptions#$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: slideHeight
+ uid: powerpoint!PowerPoint.Interfaces.PageSetupLoadOptions#slideHeight:member
+ package: powerpoint!
+ fullName: slideHeight
+ summary: Specifies the height of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideHeight?: boolean;'
+ return:
+ type: boolean
+ - name: slideWidth
+ uid: powerpoint!PowerPoint.Interfaces.PageSetupLoadOptions#slideWidth:member
+ package: powerpoint!
+ fullName: slideWidth
+ summary: Specifies the width of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideWidth?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..11a48919d8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,46 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: slideHeight
+ uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData#slideHeight:member
+ package: powerpoint!
+ fullName: slideHeight
+ summary: Specifies the height of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideHeight?: number;'
+ return:
+ type: number
+ - name: slideWidth
+ uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData#slideWidth:member
+ package: powerpoint!
+ fullName: slideWidth
+ summary: Specifies the width of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideWidth?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatdata.yml
new file mode 100644
index 0000000000..544a93d185
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatdata.yml
@@ -0,0 +1,58 @@
+### 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" | null;
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed" | null
+ - name: indentLevel
+ uid: powerpoint!PowerPoint.Interfaces.ParagraphFormatData#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: Represents the indent level of the paragraph.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml
new file mode 100644
index 0000000000..9b7481a0e8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatloadoptions.yml
@@ -0,0 +1,96 @@
+### 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
+ - name: indentLevel
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: Represents the indent level of the paragraph.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml
new file mode 100644
index 0000000000..178958ca46
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.paragraphformatupdatedata.yml
@@ -0,0 +1,59 @@
+### 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" | null;
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed" | null
+ - name: indentLevel
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: Represents the indent level of the paragraph.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.placeholderformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.placeholderformatdata.yml
new file mode 100644
index 0000000000..7b7cd7970e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.placeholderformatloadoptions.yml
new file mode 100644
index 0000000000..85885ac813
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.presentationdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.presentationdata.yml
new file mode 100644
index 0000000000..adcc509973
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.presentationdata.yml
@@ -0,0 +1,46 @@
+### 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: Returns the title of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.0](/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_10/powerpoint/powerpoint.interfaces.presentationloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.presentationloadoptions.yml
new file mode 100644
index 0000000000..9f8790cfbb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.presentationloadoptions.yml
@@ -0,0 +1,108 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PresentationLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.PresentationLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PresentationLoadOptions
+summary: >-
+ The `Presentation` object is the top-level object with one or more slides that
+ contain the contents of the presentation. To learn more about the PowerPoint
+ object model, see [PowerPoint JavaScript object
+ model](https://learn.microsoft.com/office/dev/add-ins/powerpoint/core-concepts).
+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: pageSetup
+ uid: powerpoint!PowerPoint.Interfaces.PresentationLoadOptions#pageSetup:member
+ package: powerpoint!
+ fullName: pageSetup
+ summary: >-
+ Returns the page setup information whose properties control slide setup
+ attributes for the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;'
+ return:
+ type: >-
+
+ - 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: Returns the title of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.0](/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_10/powerpoint/powerpoint.interfaces.shapecollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapecollectiondata.yml
new file mode 100644
index 0000000000..a4e879d3fc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
new file mode 100644
index 0000000000..1a4abc4808
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapecollectionloadoptions.yml
@@ -0,0 +1,487 @@
+### 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: adjustments
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#adjustments:member
+ package: powerpoint!
+ fullName: adjustments
+ summary: >-
+ For EACH ITEM in the collection: Returns an `Adjustments` object that
+ contains adjustment values for all the adjustments in this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;'
+ return:
+ type: >-
+
+ - name: altTextDescription
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#altTextDescription:member
+ package: powerpoint!
+ fullName: altTextDescription
+ summary: >-
+ For EACH ITEM in the collection: The alt text description of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextDescription?: boolean;'
+ return:
+ type: boolean
+ - name: altTextTitle
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#altTextTitle:member
+ package: powerpoint!
+ fullName: altTextTitle
+ summary: >-
+ For EACH ITEM in the collection: The alt text title of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape. A title can be read to a person with a disability
+ and is used to determine whether they wish to hear the description of the
+ content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextTitle?: boolean;'
+ return:
+ type: boolean
+ - name: creationId
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ For EACH ITEM in the collection: Gets the creation ID of the shape.
+ Returns `null` if the shape has no creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationId?: 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: isDecorative
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#isDecorative:member
+ package: powerpoint!
+ fullName: isDecorative
+ summary: >-
+ For EACH ITEM in the collection: Represents whether the shape is
+ decorative or not.
+
+
+ Decorative objects add visual interest but aren't informative (e.g.
+ stylistic borders). People using screen readers will hear these are
+ decorative so they know they aren't missing any important information.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isDecorative?: 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: rotation
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#rotation:member
+ package: powerpoint!
+ fullName: rotation
+ summary: >-
+ For EACH ITEM in the collection: Specifies the rotation, in degrees, of
+ the shape around the z-axis. A positive value indicates clockwise
+ rotation, and a negative value indicates counterclockwise rotation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rotation?: boolean;'
+ return:
+ type: boolean
+ - name: textFrame
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#textFrame:member
+ package: powerpoint!
+ fullName: textFrame
+ summary: >-
+ For EACH ITEM in the collection: Returns the
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) object
+ of this `Shape`. Throws an `InvalidArgument` exception if the
+ shape doesn't support a `TextFrame`.
+ 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: visible
+ uid: powerpoint!PowerPoint.Interfaces.ShapeCollectionLoadOptions#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: 'For EACH ITEM in the collection: Specifies if the shape is visible.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: 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_10/powerpoint/powerpoint.interfaces.shapecollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapecollectionupdatedata.yml
new file mode 100644
index 0000000000..ed728a0635
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.shapedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapedata.yml
new file mode 100644
index 0000000000..20563c65aa
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapedata.yml
@@ -0,0 +1,309 @@
+### 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: altTextDescription
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#altTextDescription:member
+ package: powerpoint!
+ fullName: altTextDescription
+ summary: >-
+ The alt text description of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextDescription?: string;'
+ return:
+ type: string
+ - name: altTextTitle
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#altTextTitle:member
+ package: powerpoint!
+ fullName: altTextTitle
+ summary: >-
+ The alt text title of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape. A title can be read to a person with a disability
+ and is used to determine whether they wish to hear the description of the
+ content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextTitle?: string;'
+ return:
+ type: string
+ - name: creationId
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ Gets the creation ID of the shape. Returns `null` if the shape has no
+ creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationId?: string | null;'
+ return:
+ type: string | null
+ - 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: isDecorative
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#isDecorative:member
+ package: powerpoint!
+ fullName: isDecorative
+ summary: >-
+ Represents whether the shape is decorative or not.
+
+
+ Decorative objects add visual interest but aren't informative (e.g.
+ stylistic borders). People using screen readers will hear these are
+ decorative so they know they aren't missing any important information.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isDecorative?: boolean;'
+ return:
+ type: boolean
+ - 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: rotation
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#rotation:member
+ package: powerpoint!
+ fullName: rotation
+ summary: >-
+ Specifies the rotation, in degrees, of the shape around the z-axis. A
+ positive value indicates clockwise rotation, and a negative value
+ indicates counterclockwise rotation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rotation?: number;'
+ return:
+ type: number
+ - 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: visible
+ uid: powerpoint!PowerPoint.Interfaces.ShapeData#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: Specifies if the shape is visible.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
+ - 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_10/powerpoint/powerpoint.interfaces.shapefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapefilldata.yml
new file mode 100644
index 0000000000..dbeda43999
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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 doesn't
+ 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_10/powerpoint/powerpoint.interfaces.shapefillloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapefillloadoptions.yml
new file mode 100644
index 0000000000..75903c0bc6
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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 doesn't
+ 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_10/powerpoint/powerpoint.interfaces.shapefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapefillupdatedata.yml
new file mode 100644
index 0000000000..8d8da0fe21
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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 doesn't
+ 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_10/powerpoint/powerpoint.interfaces.shapefontdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapefontdata.yml
new file mode 100644
index 0000000000..9472435ca8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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`: 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.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'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.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_10/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml
new file mode 100644
index 0000000000..3ea33986e0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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`: 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;'
+ 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'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?: 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_10/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml
new file mode 100644
index 0000000000..22e437aa00
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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`: 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.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'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.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_10/powerpoint/powerpoint.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapegroupdata.yml
new file mode 100644
index 0000000000..58ba5a03d8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapegroupdata.yml
@@ -0,0 +1,48 @@
+### 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: creationId
+ uid: powerpoint!PowerPoint.Interfaces.ShapeGroupData#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ Gets the creation ID of the shape group. Returns `null` if the shape group
+ has no creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationId?: string | null;'
+ return:
+ type: string | null
+ - 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_10/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
new file mode 100644
index 0000000000..7d486c9066
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapegrouploadoptions.yml
@@ -0,0 +1,85 @@
+### 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: creationId
+ uid: powerpoint!PowerPoint.Interfaces.ShapeGroupLoadOptions#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ Gets the creation ID of the shape group. Returns `null` if the shape group
+ has no creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationId?: 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_10/powerpoint/powerpoint.interfaces.shapelineformatdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapelineformatdata.yml
new file mode 100644
index 0000000000..2045e98634
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapelineformatdata.yml
@@ -0,0 +1,139 @@
+### 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 isn't
+ visible or there are inconsistent dash styles. See
+ [PowerPoint.ShapeLineDashStyle](xref:powerpoint!PowerPoint.ShapeLineDashStyle:enum)
+ 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 isn't
+ visible or there are inconsistent styles. See
+ [PowerPoint.ShapeLineStyle](xref:powerpoint!PowerPoint.ShapeLineStyle:enum)
+ 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
+ isn't 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_10/powerpoint/powerpoint.interfaces.shapelineformatloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapelineformatloadoptions.yml
new file mode 100644
index 0000000000..e3651a73e6
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapelineformatloadoptions.yml
@@ -0,0 +1,148 @@
+### 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 isn't
+ visible or there are inconsistent dash styles. See
+ [PowerPoint.ShapeLineDashStyle](xref:powerpoint!PowerPoint.ShapeLineDashStyle:enum)
+ 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 isn't
+ visible or there are inconsistent styles. See
+ [PowerPoint.ShapeLineStyle](xref:powerpoint!PowerPoint.ShapeLineStyle:enum)
+ 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
+ isn't 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_10/powerpoint/powerpoint.interfaces.shapelineformatupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapelineformatupdatedata.yml
new file mode 100644
index 0000000000..ee2bcddb1b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapelineformatupdatedata.yml
@@ -0,0 +1,141 @@
+### 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 isn't
+ visible or there are inconsistent dash styles. See
+ [PowerPoint.ShapeLineDashStyle](xref:powerpoint!PowerPoint.ShapeLineDashStyle:enum)
+ 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 isn't
+ visible or there are inconsistent styles. See
+ [PowerPoint.ShapeLineStyle](xref:powerpoint!PowerPoint.ShapeLineStyle:enum)
+ 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
+ isn't 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_10/powerpoint/powerpoint.interfaces.shapeloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
new file mode 100644
index 0000000000..f0acf59a0d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapeloadoptions.yml
@@ -0,0 +1,467 @@
+### 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: adjustments
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#adjustments:member
+ package: powerpoint!
+ fullName: adjustments
+ summary: >-
+ Returns an `Adjustments` object that contains adjustment values for all
+ the adjustments in this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;'
+ return:
+ type: >-
+
+ - name: altTextDescription
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#altTextDescription:member
+ package: powerpoint!
+ fullName: altTextDescription
+ summary: >-
+ The alt text description of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextDescription?: boolean;'
+ return:
+ type: boolean
+ - name: altTextTitle
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#altTextTitle:member
+ package: powerpoint!
+ fullName: altTextTitle
+ summary: >-
+ The alt text title of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape. A title can be read to a person with a disability
+ and is used to determine whether they wish to hear the description of the
+ content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextTitle?: boolean;'
+ return:
+ type: boolean
+ - name: creationId
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ Gets the creation ID of the shape. Returns `null` if the shape has no
+ creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationId?: 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: isDecorative
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#isDecorative:member
+ package: powerpoint!
+ fullName: isDecorative
+ summary: >-
+ Represents whether the shape is decorative or not.
+
+
+ Decorative objects add visual interest but aren't informative (e.g.
+ stylistic borders). People using screen readers will hear these are
+ decorative so they know they aren't missing any important information.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isDecorative?: 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: rotation
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#rotation:member
+ package: powerpoint!
+ fullName: rotation
+ summary: >-
+ Specifies the rotation, in degrees, of the shape around the z-axis. A
+ positive value indicates clockwise rotation, and a negative value
+ indicates counterclockwise rotation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rotation?: boolean;'
+ return:
+ type: boolean
+ - name: textFrame
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#textFrame:member
+ package: powerpoint!
+ fullName: textFrame
+ summary: >-
+ Returns the
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) object
+ of this `Shape`. Throws an `InvalidArgument` exception if the
+ shape doesn't support a `TextFrame`.
+ 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: visible
+ uid: powerpoint!PowerPoint.Interfaces.ShapeLoadOptions#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: Specifies if the shape is visible.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: 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_10/powerpoint/powerpoint.interfaces.shapescopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapescopedcollectiondata.yml
new file mode 100644
index 0000000000..8d3c802aa0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
new file mode 100644
index 0000000000..9f4706347a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapescopedcollectionloadoptions.yml
@@ -0,0 +1,499 @@
+### 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: adjustments
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#adjustments:member
+ package: powerpoint!
+ fullName: adjustments
+ summary: >-
+ For EACH ITEM in the collection: Returns an `Adjustments` object that
+ contains adjustment values for all the adjustments in this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;'
+ return:
+ type: >-
+
+ - name: altTextDescription
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#altTextDescription:member
+ package: powerpoint!
+ fullName: altTextDescription
+ summary: >-
+ For EACH ITEM in the collection: The alt text description of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextDescription?: boolean;'
+ return:
+ type: boolean
+ - name: altTextTitle
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#altTextTitle:member
+ package: powerpoint!
+ fullName: altTextTitle
+ summary: >-
+ For EACH ITEM in the collection: The alt text title of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape. A title can be read to a person with a disability
+ and is used to determine whether they wish to hear the description of the
+ content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextTitle?: boolean;'
+ return:
+ type: boolean
+ - name: creationId
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ For EACH ITEM in the collection: Gets the creation ID of the shape.
+ Returns `null` if the shape has no creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'creationId?: 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: isDecorative
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#isDecorative:member
+ package: powerpoint!
+ fullName: isDecorative
+ summary: >-
+ For EACH ITEM in the collection: Represents whether the shape is
+ decorative or not.
+
+
+ Decorative objects add visual interest but aren't informative (e.g.
+ stylistic borders). People using screen readers will hear these are
+ decorative so they know they aren't missing any important information.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isDecorative?: 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: rotation
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#rotation:member
+ package: powerpoint!
+ fullName: rotation
+ summary: >-
+ For EACH ITEM in the collection: Specifies the rotation, in degrees, of
+ the shape around the z-axis. A positive value indicates clockwise
+ rotation, and a negative value indicates counterclockwise rotation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rotation?: boolean;'
+ return:
+ type: boolean
+ - name: textFrame
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#textFrame:member
+ package: powerpoint!
+ fullName: textFrame
+ summary: >-
+ For EACH ITEM in the collection: Returns the
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) object
+ of this `Shape`. Throws an `InvalidArgument` exception if the
+ shape doesn't support a `TextFrame`.
+ 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: visible
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: 'For EACH ITEM in the collection: Specifies if the shape is visible.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: 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_10/powerpoint/powerpoint.interfaces.shapescopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapescopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..a4a27ceacd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.shapeupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapeupdatedata.yml
new file mode 100644
index 0000000000..3a104eaa2a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.shapeupdatedata.yml
@@ -0,0 +1,207 @@
+### 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: altTextDescription
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#altTextDescription:member
+ package: powerpoint!
+ fullName: altTextDescription
+ summary: >-
+ The alt text description of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextDescription?: string;'
+ return:
+ type: string
+ - name: altTextTitle
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#altTextTitle:member
+ package: powerpoint!
+ fullName: altTextTitle
+ summary: >-
+ The alt text title of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape. A title can be read to a person with a disability
+ and is used to determine whether they wish to hear the description of the
+ content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextTitle?: string;'
+ return:
+ type: string
+ - 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: isDecorative
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#isDecorative:member
+ package: powerpoint!
+ fullName: isDecorative
+ summary: >-
+ Represents whether the shape is decorative or not.
+
+
+ Decorative objects add visual interest but aren't informative (e.g.
+ stylistic borders). People using screen readers will hear these are
+ decorative so they know they aren't missing any important information.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isDecorative?: boolean;'
+ return:
+ type: boolean
+ - 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: rotation
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#rotation:member
+ package: powerpoint!
+ fullName: rotation
+ summary: >-
+ Specifies the rotation, in degrees, of the shape around the z-axis. A
+ positive value indicates clockwise rotation, and a negative value
+ indicates counterclockwise rotation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rotation?: number;'
+ return:
+ type: number
+ - 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: visible
+ uid: powerpoint!PowerPoint.Interfaces.ShapeUpdateData#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: Specifies if the shape is visible.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible?: boolean;'
+ return:
+ type: boolean
+ - 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_10/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3b0fa350de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,50 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: areBackgroundGraphicsHidden
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundData#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden?: boolean;'
+ return:
+ type: boolean
+ - name: isMasterBackgroundFollowed
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundData#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: Specifies if the slide background follows the slide master background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..5ad8af0897
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,37 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the fill type of the slide background. See
+ [PowerPoint.SlideBackgroundFillType](xref:powerpoint!PowerPoint.SlideBackgroundFillType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" |
+ "Gradient" | "PictureOrTexture" | "Pattern";
+ return:
+ type: >-
+ |
+ "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundfillloadoptions.yml
new file mode 100644
index 0000000000..b37b612878
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundfillloadoptions.yml
@@ -0,0 +1,52 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions
+summary: Represents the fill formatting of a slide background object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundFillLoadOptions#$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: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundFillLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the fill type of the slide background. See
+ [PowerPoint.SlideBackgroundFillType](xref:powerpoint!PowerPoint.SlideBackgroundFillType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..98f2f10180
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,36 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Specifies the type of gradient fill.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" |
+ "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ return:
+ type: >-
+ | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" |
+ "ShadeFromTitle"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillloadoptions.yml
new file mode 100644
index 0000000000..4234d2c276
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillloadoptions.yml
@@ -0,0 +1,53 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ gradient fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions#$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: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Specifies the type of gradient fill.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..b1fb0e6735
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,37 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Specifies the type of gradient fill.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" |
+ "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ return:
+ type: >-
+ | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" |
+ "ShadeFromTitle"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundloadoptions.yml
new file mode 100644
index 0000000000..d3f1700831
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundloadoptions.yml
@@ -0,0 +1,86 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundLoadOptions
+summary: Represents a background of a slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundLoadOptions#$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: areBackgroundGraphicsHidden
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundLoadOptions#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden?: boolean;'
+ return:
+ type: boolean
+ - name: fill
+ uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of the background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;'
+ return:
+ type: >-
+
+ - name: isMasterBackgroundFollowed
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundLoadOptions#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: Specifies if the slide background follows the slide master background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..0d4f4b0996
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,100 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: backgroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData#backgroundColor:member
+ package: powerpoint!
+ fullName: backgroundColor
+ summary: >-
+ Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
+ "white").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'backgroundColor?: string;'
+ return:
+ type: string
+ - name: foregroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor?: string;'
+ return:
+ type: string
+ - name: pattern
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData#pattern:member
+ package: powerpoint!
+ fullName: pattern
+ summary: Specifies the pattern type.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" |
+ "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" |
+ "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" |
+ "Percent80" | "Percent90" | "Horizontal" | "Vertical" |
+ "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical"
+ | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" |
+ "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" |
+ "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal"
+ | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" |
+ "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" |
+ "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" |
+ "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" |
+ "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis"
+ | "ZigZag";
+ return:
+ type: >-
+ | "Unsupported" | "Percent5" | "Percent10" | "Percent20" |
+ "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" |
+ "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" |
+ "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" |
+ "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" |
+ "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" |
+ "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" |
+ "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal"
+ | "WideUpwardDiagonal" | "DashedDownwardDiagonal" |
+ "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" |
+ "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" |
+ "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond"
+ | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" |
+ "Trellis" | "ZigZag"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillloadoptions.yml
new file mode 100644
index 0000000000..a32afb9f19
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillloadoptions.yml
@@ -0,0 +1,91 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ pattern fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions#$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: backgroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions#backgroundColor:member
+ package: powerpoint!
+ fullName: backgroundColor
+ summary: >-
+ Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
+ "white").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'backgroundColor?: boolean;'
+ return:
+ type: boolean
+ - name: foregroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor?: boolean;'
+ return:
+ type: boolean
+ - name: pattern
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions#pattern:member
+ package: powerpoint!
+ fullName: pattern
+ summary: Specifies the pattern type.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'pattern?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..8ddabbd5e3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,101 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: backgroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData#backgroundColor:member
+ package: powerpoint!
+ fullName: backgroundColor
+ summary: >-
+ Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
+ "white").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'backgroundColor?: string;'
+ return:
+ type: string
+ - name: foregroundColor
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor?: string;'
+ return:
+ type: string
+ - name: pattern
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData#pattern:member
+ package: powerpoint!
+ fullName: pattern
+ summary: Specifies the pattern type.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" |
+ "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" |
+ "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" |
+ "Percent80" | "Percent90" | "Horizontal" | "Vertical" |
+ "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical"
+ | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" |
+ "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" |
+ "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal"
+ | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" |
+ "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" |
+ "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" |
+ "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" |
+ "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis"
+ | "ZigZag";
+ return:
+ type: >-
+ | "Unsupported" | "Percent5" | "Percent10" | "Percent20" |
+ "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" |
+ "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" |
+ "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" |
+ "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" |
+ "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" |
+ "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" |
+ "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal"
+ | "WideUpwardDiagonal" | "DashedDownwardDiagonal" |
+ "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" |
+ "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" |
+ "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond"
+ | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" |
+ "Trellis" | "ZigZag"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..75a27942c2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,34 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData#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.10](/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_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillloadoptions.yml
new file mode 100644
index 0000000000..6b576849bb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillloadoptions.yml
@@ -0,0 +1,55 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ picture or texture fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions#$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: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions#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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..63da5880f5
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,34 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData#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.10](/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_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..b396fc5014
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,51 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the fill color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData#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.10](/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_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillloadoptions.yml
new file mode 100644
index 0000000000..0cdc93763e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillloadoptions.yml
@@ -0,0 +1,73 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ solid fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions#$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.SlideBackgroundSolidFillLoadOptions#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the fill color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: boolean;'
+ return:
+ type: boolean
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions#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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..e6ee606189
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,52 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the fill color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData#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.10](/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_10/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..dbe912a142
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,50 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: areBackgroundGraphicsHidden
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden?: boolean;'
+ return:
+ type: boolean
+ - name: isMasterBackgroundFollowed
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: Specifies if the slide background follows the slide master background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidecollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidecollectiondata.yml
new file mode 100644
index 0000000000..123080b766
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
new file mode 100644
index 0000000000..24c852f885
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidecollectionloadoptions.yml
@@ -0,0 +1,126 @@
+### 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: background
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions#background:member
+ package: powerpoint!
+ fullName: background
+ summary: 'For EACH ITEM in the collection: Gets the background of the slide.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.slidecollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidecollectionupdatedata.yml
new file mode 100644
index 0000000000..e82c136e72
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidedata.yml
new file mode 100644
index 0000000000..6f16449fa8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..47a311abfc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,52 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: areBackgroundGraphicsHidden
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden?: boolean;'
+ return:
+ type: boolean
+ - name: isMasterBackgroundFollowed
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: >-
+ Specifies if the slide layout background follows the slide master
+ background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgroundloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgroundloadoptions.yml
new file mode 100644
index 0000000000..82c0d79f2d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgroundloadoptions.yml
@@ -0,0 +1,90 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions
+summary: Represents the background of a slide layout.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions#$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: areBackgroundGraphicsHidden
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden?: boolean;'
+ return:
+ type: boolean
+ - name: fill
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of the background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;'
+ return:
+ type: >-
+
+ - name: isMasterBackgroundFollowed
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: >-
+ Specifies if the slide layout background follows the slide master
+ background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..4cbf285af3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,52 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: areBackgroundGraphicsHidden
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden?: boolean;'
+ return:
+ type: boolean
+ - name: isMasterBackgroundFollowed
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: >-
+ Specifies if the slide layout background follows the slide master
+ background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutcollectiondata.yml
new file mode 100644
index 0000000000..774bd02414
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
new file mode 100644
index 0000000000..e2f5e2cf60
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutcollectionloadoptions.yml
@@ -0,0 +1,103 @@
+### 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: background
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions#background:member
+ package: powerpoint!
+ fullName: background
+ summary: 'For EACH ITEM in the collection: Gets the background of the slide layout.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.slidelayoutcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutcollectionupdatedata.yml
new file mode 100644
index 0000000000..bb4fba6d0b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidelayoutdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutdata.yml
new file mode 100644
index 0000000000..d7092360b4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
new file mode 100644
index 0000000000..432efc5bf3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidelayoutloadoptions.yml
@@ -0,0 +1,98 @@
+### 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: background
+ uid: powerpoint!PowerPoint.Interfaces.SlideLayoutLoadOptions#background:member
+ package: powerpoint!
+ fullName: background
+ summary: Gets the background of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.slideloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slideloadoptions.yml
new file mode 100644
index 0000000000..dba826b3fc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slideloadoptions.yml
@@ -0,0 +1,122 @@
+### 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: background
+ uid: powerpoint!PowerPoint.Interfaces.SlideLoadOptions#background:member
+ package: powerpoint!
+ fullName: background
+ summary: Gets the background of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterbackgroundloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterbackgroundloadoptions.yml
new file mode 100644
index 0000000000..7da7d7b4a3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterbackgroundloadoptions.yml
@@ -0,0 +1,52 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions
+summary: Represents the background of a slide master.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions#$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.SlideMasterBackgroundLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of the background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;'
+ return:
+ type: >-
+
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemastercollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemastercollectiondata.yml
new file mode 100644
index 0000000000..624d1771ea
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml
new file mode 100644
index 0000000000..02a1c87065
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemastercollectionloadoptions.yml
@@ -0,0 +1,86 @@
+### 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: background
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions#background:member
+ package: powerpoint!
+ fullName: background
+ summary: 'For EACH ITEM in the collection: Gets the background of the Slide Master.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.slidemastercollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemastercollectionupdatedata.yml
new file mode 100644
index 0000000000..75b7ce0412
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidemasterdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterdata.yml
new file mode 100644
index 0000000000..a6215ea3da
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml
new file mode 100644
index 0000000000..ea4840da36
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidemasterloadoptions.yml
@@ -0,0 +1,82 @@
+### 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: background
+ uid: powerpoint!PowerPoint.Interfaces.SlideMasterLoadOptions#background:member
+ package: powerpoint!
+ fullName: background
+ summary: Gets the background of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.slidescopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidescopedcollectiondata.yml
new file mode 100644
index 0000000000..f06097ffae
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
new file mode 100644
index 0000000000..af174bc6e2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidescopedcollectionloadoptions.yml
@@ -0,0 +1,130 @@
+### 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: background
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideScopedCollectionLoadOptions#background:member
+ package: powerpoint!
+ fullName: background
+ summary: 'For EACH ITEM in the collection: Gets the background of the slide.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.slidescopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.slidescopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..90e6b89c68
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellcollectiondata.yml
new file mode 100644
index 0000000000..c195915992
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml
new file mode 100644
index 0000000000..b10fc30667
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellcollectionloadoptions.yml
@@ -0,0 +1,290 @@
+### 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: borders
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#borders:member
+ package: powerpoint!
+ fullName: borders
+ summary: >-
+ For EACH ITEM in the collection: Gets the collection of borders for the
+ table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'borders?: PowerPoint.Interfaces.BordersLoadOptions;'
+ return:
+ type: >-
+
+ - 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: fill
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: 'For EACH ITEM in the collection: Gets the fill color of the table cell.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;'
+ return:
+ type: >-
+
+ - name: font
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#font:member
+ package: powerpoint!
+ fullName: font
+ summary: 'For EACH ITEM in the collection: Gets the font of the table cell.'
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'font?: PowerPoint.Interfaces.ShapeFontLoadOptions;'
+ return:
+ type: >-
+
+ - name: horizontalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ For EACH ITEM in the collection: Specifies the horizontal alignment of the
+ text in the table cell. Returns `null` if the cell text contains different
+ alignments.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'horizontalAlignment?: boolean;'
+ return:
+ type: boolean
+ - name: indentLevel
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: >-
+ For EACH ITEM in the collection: Specifies the indent level of the text in
+ the table cell. Returns `null` if the cell text contains different indent
+ levels.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: boolean;'
+ return:
+ type: boolean
+ - name: margins
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#margins:member
+ package: powerpoint!
+ fullName: margins
+ summary: >-
+ For EACH ITEM in the collection: Gets the set of margins in the table
+ cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'margins?: PowerPoint.Interfaces.MarginsLoadOptions;'
+ return:
+ type: >-
+
+ - 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
+ - name: textRuns
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#textRuns:member
+ package: powerpoint!
+ fullName: textRuns
+ summary: >-
+ For EACH ITEM in the collection: Specifies the contents of the table cell
+ as an array of
+ [PowerPoint.TextRun](xref:powerpoint!PowerPoint.TextRun:interface)
+ objects. Each `TextRun` object represents a sequence of one or more
+ characters that share the same font attributes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textRuns?: boolean;'
+ return:
+ type: boolean
+ - name: verticalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellCollectionLoadOptions#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: >-
+ For EACH ITEM in the collection: Specifies the vertical alignment of the
+ text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'verticalAlignment?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellcollectionupdatedata.yml
new file mode 100644
index 0000000000..16e2f8c093
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tablecelldata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecelldata.yml
new file mode 100644
index 0000000000..4d54164733
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecelldata.yml
@@ -0,0 +1,181 @@
+### 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: horizontalAlignment
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Specifies the horizontal alignment of the text in the table cell. Returns
+ `null` if the cell text contains different alignments.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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" | null;
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed" | null
+ - name: indentLevel
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: >-
+ Specifies the indent level of the text in the table cell. Returns `null`
+ if the cell text contains different indent levels.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: number | null;'
+ return:
+ type: number | null
+ - 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
+ - name: textRuns
+ uid: powerpoint!PowerPoint.Interfaces.TableCellData#textRuns:member
+ package: powerpoint!
+ fullName: textRuns
+ summary: >-
+ Specifies the contents of the table cell as an array of
+ [PowerPoint.TextRun](xref:powerpoint!PowerPoint.TextRun:interface)
+ objects. Each `TextRun` object represents a sequence of one or more
+ characters that share the same font attributes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.TableCellData#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: Specifies the vertical alignment of the text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml
new file mode 100644
index 0000000000..8c6808357b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellloadoptions.yml
@@ -0,0 +1,263 @@
+### 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: borders
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#borders:member
+ package: powerpoint!
+ fullName: borders
+ summary: Gets the collection of borders for the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'borders?: PowerPoint.Interfaces.BordersLoadOptions;'
+ return:
+ type: >-
+
+ - 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: fill
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Gets the fill color of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;'
+ return:
+ type: >-
+
+ - name: font
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#font:member
+ package: powerpoint!
+ fullName: font
+ summary: Gets the font of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'font?: PowerPoint.Interfaces.ShapeFontLoadOptions;'
+ return:
+ type: >-
+
+ - name: horizontalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Specifies the horizontal alignment of the text in the table cell. Returns
+ `null` if the cell text contains different alignments.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'horizontalAlignment?: boolean;'
+ return:
+ type: boolean
+ - name: indentLevel
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: >-
+ Specifies the indent level of the text in the table cell. Returns `null`
+ if the cell text contains different indent levels.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: boolean;'
+ return:
+ type: boolean
+ - name: margins
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#margins:member
+ package: powerpoint!
+ fullName: margins
+ summary: Gets the set of margins in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'margins?: PowerPoint.Interfaces.MarginsLoadOptions;'
+ return:
+ type: >-
+
+ - 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
+ - name: textRuns
+ uid: powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#textRuns:member
+ package: powerpoint!
+ fullName: textRuns
+ summary: >-
+ Specifies the contents of the table cell as an array of
+ [PowerPoint.TextRun](xref:powerpoint!PowerPoint.TextRun:interface)
+ objects. Each `TextRun` object represents a sequence of one or more
+ characters that share the same font attributes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textRuns?: boolean;'
+ return:
+ type: boolean
+ - name: verticalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellLoadOptions#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: Specifies the vertical alignment of the text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'verticalAlignment?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
new file mode 100644
index 0000000000..24ab6b78af
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecellupdatedata.yml
@@ -0,0 +1,115 @@
+### 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: horizontalAlignment
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableCellUpdateData#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Specifies the horizontal alignment of the text in the table cell. Returns
+ `null` if the cell text contains different alignments.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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" | null;
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed" | null
+ - name: indentLevel
+ uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: >-
+ Specifies the indent level of the text in the table cell. Returns `null`
+ if the cell text contains different indent levels.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel?: number | null;'
+ return:
+ type: number | null
+ - 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
+ - name: textRuns
+ uid: powerpoint!PowerPoint.Interfaces.TableCellUpdateData#textRuns:member
+ package: powerpoint!
+ fullName: textRuns
+ summary: >-
+ Specifies the contents of the table cell as an array of
+ [PowerPoint.TextRun](xref:powerpoint!PowerPoint.TextRun:interface)
+ objects. Each `TextRun` object represents a sequence of one or more
+ characters that share the same font attributes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Interfaces.TableCellUpdateData#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: Specifies the vertical alignment of the text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectiondata.yml
new file mode 100644
index 0000000000..1c18f9c9bb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableColumnCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableColumnCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableColumnCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableColumnCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableColumnCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableColumnData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectionloadoptions.yml
new file mode 100644
index 0000000000..ee077ccb01
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectionloadoptions.yml
@@ -0,0 +1,71 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableColumnCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableColumnCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableColumnCollectionLoadOptions
+summary: Represents a collection of table columns.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableColumnCollectionLoadOptions#$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: columnIndex
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableColumnCollectionLoadOptions#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: >-
+ For EACH ITEM in the collection: Returns the index number of the column
+ within the column collection of the table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnIndex?: boolean;'
+ return:
+ type: boolean
+ - name: width
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableColumnCollectionLoadOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ For EACH ITEM in the collection: Retrieves the width of the column in
+ points. If the set column width is less than the minimum width, the column
+ width will be increased to the minimum width.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectionupdatedata.yml
new file mode 100644
index 0000000000..2b914a3d39
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumncollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableColumnCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableColumnCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableColumnCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableColumnCollection` object, for use
+ in `tableColumnCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableColumnCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableColumnData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumndata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumndata.yml
new file mode 100644
index 0000000000..ae047c525e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumndata.yml
@@ -0,0 +1,51 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableColumnData
+uid: powerpoint!PowerPoint.Interfaces.TableColumnData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableColumnData
+summary: >-
+ An interface describing the data returned by calling
+ `tableColumn.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: columnIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableColumnData#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: >-
+ Returns the index number of the column within the column collection of the
+ table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnIndex?: number;'
+ return:
+ type: number
+ - name: width
+ uid: powerpoint!PowerPoint.Interfaces.TableColumnData#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Retrieves the width of the column in points. If the set column width is
+ less than the minimum width, the column width will be increased to the
+ minimum width.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.tablecolumnloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumnloadoptions.yml
new file mode 100644
index 0000000000..49876cb961
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumnloadoptions.yml
@@ -0,0 +1,68 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableColumnLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableColumnLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableColumnLoadOptions
+summary: Represents a column in a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TableColumnLoadOptions#$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: columnIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableColumnLoadOptions#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: >-
+ Returns the index number of the column within the column collection of the
+ table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnIndex?: boolean;'
+ return:
+ type: boolean
+ - name: width
+ uid: powerpoint!PowerPoint.Interfaces.TableColumnLoadOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Retrieves the width of the column in points. If the set column width is
+ less than the minimum width, the column width will be increased to the
+ minimum width.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumnupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumnupdatedata.yml
new file mode 100644
index 0000000000..c5978f8437
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablecolumnupdatedata.yml
@@ -0,0 +1,33 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableColumnUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableColumnUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableColumnUpdateData
+summary: >-
+ An interface for updating data on the `TableColumn` object, for use in
+ `tableColumn.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: width
+ uid: powerpoint!PowerPoint.Interfaces.TableColumnUpdateData#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Retrieves the width of the column in points. If the set column width is
+ less than the minimum width, the column width will be increased to the
+ minimum width.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.tabledata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tabledata.yml
new file mode 100644
index 0000000000..0cb2e59f2f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tableloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tableloadoptions.yml
new file mode 100644
index 0000000000..e0c116265e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tableloadoptions.yml
@@ -0,0 +1,98 @@
+### 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: styleSettings
+ uid: powerpoint!PowerPoint.Interfaces.TableLoadOptions#styleSettings:member
+ package: powerpoint!
+ fullName: styleSettings
+ summary: Gets the table style settings.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions;'
+ return:
+ type: >-
+
+ - 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_10/powerpoint/powerpoint.interfaces.tablerowcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectiondata.yml
new file mode 100644
index 0000000000..40050b7418
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectiondata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableRowCollectionData
+uid: powerpoint!PowerPoint.Interfaces.TableRowCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableRowCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `tableRowCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableRowCollectionData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableRowData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectionloadoptions.yml
new file mode 100644
index 0000000000..ecc855ccd1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectionloadoptions.yml
@@ -0,0 +1,89 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableRowCollectionLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableRowCollectionLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableRowCollectionLoadOptions
+summary: Represents a collection of table rows.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TableRowCollectionLoadOptions#$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: currentHeight
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableRowCollectionLoadOptions#currentHeight:member
+ package: powerpoint!
+ fullName: currentHeight
+ summary: >-
+ For EACH ITEM in the collection: Retrieves the current height of the row
+ in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'currentHeight?: boolean;'
+ return:
+ type: boolean
+ - name: height
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableRowCollectionLoadOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ For EACH ITEM in the collection: Specifies the height of the row in
+ points. If the set row height is less than the minimum height, the row
+ height will be increased to the minimum height.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: boolean;'
+ return:
+ type: boolean
+ - name: rowIndex
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableRowCollectionLoadOptions#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: >-
+ For EACH ITEM in the collection: Returns the index number of the row
+ within the rows collection of the table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowIndex?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectionupdatedata.yml
new file mode 100644
index 0000000000..1ea210cba2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowcollectionupdatedata.yml
@@ -0,0 +1,29 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableRowCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableRowCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableRowCollectionUpdateData
+summary: >-
+ An interface for updating data on the `TableRowCollection` object, for use in
+ `tableRowCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: powerpoint!PowerPoint.Interfaces.TableRowCollectionUpdateData#items:member
+ package: powerpoint!
+ fullName: items
+ summary: ''
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'items?: PowerPoint.Interfaces.TableRowData[];'
+ return:
+ type: >-
+ []
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowdata.yml
new file mode 100644
index 0000000000..ae49114963
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowdata.yml
@@ -0,0 +1,67 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableRowData
+uid: powerpoint!PowerPoint.Interfaces.TableRowData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableRowData
+summary: >-
+ An interface describing the data returned by calling `tableRow.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: currentHeight
+ uid: powerpoint!PowerPoint.Interfaces.TableRowData#currentHeight:member
+ package: powerpoint!
+ fullName: currentHeight
+ summary: Retrieves the current height of the row in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'currentHeight?: number;'
+ return:
+ type: number
+ - name: height
+ uid: powerpoint!PowerPoint.Interfaces.TableRowData#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height of the row in points. If the set row height is less
+ than the minimum height, the row height will be increased to the minimum
+ height.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: number;'
+ return:
+ type: number
+ - name: rowIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableRowData#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: >-
+ Returns the index number of the row within the rows collection of the
+ table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.interfaces.tablerowloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowloadoptions.yml
new file mode 100644
index 0000000000..9102a6d650
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowloadoptions.yml
@@ -0,0 +1,84 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableRowLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableRowLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableRowLoadOptions
+summary: Represents a row in a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TableRowLoadOptions#$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: currentHeight
+ uid: powerpoint!PowerPoint.Interfaces.TableRowLoadOptions#currentHeight:member
+ package: powerpoint!
+ fullName: currentHeight
+ summary: Retrieves the current height of the row in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'currentHeight?: boolean;'
+ return:
+ type: boolean
+ - name: height
+ uid: powerpoint!PowerPoint.Interfaces.TableRowLoadOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height of the row in points. If the set row height is less
+ than the minimum height, the row height will be increased to the minimum
+ height.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: boolean;'
+ return:
+ type: boolean
+ - name: rowIndex
+ uid: powerpoint!PowerPoint.Interfaces.TableRowLoadOptions#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: >-
+ Returns the index number of the row within the rows collection of the
+ table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowIndex?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowupdatedata.yml
new file mode 100644
index 0000000000..ecc82023b5
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablerowupdatedata.yml
@@ -0,0 +1,33 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableRowUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableRowUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableRowUpdateData
+summary: >-
+ An interface for updating data on the `TableRow` object, for use in
+ `tableRow.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: height
+ uid: powerpoint!PowerPoint.Interfaces.TableRowUpdateData#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height of the row in points. If the set row height is less
+ than the minimum height, the row height will be increased to the minimum
+ height.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height?: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsdata.yml
new file mode 100644
index 0000000000..20c647f335
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsdata.yml
@@ -0,0 +1,188 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableStyleSettingsData
+uid: powerpoint!PowerPoint.Interfaces.TableStyleSettingsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableStyleSettingsData
+summary: >-
+ An interface describing the data returned by calling
+ `tableStyleSettings.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: areColumnsBanded
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsData#areColumnsBanded:member
+ package: powerpoint!
+ fullName: areColumnsBanded
+ summary: >-
+ Specifies if the columns show banded formatting in which odd columns are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areColumnsBanded?: boolean;'
+ return:
+ type: boolean
+ - name: areRowsBanded
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsData#areRowsBanded:member
+ package: powerpoint!
+ fullName: areRowsBanded
+ summary: >-
+ Specifies if the rows show banded formatting in which odd rows are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areRowsBanded?: boolean;'
+ return:
+ type: boolean
+ - name: isFirstColumnHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsData#isFirstColumnHighlighted:member
+ package: powerpoint!
+ fullName: isFirstColumnHighlighted
+ summary: Specifies if the first column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstColumnHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isFirstRowHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsData#isFirstRowHighlighted:member
+ package: powerpoint!
+ fullName: isFirstRowHighlighted
+ summary: Specifies if the first row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstRowHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isLastColumnHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsData#isLastColumnHighlighted:member
+ package: powerpoint!
+ fullName: isLastColumnHighlighted
+ summary: Specifies if the last column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastColumnHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isLastRowHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsData#isLastRowHighlighted:member
+ package: powerpoint!
+ fullName: isLastRowHighlighted
+ summary: Specifies if the last row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastRowHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: style
+ uid: powerpoint!PowerPoint.Interfaces.TableStyleSettingsData#style:member
+ package: powerpoint!
+ fullName: style
+ summary: Specifies the table style.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1"
+ | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4"
+ | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" |
+ "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" |
+ "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" |
+ "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" |
+ "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" |
+ "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" |
+ "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" |
+ "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" |
+ "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" |
+ "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" |
+ "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" |
+ "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" |
+ "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" |
+ "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" |
+ "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" |
+ "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" |
+ "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" |
+ "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" |
+ "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" |
+ "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ return:
+ type: >-
+ | "NoStyleNoGrid"
+ | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" |
+ "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5"
+ | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" |
+ "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4"
+ | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" |
+ "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" |
+ "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" |
+ "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" |
+ "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" |
+ "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" |
+ "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" |
+ "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" |
+ "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3"
+ | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4"
+ | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3"
+ | "MediumStyle3Accent4" | "MediumStyle3Accent5" |
+ "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" |
+ "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4"
+ | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" |
+ "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" |
+ "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" |
+ "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" |
+ "DarkStyle2Accent3"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsloadoptions.yml
new file mode 100644
index 0000000000..1b44c7f394
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsloadoptions.yml
@@ -0,0 +1,154 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableStyleSettingsLoadOptions
+uid: powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableStyleSettingsLoadOptions
+summary: Represents the available table style settings.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: $all
+ uid: powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#$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: areColumnsBanded
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#areColumnsBanded:member
+ package: powerpoint!
+ fullName: areColumnsBanded
+ summary: >-
+ Specifies if the columns show banded formatting in which odd columns are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areColumnsBanded?: boolean;'
+ return:
+ type: boolean
+ - name: areRowsBanded
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#areRowsBanded:member
+ package: powerpoint!
+ fullName: areRowsBanded
+ summary: >-
+ Specifies if the rows show banded formatting in which odd rows are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areRowsBanded?: boolean;'
+ return:
+ type: boolean
+ - name: isFirstColumnHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#isFirstColumnHighlighted:member
+ package: powerpoint!
+ fullName: isFirstColumnHighlighted
+ summary: Specifies if the first column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstColumnHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isFirstRowHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#isFirstRowHighlighted:member
+ package: powerpoint!
+ fullName: isFirstRowHighlighted
+ summary: Specifies if the first row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstRowHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isLastColumnHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#isLastColumnHighlighted:member
+ package: powerpoint!
+ fullName: isLastColumnHighlighted
+ summary: Specifies if the last column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastColumnHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isLastRowHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#isLastRowHighlighted:member
+ package: powerpoint!
+ fullName: isLastRowHighlighted
+ summary: Specifies if the last row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastRowHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: style
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsLoadOptions#style:member
+ package: powerpoint!
+ fullName: style
+ summary: Specifies the table style.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'style?: boolean;'
+ return:
+ type: boolean
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsupdatedata.yml
new file mode 100644
index 0000000000..01ee58d188
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tablestylesettingsupdatedata.yml
@@ -0,0 +1,188 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.TableStyleSettingsUpdateData
+uid: powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.TableStyleSettingsUpdateData
+summary: >-
+ An interface for updating data on the `TableStyleSettings` object, for use in
+ `tableStyleSettings.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: areColumnsBanded
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData#areColumnsBanded:member
+ package: powerpoint!
+ fullName: areColumnsBanded
+ summary: >-
+ Specifies if the columns show banded formatting in which odd columns are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areColumnsBanded?: boolean;'
+ return:
+ type: boolean
+ - name: areRowsBanded
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData#areRowsBanded:member
+ package: powerpoint!
+ fullName: areRowsBanded
+ summary: >-
+ Specifies if the rows show banded formatting in which odd rows are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areRowsBanded?: boolean;'
+ return:
+ type: boolean
+ - name: isFirstColumnHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData#isFirstColumnHighlighted:member
+ package: powerpoint!
+ fullName: isFirstColumnHighlighted
+ summary: Specifies if the first column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstColumnHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isFirstRowHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData#isFirstRowHighlighted:member
+ package: powerpoint!
+ fullName: isFirstRowHighlighted
+ summary: Specifies if the first row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstRowHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isLastColumnHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData#isLastColumnHighlighted:member
+ package: powerpoint!
+ fullName: isLastColumnHighlighted
+ summary: Specifies if the last column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastColumnHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: isLastRowHighlighted
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData#isLastRowHighlighted:member
+ package: powerpoint!
+ fullName: isLastRowHighlighted
+ summary: Specifies if the last row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastRowHighlighted?: boolean;'
+ return:
+ type: boolean
+ - name: style
+ uid: powerpoint!PowerPoint.Interfaces.TableStyleSettingsUpdateData#style:member
+ package: powerpoint!
+ fullName: style
+ summary: Specifies the table style.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1"
+ | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4"
+ | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" |
+ "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" |
+ "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" |
+ "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" |
+ "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" |
+ "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" |
+ "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" |
+ "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" |
+ "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" |
+ "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" |
+ "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" |
+ "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" |
+ "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" |
+ "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" |
+ "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" |
+ "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" |
+ "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" |
+ "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" |
+ "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" |
+ "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ return:
+ type: >-
+ | "NoStyleNoGrid"
+ | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" |
+ "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5"
+ | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" |
+ "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4"
+ | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" |
+ "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" |
+ "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" |
+ "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" |
+ "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" |
+ "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" |
+ "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" |
+ "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" |
+ "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3"
+ | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4"
+ | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3"
+ | "MediumStyle3Accent4" | "MediumStyle3Accent5" |
+ "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" |
+ "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4"
+ | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" |
+ "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" |
+ "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" |
+ "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" |
+ "DarkStyle2Accent3"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tagcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tagcollectiondata.yml
new file mode 100644
index 0000000000..0be0228d2c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tagcollectionloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tagcollectionloadoptions.yml
new file mode 100644
index 0000000000..e111b6f9a7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tagcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tagcollectionupdatedata.yml
new file mode 100644
index 0000000000..9d01dd8250
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tagdata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tagdata.yml
new file mode 100644
index 0000000000..2501ae228d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tagloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tagloadoptions.yml
new file mode 100644
index 0000000000..85f9d447f3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.tagupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.tagupdatedata.yml
new file mode 100644
index 0000000000..74a848caad
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.textframedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.textframedata.yml
new file mode 100644
index 0000000000..f8a3552e9b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.textframeloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.textframeloadoptions.yml
new file mode 100644
index 0000000000..e49ad3db77
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.textframeupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.textframeupdatedata.yml
new file mode 100644
index 0000000000..aa9601744f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.textrangedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.textrangedata.yml
new file mode 100644
index 0000000000..88541a58dd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.textrangeloadoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.textrangeloadoptions.yml
new file mode 100644
index 0000000000..05d4757ef9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.interfaces.textrangeupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.interfaces.textrangeupdatedata.yml
new file mode 100644
index 0000000000..8ae6d7ac85
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.margins.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.margins.yml
new file mode 100644
index 0000000000..7ad8222317
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.margins.yml
@@ -0,0 +1,197 @@
+### YamlMime:TSType
+name: PowerPoint.Margins
+uid: powerpoint!PowerPoint.Margins:class
+package: powerpoint!
+fullName: PowerPoint.Margins
+summary: Represents the margins of a table cell.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: bottom
+ uid: powerpoint!PowerPoint.Margins#bottom:member
+ package: powerpoint!
+ fullName: bottom
+ summary: Specifies the bottom margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'bottom: number | undefined;'
+ return:
+ type: number | undefined
+ - name: context
+ uid: powerpoint!PowerPoint.Margins#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: left
+ uid: powerpoint!PowerPoint.Margins#left:member
+ package: powerpoint!
+ fullName: left
+ summary: Specifies the left margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Margins#right:member
+ package: powerpoint!
+ fullName: right
+ summary: Specifies the right margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.Margins#top:member
+ package: powerpoint!
+ fullName: top
+ summary: Specifies the top margin in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top: number | undefined;'
+ return:
+ type: number | undefined
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.Margins#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.MarginsLoadOptions):
+ PowerPoint.Margins;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.Margins#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.Margins;'
+ 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.Margins#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.Margins;
+ 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.Margins#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.Margins`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.MarginsData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.MarginsData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.pagesetup.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.pagesetup.yml
new file mode 100644
index 0000000000..c7a3838d5a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.pagesetup.yml
@@ -0,0 +1,167 @@
+### YamlMime:TSType
+name: PowerPoint.PageSetup
+uid: powerpoint!PowerPoint.PageSetup:class
+package: powerpoint!
+fullName: PowerPoint.PageSetup
+summary: Represents the page setup information for the presentation.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.PageSetup#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: slideHeight
+ uid: powerpoint!PowerPoint.PageSetup#slideHeight:member
+ package: powerpoint!
+ fullName: slideHeight
+ summary: Specifies the height of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideHeight: number;'
+ return:
+ type: number
+ - name: slideWidth
+ uid: powerpoint!PowerPoint.PageSetup#slideWidth:member
+ package: powerpoint!
+ fullName: slideWidth
+ summary: Specifies the width of the slides in the presentation, in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'slideWidth: number;'
+ return:
+ type: number
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.PageSetup#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.PageSetupLoadOptions):
+ PowerPoint.PageSetup;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.PageSetup#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.PageSetup;'
+ 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.PageSetup#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.PageSetup;
+ 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.PageSetup#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.PageSetup`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.PageSetupData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.PageSetupData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.paragraphformat.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.paragraphformat.yml
new file mode 100644
index 0000000000..e41504dad3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.paragraphformat.yml
@@ -0,0 +1,239 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Gets navigational (complex) properties of the selected text range.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
+ await context.sync();
+
+ console.log("Font properties of selected text range:");
+ console.log(`\tallCaps: ${textRange.font.allCaps}`);
+ console.log(`\tbold: ${textRange.font.bold}`);
+ console.log(`\tcolor: ${textRange.font.color}`);
+ console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
+ console.log(`\titalic: ${textRange.font.italic}`);
+ console.log(`\tname: ${textRange.font.name}`);
+ console.log(`\tsize: ${textRange.font.size}`);
+ console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
+ console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
+ console.log(`\tsubscript: ${textRange.font.subscript}`);
+ console.log(`\tsuperscript: ${textRange.font.superscript}`);
+ console.log(`\tunderline: ${textRange.font.underline}`);
+
+ console.log("Paragraph format properties of selected text range:");
+ console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
+ console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
+ });
+
+ ```
+
+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" | null;
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed" | null
+ - name: indentLevel
+ uid: powerpoint!PowerPoint.ParagraphFormat#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: Represents the indent level of the paragraph.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel: number;'
+ return:
+ type: number
+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_10/powerpoint/powerpoint.paragraphhorizontalalignment.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.paragraphhorizontalalignment.yml
new file mode 100644
index 0000000000..562f2e6f9c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.paragraphhorizontalalignment.yml
@@ -0,0 +1,127 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the horizontal and vertical alignments of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying horizontal and vertical alignment.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment.justify,
+ verticalAlignment: PowerPoint.TextVerticalAlignment.middle
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+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's 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_10/powerpoint/powerpoint.placeholderformat.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.placeholderformat.yml
new file mode 100644
index 0000000000..4cc2837d8e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.placeholderformat.yml
@@ -0,0 +1,236 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Gets the placeholder shapes in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get properties for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type,name");
+ await context.sync();
+
+ const placeholderShapes = [];
+ console.log(`Number of shapes found: ${shapes.items.length}`);
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.placeholder) {
+ // Load placeholderFormat property.
+ // PowerPoint throws an exception if you try to load this property on a shape that isn't a placeholder type.
+ shape.load("placeholderFormat");
+ placeholderShapes.push(shape);
+ }
+ });
+ await context.sync();
+
+ console.log(`Number of placeholder shapes found: ${placeholderShapes.length}`);
+ for (let i = 0; i < placeholderShapes.length; i++) {
+ let currentPlaceholder: PowerPoint.PlaceholderFormat = placeholderShapes[i].placeholderFormat;
+ let placeholderType = currentPlaceholder.type as PowerPoint.PlaceholderType;
+ let placeholderContainedType = currentPlaceholder.containedType as PowerPoint.ShapeType;
+ console.log(`Shape "${placeholderShapes[i].name}" placeholder properties:`);
+ console.log(`\ttype: ${placeholderType}`);
+ console.log(`\tcontainedType: ${placeholderContainedType}`);
+ }
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.placeholdertype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.placeholdertype.yml
new file mode 100644
index 0000000000..145d6f15a2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.placeholdertype.yml
@@ -0,0 +1,277 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Gets the placeholder shapes in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get properties for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type,name");
+ await context.sync();
+
+ const placeholderShapes = [];
+ console.log(`Number of shapes found: ${shapes.items.length}`);
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.placeholder) {
+ // Load placeholderFormat property.
+ // PowerPoint throws an exception if you try to load this property on a shape that isn't a placeholder type.
+ shape.load("placeholderFormat");
+ placeholderShapes.push(shape);
+ }
+ });
+ await context.sync();
+
+ console.log(`Number of placeholder shapes found: ${placeholderShapes.length}`);
+ for (let i = 0; i < placeholderShapes.length; i++) {
+ let currentPlaceholder: PowerPoint.PlaceholderFormat = placeholderShapes[i].placeholderFormat;
+ let placeholderType = currentPlaceholder.type as PowerPoint.PlaceholderType;
+ let placeholderContainedType = currentPlaceholder.containedType as PowerPoint.ShapeType;
+ console.log(`Shape "${placeholderShapes[i].name}" placeholder properties:`);
+ console.log(`\ttype: ${placeholderType}`);
+ console.log(`\tcontainedType: ${placeholderContainedType}`);
+ }
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.presentation.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.presentation.yml
new file mode 100644
index 0000000000..42fd0fa5d3
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.presentation.yml
@@ -0,0 +1,805 @@
+### YamlMime:TSType
+name: PowerPoint.Presentation
+uid: powerpoint!PowerPoint.Presentation:class
+package: powerpoint!
+fullName: PowerPoint.Presentation
+summary: >-
+ The `Presentation` object is the top-level object with one or more slides that
+ contain the contents of the presentation. To learn more about the PowerPoint
+ object model, see [PowerPoint JavaScript object
+ model](https://learn.microsoft.com/office/dev/add-ins/powerpoint/core-concepts).
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ // Loads bindings.
+
+ await PowerPoint.run(async (context) => {
+ const bindings = context.presentation.bindings;
+ bindings.load("items");
+ await context.sync();
+
+ const bindingCount = bindings.items.length;
+ if (bindingCount === 0) {
+ console.log(`There are no bindings.`);
+ } else if (bindingCount === 1) {
+ console.log("There's 1 binding.");
+ } else {
+ console.log(`There are ${bindingCount} bindings.`);
+ }
+
+ bindings.items.forEach((binding) => {
+ getShapeForBindingId(binding.id).then((shape) => {
+ if (shape) {
+ console.log(`Binding ID: ${binding.id} refers to shape ID ${shape.id}`);
+ } else {
+ console.log(`Binding ID: ${binding.id} doesn't refers to shape.`);
+ }
+ });
+ });
+
+ populateBindingsDropdown(bindings.items);
+ });
+
+ ```
+
+ 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: pageSetup
+ uid: powerpoint!PowerPoint.Presentation#pageSetup:member
+ package: powerpoint!
+ fullName: pageSetup
+ summary: >-
+ Returns the page setup information whose properties control slide setup
+ attributes for the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly pageSetup: PowerPoint.PageSetup;'
+ return:
+ type:
+ - 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: Returns the title of the presentation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.0](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ 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. 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: '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_10/powerpoint/powerpoint.requestcontext.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.requestcontext.yml
new file mode 100644
index 0000000000..6e9d64147a
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.shape.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shape.yml
new file mode 100644
index 0000000000..61cf4778e9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shape.yml
@@ -0,0 +1,1383 @@
+### 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: adjustments
+ uid: powerpoint!PowerPoint.Shape#adjustments:member
+ package: powerpoint!
+ fullName: adjustments
+ summary: >-
+ Returns an `Adjustments` object that contains adjustment values for all
+ the adjustments in this shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly adjustments: PowerPoint.Adjustments;'
+ return:
+ type:
+ - name: altTextDescription
+ uid: powerpoint!PowerPoint.Shape#altTextDescription:member
+ package: powerpoint!
+ fullName: altTextDescription
+ summary: >-
+ The alt text description of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextDescription: string;'
+ return:
+ type: string
+ - name: altTextTitle
+ uid: powerpoint!PowerPoint.Shape#altTextTitle:member
+ package: powerpoint!
+ fullName: altTextTitle
+ summary: >-
+ The alt text title of the Shape.
+
+
+ Alt text provides alternative, text-based representations of the
+ information contained in the Shape. This information is useful for people
+ with vision or cognitive impairments who may not be able to see or
+ understand the shape. A title can be read to a person with a disability
+ and is used to determine whether they wish to hear the description of the
+ content.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'altTextTitle: string;'
+ return:
+ type: string
+ - 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: creationId
+ uid: powerpoint!PowerPoint.Shape#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ Gets the creation ID of the shape. Returns `null` if the shape has no
+ creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly creationId: string | null;'
+ return:
+ type: string | null
+ - 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/fill/type");
+ await context.sync();
+ shapes.items.map((shape) => {
+ const shapeFillType = shape.fill.type as PowerPoint.ShapeFillType;
+ console.log(`Shape ID ${shape.id} original fill type: ${shapeFillType}`);
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/group-ungroup-shapes.yaml
+
+
+ await PowerPoint.run(async (context) => {
+ // Ungroups the first shape group on the current slide.
+
+ // Get the shapes on the current slide.
+ context.presentation.load("slides");
+ const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
+ slide.load("shapes/items/type,shapes/items/id");
+ await context.sync();
+
+ const shapes: PowerPoint.ShapeCollection = slide.shapes;
+ const shapeGroups = shapes.items.filter((item) => item.type === PowerPoint.ShapeType.group);
+ if (shapeGroups.length === 0) {
+ console.warn("No shape groups on the current slide, so nothing to ungroup.");
+ return;
+ }
+
+ // Ungroup the first grouped shapes.
+ const firstGroupId = shapeGroups[0].id;
+ const shapeGroupToUngroup = shapes.getItem(firstGroupId);
+ shapeGroupToUngroup.group.ungroup();
+ await context.sync();
+
+ console.log(`Ungrouped shapes with group ID: ${firstGroupId}`);
+ });
+
+ ```
+
+ 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: isDecorative
+ uid: powerpoint!PowerPoint.Shape#isDecorative:member
+ package: powerpoint!
+ fullName: isDecorative
+ summary: >-
+ Represents whether the shape is decorative or not.
+
+
+ Decorative objects add visual interest but aren't informative (e.g.
+ stylistic borders). People using screen readers will hear these are
+ decorative so they know they aren't missing any important information.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isDecorative: boolean;'
+ return:
+ type: boolean
+ - 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
+
+
+ // Gets the placeholder shapes in the slide.
+
+ await PowerPoint.run(async (context) => {
+ // Get properties for every shape in the collection.
+ const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
+ shapes.load("type,name");
+ await context.sync();
+
+ const placeholderShapes = [];
+ console.log(`Number of shapes found: ${shapes.items.length}`);
+ shapes.items.forEach((shape) => {
+ if (shape.type === PowerPoint.ShapeType.placeholder) {
+ // Load placeholderFormat property.
+ // PowerPoint throws an exception if you try to load this property on a shape that isn't a placeholder type.
+ shape.load("placeholderFormat");
+ placeholderShapes.push(shape);
+ }
+ });
+ await context.sync();
+
+ console.log(`Number of placeholder shapes found: ${placeholderShapes.length}`);
+ for (let i = 0; i < placeholderShapes.length; i++) {
+ let currentPlaceholder: PowerPoint.PlaceholderFormat = placeholderShapes[i].placeholderFormat;
+ let placeholderType = currentPlaceholder.type as PowerPoint.PlaceholderType;
+ let placeholderContainedType = currentPlaceholder.containedType as PowerPoint.ShapeType;
+ console.log(`Shape "${placeholderShapes[i].name}" placeholder properties:`);
+ console.log(`\ttype: ${placeholderType}`);
+ console.log(`\tcontainedType: ${placeholderContainedType}`);
+ }
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly placeholderFormat: PowerPoint.PlaceholderFormat;'
+ return:
+ type:
+ - name: rotation
+ uid: powerpoint!PowerPoint.Shape#rotation:member
+ package: powerpoint!
+ fullName: rotation
+ summary: >-
+ Specifies the rotation, in degrees, of the shape around the z-axis. A
+ positive value indicates clockwise rotation, and a negative value
+ indicates counterclockwise rotation.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rotation: number;'
+ return:
+ type: number
+ - 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
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) object
+ of this `Shape`. Throws an `InvalidArgument` exception if the
+ shape doesn't support a `TextFrame`.
+ 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: visible
+ uid: powerpoint!PowerPoint.Shape#visible:member
+ package: powerpoint!
+ fullName: visible
+ summary: Specifies if the shape is visible.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'visible: boolean;'
+ return:
+ type: boolean
+ - 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ async function changeZOrder(operation: PowerPoint.ShapeZOrder) {
+ // Changes the z-order position of the selected shapes.
+ return PowerPoint.run(async (context) => {
+ const selectedShapes = context.presentation.getSelectedShapes();
+ selectedShapes.load();
+ await context.sync();
+
+ if (selectedShapes.items.length === 0) {
+ console.log("No shapes are selected.");
+ } else {
+ let direction = 1; // Start with bottom-most (lowest number).
+
+ // Start with top-most when sending to back or bringing forward.
+
+ switch (operation) {
+ case PowerPoint.ShapeZOrder.bringForward:
+
+ case PowerPoint.ShapeZOrder.sendToBack:
+ direction = -1; // Reverse direction.
+
+ break;
+ }
+
+ // Change the z-order position for each of the selected shapes,
+
+ // starting with the bottom-most when bringing to front or sending backward,
+
+ // or top-most when sending to back or bringing forward,
+
+ // so the selected shapes retain their relative z-order positions after they're changed.
+
+ selectedShapes.items
+ .sort((a, b) => (a.zOrderPosition - b.zOrderPosition) * direction)
+ .forEach((shape) => {
+ try {
+ const originalZOrderPosition = shape.zOrderPosition;
+ shape.setZOrder(operation);
+
+ console.log(`Changed z-order of shape ${shape.id}.`);
+ } catch (err) {
+ console.log(`Unable to change z-order of shape ${shape.id}. ${err.message}`);
+ }
+ });
+
+ await context.sync();
+ }
+ });
+ }
+
+ ```
+
+ 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
+ doesn't 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: getImageAsBase64(options)
+ uid: powerpoint!PowerPoint.Shape#getImageAsBase64:member(1)
+ package: powerpoint!
+ fullName: getImageAsBase64(options)
+ summary: Renders an image of the shape.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions):
+ OfficeExtension.ClientResult;
+ parameters:
+ - id: options
+ description: Optional. Options to specify the desired output image properties.
+ type:
+ return:
+ type: <string>
+ description: A Base64-encoded string of the shape image in the specified format.
+ - 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 doesn't
+ 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
+ doesn't 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 doesn't belong to a
+ `SlideLayout`, 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: '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
+ doesn't 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 doesn't belong to a
+ `SlideMaster`, 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: '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 doesn't belong to a `Slide`, 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: '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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Gets the table from a shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+
+ if (shapeCount.value > 0) {
+ const shape = shapes.getItemAt(0);
+ shape.load("type");
+ await context.sync();
+
+ // The shape type can indicate whether the shape is a table.
+ const isTable = shape.type === PowerPoint.ShapeType.table;
+
+ if (isTable) {
+ // Get the Table object for the Shape which is a table.
+ const table = shape.getTable();
+ table.load();
+ await context.sync();
+
+ // Get the Table row and column count.
+ console.log("Table RowCount: " + table.rowCount + " and columnCount: " + table.columnCount);
+ } else console.log("Selected shape isn't table.");
+ } else console.log("No shape selected.");
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTable(): PowerPoint.Table;'
+ return:
+ type:
+ description: ''
+ - name: getTextFrameOrNullObject()
+ uid: powerpoint!PowerPoint.Shape#getTextFrameOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getTextFrameOrNullObject()
+ summary: >-
+ Returns the
+ [PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) object
+ of this `Shape`. If the shape doesn't support a `TextFrame`, 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTextFrameOrNullObject(): PowerPoint.TextFrame;'
+ 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: setHyperlink(options)
+ uid: powerpoint!PowerPoint.Shape#setHyperlink:member(1)
+ package: powerpoint!
+ fullName: setHyperlink(options)
+ summary: >-
+ Sets a hyperlink on this `Shape` with the specified options. This will
+ delete any existing hyperlink on this `Shape`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setHyperlink(options?: PowerPoint.HyperlinkAddOptions):
+ PowerPoint.Hyperlink;
+ parameters:
+ - id: options
+ description: Optional. The options for the hyperlink.
+ type:
+ return:
+ type:
+ description: >-
+ The newly created
+ [PowerPoint.Hyperlink](xref:powerpoint!PowerPoint.Hyperlink:class)
+ object.
+ - 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ async function changeZOrder(operation: PowerPoint.ShapeZOrder) {
+ // Changes the z-order position of the selected shapes.
+ return PowerPoint.run(async (context) => {
+ const selectedShapes = context.presentation.getSelectedShapes();
+ selectedShapes.load();
+ await context.sync();
+
+ if (selectedShapes.items.length === 0) {
+ console.log("No shapes are selected.");
+ } else {
+ let direction = 1; // Start with bottom-most (lowest number).
+
+ // Start with top-most when sending to back or bringing forward.
+
+ switch (operation) {
+ case PowerPoint.ShapeZOrder.bringForward:
+
+ case PowerPoint.ShapeZOrder.sendToBack:
+ direction = -1; // Reverse direction.
+
+ break;
+ }
+
+ // Change the z-order position for each of the selected shapes,
+
+ // starting with the bottom-most when bringing to front or sending backward,
+
+ // or top-most when sending to back or bringing forward,
+
+ // so the selected shapes retain their relative z-order positions after they're changed.
+
+ selectedShapes.items
+ .sort((a, b) => (a.zOrderPosition - b.zOrderPosition) * direction)
+ .forEach((shape) => {
+ try {
+ const originalZOrderPosition = shape.zOrderPosition;
+ shape.setZOrder(operation);
+
+ console.log(`Changed z-order of shape ${shape.id}.`);
+ } catch (err) {
+ console.log(`Unable to change z-order of shape ${shape.id}. ${err.message}`);
+ }
+ });
+
+ await context.sync();
+ }
+ });
+ }
+
+ ```
+
+ 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(position)
+ uid: powerpoint!PowerPoint.Shape#setZOrder:member(2)
+ 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: "BringForward" | "BringToFront" | "SendBackward" |
+ "SendToBack"): void;
+ parameters:
+ - id: position
+ 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_10/powerpoint/powerpoint.shapeaddoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapeaddoptions.yml
new file mode 100644
index 0000000000..03ad3048d8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.shapeautosize.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapeautosize.yml
new file mode 100644
index 0000000000..d057bdca71
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapeautosize.yml
@@ -0,0 +1,96 @@
+### 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)
+ \]
+
+
+ #### 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.textRange.font.underline = PowerPoint.ShapeFontUnderlineStyle.heavy;
+ braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
+ braces.textFrame.autoSizeSetting = PowerPoint.ShapeAutoSize.autoSizeShapeToFitText;
+
+ return context.sync();
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.shapecollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapecollection.yml
new file mode 100644
index 0000000000..e7c1fe15fc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapecollection.yml
@@ -0,0 +1,847 @@
+### 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(geometricShapeType, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addGeometricShape:member(2)
+ 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)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ 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;
+ parameters:
+ - id: geometricShapeType
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/group-ungroup-shapes.yaml
+
+
+ await PowerPoint.run(async (context) => {
+ // Groups the geometric shapes on the current slide.
+
+ // Get the shapes on the current slide.
+ context.presentation.load("slides");
+ const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
+ slide.load("shapes/items/type,shapes/items/id");
+ await context.sync();
+
+ const shapes: PowerPoint.ShapeCollection = slide.shapes;
+ const shapesToGroup = shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
+ if (shapesToGroup.length === 0) {
+ console.warn("No shapes on the current slide, so nothing to group.");
+ return;
+ }
+
+ // Group the geometric shapes.
+ console.log(`Number of shapes to group: ${shapesToGroup.length}`);
+ const group = shapes.addGroup(shapesToGroup);
+ group.load("id");
+ await context.sync();
+
+ console.log(`Grouped shapes. Group ID: ${group.id}`);
+ });
+
+ ```
+
+ 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(connectorType, options)
+ uid: powerpoint!PowerPoint.ShapeCollection#addLine:member(2)
+ 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)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ addLine(connectorType?: "Straight" | "Elbow" | "Curve", 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: '"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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Adds a basic table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a simple table, specifying the row and column count.
+ shapes.addTable(3, 4);
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Gets the table from a shape.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedShapes();
+ const shapeCount = shapes.getCount();
+ shapes.load("items");
+ await context.sync();
+
+ if (shapeCount.value > 0) {
+ const shape = shapes.getItemAt(0);
+ shape.load("type");
+ await context.sync();
+
+ // The shape type can indicate whether the shape is a table.
+ const isTable = shape.type === PowerPoint.ShapeType.table;
+
+ if (isTable) {
+ // Get the Table object for the Shape which is a table.
+ const table = shape.getTable();
+ table.load();
+ await context.sync();
+
+ // Get the Table row and column count.
+ console.log("Table RowCount: " + table.rowCount + " and columnCount: " + table.columnCount);
+ } else console.log("Selected shape isn't table.");
+ } else console.log("No shape selected.");
+ });
+
+ ```
+
+ 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 doesn't
+ 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 doesn't 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 doesn't 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.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 doesn't 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_10/powerpoint/powerpoint.shapefill.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefill.yml
new file mode 100644
index 0000000000..d8f9fecee9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefill.yml
@@ -0,0 +1,455 @@
+### 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 outputSpan = document.getElementById("outputSpan");
+ outputSpan.innerHTML = "";
+ outputSpan.innerHTML += finalTable;
+ });
+
+ ```
+
+ 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 doesn't
+ 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)
+ \]
+
+
+ #### 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/fill/type");
+ await context.sync();
+ shapes.items.map((shape) => {
+ const shapeFillType = shape.fill.type as PowerPoint.ShapeFillType;
+ console.log(`Shape ID ${shape.id} original fill type: ${shapeFillType}`);
+ shape.fill.setSolidColor("red");
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ // Inserts an image with binding.
+
+ await PowerPoint.run(async (context) => {
+ const bindingId = (document.getElementById("temp-binding-id") as HTMLInputElement).value;
+ const slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const myShape = slide.shapes.addGeometricShape(PowerPoint.GeometricShapeType.rectangle, {
+ top: 100,
+ left: 30,
+ width: 200,
+ height: 200
+ });
+
+ myShape.fill.setImage(flowerImage);
+ context.presentation.bindings.add(myShape, PowerPoint.BindingType.shape, bindingId);
+ await context.sync();
+
+ const bindingsDropdown = document.getElementById("bindings-dropdown") as HTMLSelectElement;
+
+ const option = new Option(`Binding ${bindingId}`, bindingId);
+
+ // When a binding ID already exists, the binding is updated to refer to the new shape
+ // so select the existing item rather than add a new one.
+ const foundIndex = findDropdownItem(bindingsDropdown, option.text);
+ if (foundIndex < 0) {
+ bindingsDropdown.add(option);
+ bindingsDropdown.selectedIndex = bindingsDropdown.options.length - 1;
+ } else {
+ bindingsDropdown.selectedIndex = foundIndex;
+ }
+ });
+
+ ```
+
+ 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/fill/type");
+ await context.sync();
+ shapes.items.map((shape) => {
+ const shapeFillType = shape.fill.type as PowerPoint.ShapeFillType;
+ console.log(`Shape ID ${shape.id} original fill type: ${shapeFillType}`);
+ 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_10/powerpoint/powerpoint.shapefilltype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefilltype.yml
new file mode 100644
index 0000000000..aee792fcef
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefilltype.yml
@@ -0,0 +1,107 @@
+### 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)
+ \]
+
+
+ #### 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/fill/type");
+ await context.sync();
+ shapes.items.map((shape) => {
+ const shapeFillType = shape.fill.type as PowerPoint.ShapeFillType;
+ console.log(`Shape ID ${shape.id} original fill type: ${shapeFillType}`);
+ shape.fill.setSolidColor("red");
+ });
+ await context.sync();
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.shapefont.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefont.yml
new file mode 100644
index 0000000000..49511d6ce5
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefont.yml
@@ -0,0 +1,547 @@
+### 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
+
+
+ // Gets navigational (complex) properties of the selected text range.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
+ await context.sync();
+
+ console.log("Font properties of selected text range:");
+ console.log(`\tallCaps: ${textRange.font.allCaps}`);
+ console.log(`\tbold: ${textRange.font.bold}`);
+ console.log(`\tcolor: ${textRange.font.color}`);
+ console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
+ console.log(`\titalic: ${textRange.font.italic}`);
+ console.log(`\tname: ${textRange.font.name}`);
+ console.log(`\tsize: ${textRange.font.size}`);
+ console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
+ console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
+ console.log(`\tsubscript: ${textRange.font.subscript}`);
+ console.log(`\tsuperscript: ${textRange.font.superscript}`);
+ console.log(`\tunderline: ${textRange.font.underline}`);
+
+ console.log("Paragraph format properties of selected text range:");
+ console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
+ console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### 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.textRange.font.underline = PowerPoint.ShapeFontUnderlineStyle.heavy;
+ braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
+ braces.textFrame.autoSizeSetting = PowerPoint.ShapeAutoSize.autoSizeShapeToFitText;
+
+ return context.sync();
+ });
+
+ ```
+
+ 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_10/powerpoint/powerpoint.shapefontunderlinestyle.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefontunderlinestyle.yml
new file mode 100644
index 0000000000..61b09a2019
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapefontunderlinestyle.yml
@@ -0,0 +1,239 @@
+### 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)
+ \]
+
+
+ #### 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.textRange.font.underline = PowerPoint.ShapeFontUnderlineStyle.heavy;
+ braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
+ braces.textFrame.autoSizeSetting = PowerPoint.ShapeAutoSize.autoSizeShapeToFitText;
+
+ return context.sync();
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.shapegetimageformattype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapegetimageformattype.yml
new file mode 100644
index 0000000000..b6a7e188c7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapegetimageformattype.yml
@@ -0,0 +1,25 @@
+### YamlMime:TSEnum
+name: PowerPoint.ShapeGetImageFormatType
+uid: powerpoint!PowerPoint.ShapeGetImageFormatType:enum
+package: powerpoint!
+fullName: PowerPoint.ShapeGetImageFormatType
+summary: Represents the format of an image.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: png
+ uid: powerpoint!PowerPoint.ShapeGetImageFormatType.png:member
+ package: powerpoint!
+ summary: >-
+ The picture is in PNG format.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Png"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapegetimageoptions.yml
new file mode 100644
index 0000000000..94a42172ec
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapegetimageoptions.yml
@@ -0,0 +1,79 @@
+### YamlMime:TSType
+name: PowerPoint.ShapeGetImageOptions
+uid: powerpoint!PowerPoint.ShapeGetImageOptions:interface
+package: powerpoint!
+fullName: PowerPoint.ShapeGetImageOptions
+summary: >-
+ Represents the available options when getting an image of a shape. The image
+ is scaled to fit into the desired dimensions. If width and height aren't
+ specified, the true size of the shape is used. If only one of either width or
+ height is specified, the other will be calculated to preserve aspect ratio.
+ The resulting dimensions will automatically be clamped to the maximum
+ supported size if too large.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: format
+ uid: powerpoint!PowerPoint.ShapeGetImageOptions#format:member
+ package: powerpoint!
+ fullName: format
+ summary: The desired format of the resulting image.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'format?: PowerPoint.ShapeGetImageFormatType | "Png";'
+ return:
+ type: >-
+ |
+ "Png"
+ - name: height
+ uid: powerpoint!PowerPoint.ShapeGetImageOptions#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ The desired height of the resulting image in pixels. This value will
+ automatically be clamped to the maximum supported size if too large.
+ Throws an `InvalidArgument` exception when set with a non-positive
+ integer.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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.ShapeGetImageOptions#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ The desired width of the resulting image in pixels. This value will
+ automatically be clamped to the maximum supported size if too large.
+ Throws an `InvalidArgument` exception when set with a non-positive
+ integer.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.shapegroup.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapegroup.yml
new file mode 100644
index 0000000000..09b3299daf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapegroup.yml
@@ -0,0 +1,294 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/group-ungroup-shapes.yaml
+
+
+ await PowerPoint.run(async (context) => {
+ // Ungroups the first shape group on the current slide.
+
+ // Get the shapes on the current slide.
+ context.presentation.load("slides");
+ const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
+ slide.load("shapes/items/type,shapes/items/id");
+ await context.sync();
+
+ const shapes: PowerPoint.ShapeCollection = slide.shapes;
+ const shapeGroups = shapes.items.filter((item) => item.type === PowerPoint.ShapeType.group);
+ if (shapeGroups.length === 0) {
+ console.warn("No shape groups on the current slide, so nothing to ungroup.");
+ return;
+ }
+
+ // Ungroup the first grouped shapes.
+ const firstGroupId = shapeGroups[0].id;
+ const shapeGroupToUngroup = shapes.getItem(firstGroupId);
+ shapeGroupToUngroup.group.ungroup();
+ await context.sync();
+
+ console.log(`Ungrouped shapes with group ID: ${firstGroupId}`);
+ });
+
+ ```
+
+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: creationId
+ uid: powerpoint!PowerPoint.ShapeGroup#creationId:member
+ package: powerpoint!
+ fullName: creationId
+ summary: >-
+ Gets the creation ID of the shape group. Returns `null` if the shape group
+ has no creation ID.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly creationId: string | null;'
+ return:
+ type: string | null
+ - 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/group-ungroup-shapes.yaml
+
+
+ await PowerPoint.run(async (context) => {
+ // Ungroups the first shape group on the current slide.
+
+ // Get the shapes on the current slide.
+ context.presentation.load("slides");
+ const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
+ slide.load("shapes/items/type,shapes/items/id");
+ await context.sync();
+
+ const shapes: PowerPoint.ShapeCollection = slide.shapes;
+ const shapeGroups = shapes.items.filter((item) => item.type === PowerPoint.ShapeType.group);
+ if (shapeGroups.length === 0) {
+ console.warn("No shape groups on the current slide, so nothing to ungroup.");
+ return;
+ }
+
+ // Ungroup the first grouped shapes.
+ const firstGroupId = shapeGroups[0].id;
+ const shapeGroupToUngroup = shapes.getItem(firstGroupId);
+ shapeGroupToUngroup.group.ungroup();
+ await context.sync();
+
+ console.log(`Ungrouped shapes with group ID: ${firstGroupId}`);
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'ungroup(): void;'
+ return:
+ type: void
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapelinedashstyle.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapelinedashstyle.yml
new file mode 100644
index 0000000000..c417b91b7c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapelinedashstyle.yml
@@ -0,0 +1,176 @@
+### 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.style = PowerPoint.ShapeLineStyle.thickThin;
+ 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_10/powerpoint/powerpoint.shapelineformat.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapelineformat.yml
new file mode 100644
index 0000000000..4e55996ff5
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapelineformat.yml
@@ -0,0 +1,323 @@
+### 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.style = PowerPoint.ShapeLineStyle.thickThin;
+ 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 isn't
+ visible or there are inconsistent dash styles. See
+ [PowerPoint.ShapeLineDashStyle](xref:powerpoint!PowerPoint.ShapeLineDashStyle: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 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.style = PowerPoint.ShapeLineStyle.thickThin;
+ 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 isn't
+ visible or there are inconsistent styles. See
+ [PowerPoint.ShapeLineStyle](xref:powerpoint!PowerPoint.ShapeLineStyle:enum)
+ 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
+ isn't 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_10/powerpoint/powerpoint.shapelinestyle.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapelinestyle.yml
new file mode 100644
index 0000000000..986825ba55
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapelinestyle.yml
@@ -0,0 +1,103 @@
+### 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)
+ \]
+
+
+ #### 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.style = PowerPoint.ShapeLineStyle.thickThin;
+ shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.shapescopedcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapescopedcollection.yml
new file mode 100644
index 0000000000..a00e82634f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapescopedcollection.yml
@@ -0,0 +1,327 @@
+### 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/fill/type");
+ await context.sync();
+ shapes.items.map((shape) => {
+ const shapeFillType = shape.fill.type as PowerPoint.ShapeFillType;
+ console.log(`Shape ID ${shape.id} original fill type: ${shapeFillType}`);
+ 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 doesn't
+ 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 doesn't 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 doesn't 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.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 doesn't 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_10/powerpoint/powerpoint.shapetype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapetype.yml
new file mode 100644
index 0000000000..759245c584
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapetype.yml
@@ -0,0 +1,253 @@
+### 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.style = PowerPoint.ShapeLineStyle.thickThin;
+ 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_10/powerpoint/powerpoint.shapezorder.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapezorder.yml
new file mode 100644
index 0000000000..abe79b0882
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.shapezorder.yml
@@ -0,0 +1,129 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/binding-to-shapes.yaml
+
+
+ // Sends the shape to the back.
+
+ changeZOrder(PowerPoint.ShapeZOrder.sendToBack);
+
+
+ ...
+
+
+ async function changeZOrder(operation: PowerPoint.ShapeZOrder) {
+ // Changes the z-order position of the selected shapes.
+ return PowerPoint.run(async (context) => {
+ const selectedShapes = context.presentation.getSelectedShapes();
+ selectedShapes.load();
+ await context.sync();
+
+ if (selectedShapes.items.length === 0) {
+ console.log("No shapes are selected.");
+ } else {
+ let direction = 1; // Start with bottom-most (lowest number).
+
+ // Start with top-most when sending to back or bringing forward.
+
+ switch (operation) {
+ case PowerPoint.ShapeZOrder.bringForward:
+
+ case PowerPoint.ShapeZOrder.sendToBack:
+ direction = -1; // Reverse direction.
+
+ break;
+ }
+
+ // Change the z-order position for each of the selected shapes,
+
+ // starting with the bottom-most when bringing to front or sending backward,
+
+ // or top-most when sending to back or bringing forward,
+
+ // so the selected shapes retain their relative z-order positions after they're changed.
+
+ selectedShapes.items
+ .sort((a, b) => (a.zOrderPosition - b.zOrderPosition) * direction)
+ .forEach((shape) => {
+ try {
+ const originalZOrderPosition = shape.zOrderPosition;
+ shape.setZOrder(operation);
+
+ console.log(`Changed z-order of shape ${shape.id}.`);
+ } catch (err) {
+ console.log(`Unable to change z-order of shape ${shape.id}. ${err.message}`);
+ }
+ });
+
+ await context.sync();
+ }
+ });
+ }
+
+ ```
+
+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_10/powerpoint/powerpoint.slide.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slide.yml
new file mode 100644
index 0000000000..0407d6a694
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slide.yml
@@ -0,0 +1,582 @@
+### 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: background
+ uid: powerpoint!PowerPoint.Slide#background:member
+ package: powerpoint!
+ fullName: background
+ summary: Gets the background of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly background: PowerPoint.SlideBackground;'
+ return:
+ type:
+ - 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:
+ - name: themeColorScheme
+ uid: powerpoint!PowerPoint.Slide#themeColorScheme:member
+ package: powerpoint!
+ fullName: themeColorScheme
+ summary: Returns the `ThemeColorScheme` of the slide.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly themeColorScheme: PowerPoint.ThemeColorScheme;'
+ 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 doesn't
+ 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.
+
+
+ Note: This method is optimized to export a single slide. Exporting
+ multiple slides can impact performance.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/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/export-import-slide.yaml
+
+
+ // Exports current slide.
+
+ await PowerPoint.run(async (context) => {
+ const slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const slideBase64DataResult = slide.exportAsBase64();
+ const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
+ await context.sync();
+
+ localStorage.setItem("exportedSlide", slideBase64DataResult.value);
+ localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);
+
+ updateSlideImage(imageBase64DataResult.value);
+
+ console.log("Slide was exported.");
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml
+
+
+ // Exports current slide.
+
+ await PowerPoint.run(async (context) => {
+ const slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const slideBase64DataResult = slide.exportAsBase64();
+ const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
+ await context.sync();
+
+ localStorage.setItem("exportedSlide", slideBase64DataResult.value);
+ localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);
+
+ updateSlideImage(imageBase64DataResult.value);
+
+ console.log("Slide was exported.");
+ });
+
+ ```
+
+ 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-encoded 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/items/type");
+ await context.sync();
+
+ const shapes = slide1.shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
+ const shape1: PowerPoint.Shape = shapes[0];
+ const shape2: PowerPoint.Shape = shapes[1];
+ shape1.load("id");
+ shape2.load("id");
+ await context.sync();
+
+ console.log(`IDs: ${shape1.id}, ${shape2.id}`);
+ 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_10/powerpoint/powerpoint.slidebackground.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackground.yml
new file mode 100644
index 0000000000..e30e422179
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackground.yml
@@ -0,0 +1,203 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackground
+uid: powerpoint!PowerPoint.SlideBackground:class
+package: powerpoint!
+fullName: PowerPoint.SlideBackground
+summary: Represents a background of a slide.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: areBackgroundGraphicsHidden
+ uid: powerpoint!PowerPoint.SlideBackground#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden: boolean;'
+ return:
+ type: boolean
+ - name: context
+ uid: powerpoint!PowerPoint.SlideBackground#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: fill
+ uid: powerpoint!PowerPoint.SlideBackground#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of the background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly fill: PowerPoint.SlideBackgroundFill;'
+ return:
+ type:
+ - name: isMasterBackgroundFollowed
+ uid: powerpoint!PowerPoint.SlideBackground#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: Specifies if the slide background follows the slide master background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed: boolean;'
+ return:
+ type: boolean
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideBackground#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.SlideBackgroundLoadOptions):
+ PowerPoint.SlideBackground;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideBackground#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.SlideBackground;'
+ 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.SlideBackground#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.SlideBackground;
+ 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: reset()
+ uid: powerpoint!PowerPoint.SlideBackground#reset:member(1)
+ package: powerpoint!
+ fullName: reset()
+ summary: Resets the fill formatting of the slide background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'reset(): void;'
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideBackground#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.SlideBackground` object is an API object, the `toJSON` method
+ returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow
+ copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundfill.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundfill.yml
new file mode 100644
index 0000000000..5bb779755f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundfill.yml
@@ -0,0 +1,370 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundFill
+uid: powerpoint!PowerPoint.SlideBackgroundFill:class
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundFill
+summary: Represents the fill formatting of a slide background object.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideBackgroundFill#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.SlideBackgroundFill#type:member
+ package: powerpoint!
+ fullName: type
+ summary: >-
+ Returns the fill type of the slide background. See
+ [PowerPoint.SlideBackgroundFillType](xref:powerpoint!PowerPoint.SlideBackgroundFillType:enum)
+ for details.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" |
+ "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
+ return:
+ type: >-
+ |
+ "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"
+methods:
+ - name: getGradientFillOrNullObject()
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundFill#getGradientFillOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getGradientFillOrNullObject()
+ summary: >-
+ Gets the gradient fill properties. If the fill type is not `gradient`, 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;'
+ return:
+ type:
+ description: ''
+ - name: getPatternFillOrNullObject()
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundFill#getPatternFillOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getPatternFillOrNullObject()
+ summary: >-
+ Gets the pattern fill properties. If the fill type is not `pattern`, 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;'
+ return:
+ type:
+ description: ''
+ - name: getPictureOrTextureFillOrNullObject()
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundFill#getPictureOrTextureFillOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getPictureOrTextureFillOrNullObject()
+ summary: >-
+ Gets the picture or texture fill properties. If the fill type is not
+ `pictureOrTexture`, 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getPictureOrTextureFillOrNullObject():
+ PowerPoint.SlideBackgroundPictureOrTextureFill;
+ return:
+ type: >-
+
+ description: ''
+ - name: getSolidFillOrNullObject()
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundFill#getSolidFillOrNullObject:member(1)
+ package: powerpoint!
+ fullName: getSolidFillOrNullObject()
+ summary: >-
+ Gets the solid fill properties. If the fill type is not `solid`,
+ 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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;'
+ return:
+ type:
+ description: ''
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundFill#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.SlideBackgroundFillLoadOptions):
+ PowerPoint.SlideBackgroundFill;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideBackgroundFill#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.SlideBackgroundFill;'
+ 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.SlideBackgroundFill#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.SlideBackgroundFill;
+ 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: setGradientFill(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundFill#setGradientFill:member(1)
+ package: powerpoint!
+ fullName: setGradientFill(options)
+ summary: >-
+ Sets the fill formatting of the slide background to a gradient fill. This
+ changes the fill type to `gradient`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setGradientFill(options?:
+ PowerPoint.SlideBackgroundGradientFillOptions): void;
+ parameters:
+ - id: options
+ description: Options for the gradient fill.
+ type: >-
+
+ return:
+ type: void
+ description: ''
+ - name: setPatternFill(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundFill#setPatternFill:member(1)
+ package: powerpoint!
+ fullName: setPatternFill(options)
+ summary: >-
+ Sets the fill formatting of the slide background to a pattern fill. This
+ changes the fill type to `pattern`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions):
+ void;
+ parameters:
+ - id: options
+ description: Options for the pattern fill.
+ type: >-
+
+ return:
+ type: void
+ description: ''
+ - name: setPictureOrTextureFill(options)
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundFill#setPictureOrTextureFill:member(1)
+ package: powerpoint!
+ fullName: setPictureOrTextureFill(options)
+ summary: >-
+ Sets the fill formatting of the slide background to a picture or texture
+ fill. This changes the fill type to `pictureOrTexture`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setPictureOrTextureFill(options?:
+ PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void;
+ parameters:
+ - id: options
+ description: Options for the picture or texture fill.
+ type: >-
+
+ return:
+ type: void
+ description: ''
+ - name: setSolidFill(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundFill#setSolidFill:member(1)
+ package: powerpoint!
+ fullName: setSolidFill(options)
+ summary: >-
+ Sets the fill formatting of the slide background to a solid fill. This
+ changes the fill type to `solid`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions):
+ void;
+ parameters:
+ - id: options
+ description: Options for the solid fill.
+ type: >-
+
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideBackgroundFill#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.SlideBackgroundFill` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundfilltype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundfilltype.yml
new file mode 100644
index 0000000000..ff05636ef8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundfilltype.yml
@@ -0,0 +1,72 @@
+### YamlMime:TSEnum
+name: PowerPoint.SlideBackgroundFillType
+uid: powerpoint!PowerPoint.SlideBackgroundFillType:enum
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundFillType
+summary: >-
+ Specifies the fill type for a
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: gradient
+ uid: powerpoint!PowerPoint.SlideBackgroundFillType.gradient:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the slide background should have gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Gradient"'
+ - name: pattern
+ uid: powerpoint!PowerPoint.SlideBackgroundFillType.pattern:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the slide background should have pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Pattern"'
+ - name: pictureOrTexture
+ uid: powerpoint!PowerPoint.SlideBackgroundFillType.pictureOrTexture:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the slide background should have picture or texture fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"PictureOrTexture"'
+ - name: solid
+ uid: powerpoint!PowerPoint.SlideBackgroundFillType.solid:member
+ package: powerpoint!
+ summary: >-
+ Specifies that the slide background should have regular solid fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Solid"'
+ - name: unsupported
+ uid: powerpoint!PowerPoint.SlideBackgroundFillType.unsupported:member
+ package: powerpoint!
+ summary: >-
+ Unsupported slide background fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfill.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfill.yml
new file mode 100644
index 0000000000..055c210a0e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfill.yml
@@ -0,0 +1,164 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundGradientFill
+uid: powerpoint!PowerPoint.SlideBackgroundGradientFill:class
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundGradientFill
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ gradient fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFill#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.SlideBackgroundGradientFill#type:member
+ package: powerpoint!
+ fullName: type
+ summary: Specifies the type of gradient fill.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" |
+ "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ return:
+ type: >-
+ | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" |
+ "ShadeFromTitle"
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFill#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.SlideBackgroundGradientFillLoadOptions):
+ PowerPoint.SlideBackgroundGradientFill;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFill#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.SlideBackgroundGradientFill;
+ 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.SlideBackgroundGradientFill#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.SlideBackgroundGradientFill;
+ 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.SlideBackgroundGradientFill#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.SlideBackgroundGradientFill` object is an API object, the
+ `toJSON` method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfilloptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfilloptions.yml
new file mode 100644
index 0000000000..d5aa8b7e77
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfilloptions.yml
@@ -0,0 +1,39 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundGradientFillOptions
+uid: powerpoint!PowerPoint.SlideBackgroundGradientFillOptions:interface
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundGradientFillOptions
+summary: >-
+ Represents the available options for setting a
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ gradient fill.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: type
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillOptions#type:member
+ package: powerpoint!
+ fullName: type
+ summary: If provided, specifies the type of gradient fill.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" |
+ "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ return:
+ type: >-
+ | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" |
+ "ShadeFromTitle"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfilltype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfilltype.yml
new file mode 100644
index 0000000000..21dd196466
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundgradientfilltype.yml
@@ -0,0 +1,84 @@
+### YamlMime:TSEnum
+name: PowerPoint.SlideBackgroundGradientFillType
+uid: powerpoint!PowerPoint.SlideBackgroundGradientFillType:enum
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundGradientFillType
+summary: >-
+ Specifies the gradient fill type for a
+ [PowerPoint.SlideBackgroundGradientFill](xref:powerpoint!PowerPoint.SlideBackgroundGradientFill:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: linear
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillType.linear:member
+ package: powerpoint!
+ summary: >-
+ Linear gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Linear"'
+ - name: path
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillType.path:member
+ package: powerpoint!
+ summary: >-
+ Path gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Path"'
+ - name: radial
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillType.radial:member
+ package: powerpoint!
+ summary: >-
+ Radial gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Radial"'
+ - name: rectangular
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillType.rectangular:member
+ package: powerpoint!
+ summary: >-
+ Rectangular gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Rectangular"'
+ - name: shadeFromTitle
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundGradientFillType.shadeFromTitle:member
+ package: powerpoint!
+ summary: >-
+ Shade from title gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ShadeFromTitle"'
+ - name: unsupported
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillType.unsupported:member
+ package: powerpoint!
+ summary: >-
+ Unsupported gradient fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unsupported"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfill.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfill.yml
new file mode 100644
index 0000000000..6ac7a05d99
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfill.yml
@@ -0,0 +1,226 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundPatternFill
+uid: powerpoint!PowerPoint.SlideBackgroundPatternFill:class
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundPatternFill
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ pattern fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: backgroundColor
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFill#backgroundColor:member
+ package: powerpoint!
+ fullName: backgroundColor
+ summary: >-
+ Specifies the background color in HTML color format (e.g., "\#FFFFFF" or
+ "white").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'backgroundColor: string;'
+ return:
+ type: string
+ - name: context
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFill#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.SlideBackgroundPatternFill#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ Specifies the foreground color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor: string;'
+ return:
+ type: string
+ - name: pattern
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFill#pattern:member
+ package: powerpoint!
+ fullName: pattern
+ summary: Specifies the pattern type.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" |
+ "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" |
+ "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" |
+ "Percent80" | "Percent90" | "Horizontal" | "Vertical" |
+ "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical"
+ | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" |
+ "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" |
+ "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal"
+ | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" |
+ "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" |
+ "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" |
+ "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" |
+ "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis"
+ | "ZigZag";
+ return:
+ type: >-
+ | "Unsupported" | "Percent5" | "Percent10" | "Percent20" |
+ "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" |
+ "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" |
+ "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" |
+ "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" |
+ "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" |
+ "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" |
+ "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal"
+ | "WideUpwardDiagonal" | "DashedDownwardDiagonal" |
+ "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" |
+ "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" |
+ "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond"
+ | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" |
+ "Trellis" | "ZigZag"
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFill#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.SlideBackgroundPatternFillLoadOptions):
+ PowerPoint.SlideBackgroundPatternFill;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFill#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.SlideBackgroundPatternFill;
+ 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.SlideBackgroundPatternFill#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.SlideBackgroundPatternFill;
+ 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.SlideBackgroundPatternFill#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.SlideBackgroundPatternFill` object is an API object, the
+ `toJSON` method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfilloptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfilloptions.yml
new file mode 100644
index 0000000000..bac8a898c8
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfilloptions.yml
@@ -0,0 +1,103 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundPatternFillOptions
+uid: powerpoint!PowerPoint.SlideBackgroundPatternFillOptions:interface
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundPatternFillOptions
+summary: >-
+ Represents the available options for setting a
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ pattern fill.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: backgroundColor
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillOptions#backgroundColor:member
+ package: powerpoint!
+ fullName: backgroundColor
+ summary: >-
+ If provided, specifies the background color in HTML color format (e.g.,
+ "\#FFFFFF" or "white").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'backgroundColor?: string;'
+ return:
+ type: string
+ - name: foregroundColor
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillOptions#foregroundColor:member
+ package: powerpoint!
+ fullName: foregroundColor
+ summary: >-
+ If provided, specifies the foreground color in HTML color format (e.g.,
+ "\#FFA500" or "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'foregroundColor?: string;'
+ return:
+ type: string
+ - name: pattern
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillOptions#pattern:member
+ package: powerpoint!
+ fullName: pattern
+ summary: If provided, specifies the pattern type.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" |
+ "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" |
+ "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" |
+ "Percent80" | "Percent90" | "Horizontal" | "Vertical" |
+ "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical"
+ | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" |
+ "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" |
+ "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal"
+ | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" |
+ "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" |
+ "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" |
+ "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" |
+ "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis"
+ | "ZigZag";
+ return:
+ type: >-
+ | "Unsupported" | "Percent5" | "Percent10" | "Percent20" |
+ "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" |
+ "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" |
+ "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" |
+ "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" |
+ "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" |
+ "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" |
+ "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal"
+ | "WideUpwardDiagonal" | "DashedDownwardDiagonal" |
+ "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" |
+ "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" |
+ "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" |
+ "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond"
+ | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" |
+ "Trellis" | "ZigZag"
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfilltype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfilltype.yml
new file mode 100644
index 0000000000..32aa94097e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpatternfilltype.yml
@@ -0,0 +1,638 @@
+### YamlMime:TSEnum
+name: PowerPoint.SlideBackgroundPatternFillType
+uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType:enum
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundPatternFillType
+summary: >-
+ Specifies the pattern fill type for a
+ [PowerPoint.SlideBackgroundPatternFill](xref:powerpoint!PowerPoint.SlideBackgroundPatternFill:class).
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: cross
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.cross:member
+ package: powerpoint!
+ summary: >-
+ Cross pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Cross"'
+ - name: darkDownwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.darkDownwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Dark downward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkDownwardDiagonal"'
+ - name: darkHorizontal
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.darkHorizontal:member
+ package: powerpoint!
+ summary: >-
+ Dark horizontal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkHorizontal"'
+ - name: darkUpwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.darkUpwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Dark upward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkUpwardDiagonal"'
+ - name: darkVertical
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.darkVertical:member
+ package: powerpoint!
+ summary: >-
+ Dark vertical pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkVertical"'
+ - name: dashedDownwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.dashedDownwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Dashed downward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashedDownwardDiagonal"'
+ - name: dashedHorizontal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.dashedHorizontal:member
+ package: powerpoint!
+ summary: >-
+ Dashed horizontal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashedHorizontal"'
+ - name: dashedUpwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.dashedUpwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Dashed upward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashedUpwardDiagonal"'
+ - name: dashedVertical
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.dashedVertical:member
+ package: powerpoint!
+ summary: >-
+ Dashed vertical pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DashedVertical"'
+ - name: diagonalBrick
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.diagonalBrick:member
+ package: powerpoint!
+ summary: >-
+ Diagonal brick pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DiagonalBrick"'
+ - name: diagonalCross
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.diagonalCross:member
+ package: powerpoint!
+ summary: >-
+ Diagonal cross pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DiagonalCross"'
+ - name: divot
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.divot:member
+ package: powerpoint!
+ summary: >-
+ Divot pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Divot"'
+ - name: dottedDiamond
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.dottedDiamond:member
+ package: powerpoint!
+ summary: >-
+ Dotted diamond pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DottedDiamond"'
+ - name: dottedGrid
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.dottedGrid:member
+ package: powerpoint!
+ summary: >-
+ Dotted grid pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DottedGrid"'
+ - name: downwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.downwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Downward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DownwardDiagonal"'
+ - name: horizontal
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.horizontal:member
+ package: powerpoint!
+ summary: >-
+ Horizontal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Horizontal"'
+ - name: horizontalBrick
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.horizontalBrick:member
+ package: powerpoint!
+ summary: >-
+ Horizontal brick pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"HorizontalBrick"'
+ - name: largeCheckerBoard
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.largeCheckerBoard:member
+ package: powerpoint!
+ summary: >-
+ Large checker board pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LargeCheckerBoard"'
+ - name: largeConfetti
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.largeConfetti:member
+ package: powerpoint!
+ summary: >-
+ Large confetti pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LargeConfetti"'
+ - name: largeGrid
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.largeGrid:member
+ package: powerpoint!
+ summary: >-
+ Large grid pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LargeGrid"'
+ - name: lightDownwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.lightDownwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Light downward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightDownwardDiagonal"'
+ - name: lightHorizontal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.lightHorizontal:member
+ package: powerpoint!
+ summary: >-
+ Light horizontal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightHorizontal"'
+ - name: lightUpwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.lightUpwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Light upward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightUpwardDiagonal"'
+ - name: lightVertical
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.lightVertical:member
+ package: powerpoint!
+ summary: >-
+ Light vertical pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightVertical"'
+ - name: narrowHorizontal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.narrowHorizontal:member
+ package: powerpoint!
+ summary: >-
+ Narrow horizontal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NarrowHorizontal"'
+ - name: narrowVertical
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.narrowVertical:member
+ package: powerpoint!
+ summary: >-
+ Narrow vertical pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NarrowVertical"'
+ - name: outlinedDiamond
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.outlinedDiamond:member
+ package: powerpoint!
+ summary: >-
+ Outlined diamond pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"OutlinedDiamond"'
+ - name: percent10
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent10:member
+ package: powerpoint!
+ summary: >-
+ 10 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent10"'
+ - name: percent20
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent20:member
+ package: powerpoint!
+ summary: >-
+ 20 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent20"'
+ - name: percent25
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent25:member
+ package: powerpoint!
+ summary: >-
+ 25 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent25"'
+ - name: percent30
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent30:member
+ package: powerpoint!
+ summary: >-
+ 30 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent30"'
+ - name: percent40
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent40:member
+ package: powerpoint!
+ summary: >-
+ 40 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent40"'
+ - name: percent5
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent5:member
+ package: powerpoint!
+ summary: >-
+ 5 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent5"'
+ - name: percent50
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent50:member
+ package: powerpoint!
+ summary: >-
+ 50 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent50"'
+ - name: percent60
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent60:member
+ package: powerpoint!
+ summary: >-
+ 60 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent60"'
+ - name: percent70
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent70:member
+ package: powerpoint!
+ summary: >-
+ 70 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent70"'
+ - name: percent75
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent75:member
+ package: powerpoint!
+ summary: >-
+ 75 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent75"'
+ - name: percent80
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent80:member
+ package: powerpoint!
+ summary: >-
+ 80 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent80"'
+ - name: percent90
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.percent90:member
+ package: powerpoint!
+ summary: >-
+ 90 percent pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Percent90"'
+ - name: plaid
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.plaid:member
+ package: powerpoint!
+ summary: >-
+ Plaid pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Plaid"'
+ - name: shingle
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.shingle:member
+ package: powerpoint!
+ summary: >-
+ Shingle pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Shingle"'
+ - name: smallCheckerBoard
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.smallCheckerBoard:member
+ package: powerpoint!
+ summary: >-
+ Small checker board pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SmallCheckerBoard"'
+ - name: smallConfetti
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.smallConfetti:member
+ package: powerpoint!
+ summary: >-
+ Small confetti pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SmallConfetti"'
+ - name: smallGrid
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.smallGrid:member
+ package: powerpoint!
+ summary: >-
+ Small grid pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SmallGrid"'
+ - name: solidDiamond
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.solidDiamond:member
+ package: powerpoint!
+ summary: >-
+ Solid diamond pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"SolidDiamond"'
+ - name: sphere
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.sphere:member
+ package: powerpoint!
+ summary: >-
+ Sphere pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Sphere"'
+ - name: trellis
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.trellis:member
+ package: powerpoint!
+ summary: >-
+ Trellis pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Trellis"'
+ - name: unsupported
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.unsupported:member
+ package: powerpoint!
+ summary: >-
+ Unsupported pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Unsupported"'
+ - name: upwardDiagonal
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.upwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Upward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"UpwardDiagonal"'
+ - name: vertical
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.vertical:member
+ package: powerpoint!
+ summary: >-
+ Vertical pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Vertical"'
+ - name: wave
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.wave:member
+ package: powerpoint!
+ summary: >-
+ Wave pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Wave"'
+ - name: weave
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.weave:member
+ package: powerpoint!
+ summary: >-
+ Weave pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Weave"'
+ - name: wideDownwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.wideDownwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Wide downward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"WideDownwardDiagonal"'
+ - name: wideUpwardDiagonal
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPatternFillType.wideUpwardDiagonal:member
+ package: powerpoint!
+ summary: >-
+ Wide upward diagonal pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"WideUpwardDiagonal"'
+ - name: zigZag
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType.zigZag:member
+ package: powerpoint!
+ summary: >-
+ Zig zag pattern fill.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ZigZag"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpictureortexturefill.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpictureortexturefill.yml
new file mode 100644
index 0000000000..8e3f1f6bc4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpictureortexturefill.yml
@@ -0,0 +1,193 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundPictureOrTextureFill
+uid: powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill:class
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundPictureOrTextureFill
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ picture or texture fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill#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: transparency
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill#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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency: number;'
+ return:
+ type: number
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill#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.SlideBackgroundPictureOrTextureFillLoadOptions):
+ PowerPoint.SlideBackgroundPictureOrTextureFill;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type: >-
+
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill#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.SlideBackgroundPictureOrTextureFill;
+ 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.SlideBackgroundPictureOrTextureFill#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.SlideBackgroundPictureOrTextureFill;
+ 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.SlideBackgroundPictureOrTextureFill#setImage:member(1)
+ package: powerpoint!
+ fullName: setImage(base64EncodedImage)
+ summary: Sets the image used to fill.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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: toJSON()
+ uid: powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill#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.SlideBackgroundPictureOrTextureFill` object is an API object,
+ the `toJSON` method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`)
+ that contains shallow copies of any loaded child properties from the
+ original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions.yml
new file mode 100644
index 0000000000..9fc83c3f37
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions.yml
@@ -0,0 +1,54 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundPictureOrTextureFillOptions
+uid: powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFillOptions:interface
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundPictureOrTextureFillOptions
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ picture or texture fill options.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: imageBase64
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFillOptions#imageBase64:member
+ package: powerpoint!
+ fullName: imageBase64
+ summary: If provided, specifies the Base64-encoded image data for the fill.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'imageBase64?: string;'
+ return:
+ type: string
+ - name: transparency
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFillOptions#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ If provided, specifies the transparency percentage of the fill as a value
+ from 0.0 (opaque) through 1.0 (clear).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.slidebackgroundsolidfill.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundsolidfill.yml
new file mode 100644
index 0000000000..09a75d3fdb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundsolidfill.yml
@@ -0,0 +1,179 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundSolidFill
+uid: powerpoint!PowerPoint.SlideBackgroundSolidFill:class
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundSolidFill
+summary: >-
+ Represents
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ solid fill properties.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFill#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ Specifies the fill color in HTML color format (e.g., "\#FFA500" or
+ "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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.SlideBackgroundSolidFill#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: transparency
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFill#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.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'transparency: number;'
+ return:
+ type: number
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFill#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.SlideBackgroundSolidFillLoadOptions):
+ PowerPoint.SlideBackgroundSolidFill;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFill#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.SlideBackgroundSolidFill;
+ 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.SlideBackgroundSolidFill#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.SlideBackgroundSolidFill;
+ 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.SlideBackgroundSolidFill#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.SlideBackgroundSolidFill` object is an API object, the
+ `toJSON` method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundsolidfilloptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundsolidfilloptions.yml
new file mode 100644
index 0000000000..4e05b7fc7c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidebackgroundsolidfilloptions.yml
@@ -0,0 +1,54 @@
+### YamlMime:TSType
+name: PowerPoint.SlideBackgroundSolidFillOptions
+uid: powerpoint!PowerPoint.SlideBackgroundSolidFillOptions:interface
+package: powerpoint!
+fullName: PowerPoint.SlideBackgroundSolidFillOptions
+summary: >-
+ Represents the available options for setting a
+ [PowerPoint.SlideBackground](xref:powerpoint!PowerPoint.SlideBackground:class)
+ solid fill.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: color
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFillOptions#color:member
+ package: powerpoint!
+ fullName: color
+ summary: >-
+ If provided, specifies the fill color in HTML color format (e.g.,
+ "\#FFA500" or "orange").
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'color?: string;'
+ return:
+ type: string
+ - name: transparency
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFillOptions#transparency:member
+ package: powerpoint!
+ fullName: transparency
+ summary: >-
+ If provided, specifies the transparency percentage of the fill as a value
+ from 0.0 (opaque) through 1.0 (clear).
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/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_10/powerpoint/powerpoint.slidecollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidecollection.yml
new file mode 100644
index 0000000000..33a8beb5c4
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidecollection.yml
@@ -0,0 +1,380 @@
+### 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 to 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: Optional. Options for configuring the properties of the new slide.
+ type:
+ return:
+ type: void
+ description: ''
+ - name: exportAsBase64Presentation(values)
+ uid: powerpoint!PowerPoint.SlideCollection#exportAsBase64Presentation:member(1)
+ package: powerpoint!
+ fullName: exportAsBase64Presentation(values)
+ summary: >-
+ Exports one or more slides found in this collection to their own
+ presentation file, returned as Base64-encoded data. Throws an
+ `InvalidArgument` exception if provided slide IDs or `Slide` objects are
+ not found in this collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ exportAsBase64Presentation(values: Array):
+ OfficeExtension.ClientResult;
+ parameters:
+ - id: values
+ description: An array of slide IDs or `Slide` objects.
+ type: >-
+ Array<string | >
+ return:
+ type: <string>
+ description: A Base64-encoded string.
+ - 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 doesn't 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 doesn't 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_10/powerpoint/powerpoint.slidegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidegetimageoptions.yml
new file mode 100644
index 0000000000..84cea489aa
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidegetimageoptions.yml
@@ -0,0 +1,75 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml
+
+
+ // Exports current slide.
+
+ await PowerPoint.run(async (context) => {
+ const slide = context.presentation.getSelectedSlides().getItemAt(0);
+ const slideBase64DataResult = slide.exportAsBase64();
+ const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
+ await context.sync();
+
+ localStorage.setItem("exportedSlide", slideBase64DataResult.value);
+ localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);
+
+ updateSlideImage(imageBase64DataResult.value);
+
+ console.log("Slide was exported.");
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.slidelayout.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidelayout.yml
new file mode 100644
index 0000000000..0c4ec75cd2
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidelayout.yml
@@ -0,0 +1,329 @@
+### 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: background
+ uid: powerpoint!PowerPoint.SlideLayout#background:member
+ package: powerpoint!
+ fullName: background
+ summary: Gets the background of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly background: PowerPoint.SlideLayoutBackground;'
+ return:
+ type:
+ - 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: themeColorScheme
+ uid: powerpoint!PowerPoint.SlideLayout#themeColorScheme:member
+ package: powerpoint!
+ fullName: themeColorScheme
+ summary: Returns the `ThemeColorScheme` of the slide layout.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly themeColorScheme: PowerPoint.ThemeColorScheme;'
+ 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_10/powerpoint/powerpoint.slidelayoutbackground.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidelayoutbackground.yml
new file mode 100644
index 0000000000..b226a11575
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidelayoutbackground.yml
@@ -0,0 +1,209 @@
+### YamlMime:TSType
+name: PowerPoint.SlideLayoutBackground
+uid: powerpoint!PowerPoint.SlideLayoutBackground:class
+package: powerpoint!
+fullName: PowerPoint.SlideLayoutBackground
+summary: Represents the background of a slide layout.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: areBackgroundGraphicsHidden
+ uid: >-
+ powerpoint!PowerPoint.SlideLayoutBackground#areBackgroundGraphicsHidden:member
+ package: powerpoint!
+ fullName: areBackgroundGraphicsHidden
+ summary: >-
+ Specifies whether the slide layout background fill hides or displays
+ background graphic objects from the slide master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areBackgroundGraphicsHidden: boolean;'
+ return:
+ type: boolean
+ - name: context
+ uid: powerpoint!PowerPoint.SlideLayoutBackground#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: fill
+ uid: powerpoint!PowerPoint.SlideLayoutBackground#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of the background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly fill: PowerPoint.SlideBackgroundFill;'
+ return:
+ type:
+ - name: isMasterBackgroundFollowed
+ uid: >-
+ powerpoint!PowerPoint.SlideLayoutBackground#isMasterBackgroundFollowed:member
+ package: powerpoint!
+ fullName: isMasterBackgroundFollowed
+ summary: >-
+ Specifies if the slide layout background follows the slide master
+ background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isMasterBackgroundFollowed: boolean;'
+ return:
+ type: boolean
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideLayoutBackground#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.SlideLayoutBackgroundLoadOptions):
+ PowerPoint.SlideLayoutBackground;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideLayoutBackground#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.SlideLayoutBackground;
+ 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.SlideLayoutBackground#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.SlideLayoutBackground;
+ 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: reset()
+ uid: powerpoint!PowerPoint.SlideLayoutBackground#reset:member(1)
+ package: powerpoint!
+ fullName: reset()
+ summary: Resets the fill formatting of the slide layout background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'reset(): void;'
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.SlideLayoutBackground#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.SlideLayoutBackground` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidelayoutcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidelayoutcollection.yml
new file mode 100644
index 0000000000..0b2d676eac
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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 doesn't 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 doesn't 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_10/powerpoint/powerpoint.slidelayouttype.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidelayouttype.yml
new file mode 100644
index 0000000000..88169ff1ff
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.slidemaster.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidemaster.yml
new file mode 100644
index 0000000000..dcb1f7c31d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidemaster.yml
@@ -0,0 +1,307 @@
+### 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: background
+ uid: powerpoint!PowerPoint.SlideMaster#background:member
+ package: powerpoint!
+ fullName: background
+ summary: Gets the background of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly background: PowerPoint.SlideMasterBackground;'
+ return:
+ type:
+ - 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:
+ - name: themeColorScheme
+ uid: powerpoint!PowerPoint.SlideMaster#themeColorScheme:member
+ package: powerpoint!
+ fullName: themeColorScheme
+ summary: Returns the `ThemeColorScheme` of the Slide Master.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly themeColorScheme: PowerPoint.ThemeColorScheme;'
+ 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_10/powerpoint/powerpoint.slidemasterbackground.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidemasterbackground.yml
new file mode 100644
index 0000000000..c71586482d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidemasterbackground.yml
@@ -0,0 +1,154 @@
+### YamlMime:TSType
+name: PowerPoint.SlideMasterBackground
+uid: powerpoint!PowerPoint.SlideMasterBackground:class
+package: powerpoint!
+fullName: PowerPoint.SlideMasterBackground
+summary: Represents the background of a slide master.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.SlideMasterBackground#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: fill
+ uid: powerpoint!PowerPoint.SlideMasterBackground#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Returns the fill formatting of the background.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly fill: PowerPoint.SlideBackgroundFill;'
+ return:
+ type:
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.SlideMasterBackground#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.SlideMasterBackgroundLoadOptions):
+ PowerPoint.SlideMasterBackground;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.SlideMasterBackground#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.SlideMasterBackground;
+ 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.SlideMasterBackground#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.SlideMasterBackground;
+ 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.SlideMasterBackground#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.SlideMasterBackground` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidemastercollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidemastercollection.yml
new file mode 100644
index 0000000000..97fb51f552
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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 doesn't
+ 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 doesn't
+ 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_10/powerpoint/powerpoint.slidescopedcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidescopedcollection.yml
new file mode 100644
index 0000000000..966f3bc47f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.slidescopedcollection.yml
@@ -0,0 +1,292 @@
+### 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: exportAsBase64Presentation()
+ uid: >-
+ powerpoint!PowerPoint.SlideScopedCollection#exportAsBase64Presentation:member(1)
+ package: powerpoint!
+ fullName: exportAsBase64Presentation()
+ summary: >-
+ Exports all slides in this collection to their own presentation file,
+ returned as Base64-encoded data.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'exportAsBase64Presentation(): OfficeExtension.ClientResult;'
+ return:
+ type: <string>
+ description: A Base64-encoded string.
+ - 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 doesn't 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 doesn't 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_10/powerpoint/powerpoint.table.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.table.yml
new file mode 100644
index 0000000000..ce6dab2988
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.table.yml
@@ -0,0 +1,423 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Updates a table's values.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table (which is a type of Shape).
+ const shape = shapes.addTable(4, 3);
+ let table = shape.getTable();
+ table.load();
+ await context.sync();
+
+ // Update values in the table.
+ for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
+ for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
+ const cell = table.getCellOrNullObject(rowIndex, columnIndex);
+ cell.text = generateRandomString();
+ }
+ }
+
+ await context.sync();
+ });
+
+ ```
+
+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: columns
+ uid: powerpoint!PowerPoint.Table#columns:member
+ package: powerpoint!
+ fullName: columns
+ summary: Gets the collection of columns in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly columns: PowerPoint.TableColumnCollection;'
+ return:
+ type:
+ - 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: rows
+ uid: powerpoint!PowerPoint.Table#rows:member
+ package: powerpoint!
+ fullName: rows
+ summary: Gets the collection of rows in the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly rows: PowerPoint.TableRowCollection;'
+ return:
+ type:
+ - name: styleSettings
+ uid: powerpoint!PowerPoint.Table#styleSettings:member
+ package: powerpoint!
+ fullName: styleSettings
+ summary: Gets the table style settings.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly styleSettings: PowerPoint.TableStyleSettings;'
+ return:
+ type:
+ - 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: clear(options)
+ uid: powerpoint!PowerPoint.Table#clear:member(1)
+ package: powerpoint!
+ fullName: clear(options)
+ summary: Clears table values and formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'clear(options?: PowerPoint.TableClearOptions): void;'
+ parameters:
+ - id: options
+ description: Provides options for clearing the table.
+ type:
+ return:
+ type: void
+ description: ''
+ - 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Updates a table's values.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table (which is a type of Shape).
+ const shape = shapes.addTable(4, 3);
+ let table = shape.getTable();
+ table.load();
+ await context.sync();
+
+ // Update values in the table.
+ for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
+ for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
+ const cell = table.getCellOrNullObject(rowIndex, columnIndex);
+ cell.text = generateRandomString();
+ }
+ }
+
+ await context.sync();
+ });
+
+ ```
+
+ 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. 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).
+ - 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: mergeCells(rowIndex, columnIndex, rowCount, columnCount)
+ uid: powerpoint!PowerPoint.Table#mergeCells:member(1)
+ package: powerpoint!
+ fullName: mergeCells(rowIndex, columnIndex, rowCount, columnCount)
+ summary: >-
+ Creates a merged area starting at the cell specified by rowIndex and
+ columnIndex. The merged area spans across a specified number of rows and
+ columns.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ mergeCells(rowIndex: number, columnIndex: number, rowCount: number,
+ columnCount: number): void;
+ parameters:
+ - id: rowIndex
+ description: The zero-based row index of the cell to start the merged area.
+ type: number
+ - id: columnIndex
+ description: The zero-based column index of the cell to start the merged area.
+ type: number
+ - id: rowCount
+ description: >-
+ The number of rows to merge with the starting cell. Must be greater
+ than 0.
+ type: number
+ - id: columnCount
+ description: >-
+ The number of columns to merge with the starting cell. Must be
+ greater than 0.
+ type: number
+ return:
+ type: void
+ 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_10/powerpoint/powerpoint.tableaddoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tableaddoptions.yml
new file mode 100644
index 0000000000..a8a72303c0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tableaddoptions.yml
@@ -0,0 +1,571 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the width and height of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying the width and height.
+ shapes.addTable(3, 4, {
+ width: 600,
+ height: 400
+ });
+ await context.sync();
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the column widths and row heights of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying column widths and row heights.
+ shapes.addTable(3, 4, {
+ columns: [{ columnWidth: 100 }, { columnWidth: 200 }, { columnWidth: 100 }, { columnWidth: 200 }],
+ rows: [{ rowHeight: 60 }, { rowHeight: 120 }, { rowHeight: 180 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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 isn't provided. Throws an `InvalidArgument` exception
+ when set with a negative value.
+
+
+ Note: If the table height isn't evenly divisible by the number of rows,
+ PowerPoint sets it to the nearest possible value. For example, a height of
+ 400 for 3 rows may result in an actual height of 399.9999.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/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/add-modify-tables.yaml
+
+
+ // Specifies the width and height of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying the width and height.
+ shapes.addTable(3, 4, {
+ width: 600,
+ height: 400
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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 isn't 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the merge areas of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying one 2x2 merged area.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "", "HHHH"],
+ ["1", "", "", "1234"]
+ ],
+ mergedAreas: [{ rowIndex: 1, columnIndex: 1, rowCount: 2, columnCount: 2 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the column widths and row heights of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying column widths and row heights.
+ shapes.addTable(3, 4, {
+ columns: [{ columnWidth: 100 }, { columnWidth: 200 }, { columnWidth: 100 }, { columnWidth: 200 }],
+ rows: [{ rowHeight: 60 }, { rowHeight: 120 }, { rowHeight: 180 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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 a 2D array with the same number of rows and columns as the
+ table. If a cell doesn't 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'specificCellProperties?: PowerPoint.TableCellProperties[][];'
+ return:
+ type: [][]
+ - name: style
+ uid: powerpoint!PowerPoint.TableAddOptions#style:member
+ package: powerpoint!
+ fullName: style
+ summary: Specifies value that represents the table style.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1"
+ | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4"
+ | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" |
+ "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" |
+ "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" |
+ "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" |
+ "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" |
+ "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" |
+ "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" |
+ "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" |
+ "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" |
+ "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" |
+ "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" |
+ "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" |
+ "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" |
+ "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" |
+ "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" |
+ "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" |
+ "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" |
+ "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" |
+ "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" |
+ "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ return:
+ type: >-
+ | "NoStyleNoGrid"
+ | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" |
+ "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5"
+ | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" |
+ "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4"
+ | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" |
+ "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" |
+ "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" |
+ "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" |
+ "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" |
+ "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" |
+ "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" |
+ "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" |
+ "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3"
+ | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4"
+ | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3"
+ | "MediumStyle3Accent4" | "MediumStyle3Accent5" |
+ "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" |
+ "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4"
+ | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" |
+ "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" |
+ "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" |
+ "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" |
+ "DarkStyle2Accent3"
+ - 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 isn't
+ 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 don't specify `specificCellProperties`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/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/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's values.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying cell values.
+ const shape = shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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 isn't provided. Throws an `InvalidArgument` exception when
+ set with a negative value.
+
+
+ Note: If the table width isn't evenly divisible by the number of columns,
+ PowerPoint sets it to the nearest possible value. For example, a width of
+ 400 for 3 columns may result in an actual width of 399.9999.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/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/add-modify-tables.yaml
+
+
+ // Specifies the width and height of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying the width and height.
+ shapes.addTable(3, 4, {
+ width: 600,
+ height: 400
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecell.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecell.yml
new file mode 100644
index 0000000000..aa6d59a446
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecell.yml
@@ -0,0 +1,490 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Updates a table's values.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table (which is a type of Shape).
+ const shape = shapes.addTable(4, 3);
+ let table = shape.getTable();
+ table.load();
+ await context.sync();
+
+ // Update values in the table.
+ for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
+ for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
+ const cell = table.getCellOrNullObject(rowIndex, columnIndex);
+ cell.text = generateRandomString();
+ }
+ }
+
+ await context.sync();
+ });
+
+ ```
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: borders
+ uid: powerpoint!PowerPoint.TableCell#borders:member
+ package: powerpoint!
+ fullName: borders
+ summary: Gets the collection of borders for the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly borders: PowerPoint.Borders;'
+ return:
+ type:
+ - 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: fill
+ uid: powerpoint!PowerPoint.TableCell#fill:member
+ package: powerpoint!
+ fullName: fill
+ summary: Gets the fill color of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly fill: PowerPoint.ShapeFill;'
+ return:
+ type:
+ - name: font
+ uid: powerpoint!PowerPoint.TableCell#font:member
+ package: powerpoint!
+ fullName: font
+ summary: Gets the font of the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly font: PowerPoint.ShapeFont;'
+ return:
+ type:
+ - name: horizontalAlignment
+ uid: powerpoint!PowerPoint.TableCell#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: >-
+ Specifies the horizontal alignment of the text in the table cell. Returns
+ `null` if the cell text contains different alignments.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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" | null;
+ return:
+ type: >-
+
+ | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" |
+ "Distributed" | "ThaiDistributed" | null
+ - name: indentLevel
+ uid: powerpoint!PowerPoint.TableCell#indentLevel:member
+ package: powerpoint!
+ fullName: indentLevel
+ summary: >-
+ Specifies the indent level of the text in the table cell. Returns `null`
+ if the cell text contains different indent levels.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'indentLevel: number | null;'
+ return:
+ type: number | null
+ - name: margins
+ uid: powerpoint!PowerPoint.TableCell#margins:member
+ package: powerpoint!
+ fullName: margins
+ summary: Gets the set of margins in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly margins: PowerPoint.Margins;'
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Updates a table's values.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table (which is a type of Shape).
+ const shape = shapes.addTable(4, 3);
+ let table = shape.getTable();
+ table.load();
+ await context.sync();
+
+ // Update values in the table.
+ for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
+ for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
+ const cell = table.getCellOrNullObject(rowIndex, columnIndex);
+ cell.text = generateRandomString();
+ }
+ }
+
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'text: string;'
+ return:
+ type: string
+ - name: textRuns
+ uid: powerpoint!PowerPoint.TableCell#textRuns:member
+ package: powerpoint!
+ fullName: textRuns
+ summary: >-
+ Specifies the contents of the table cell as an array of
+ [PowerPoint.TextRun](xref:powerpoint!PowerPoint.TextRun:interface)
+ objects. Each `TextRun` object represents a sequence of one or more
+ characters that share the same font attributes.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.TableCell#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: Specifies the vertical alignment of the text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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"
+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: resize(rowCount, columnCount)
+ uid: powerpoint!PowerPoint.TableCell#resize:member(1)
+ package: powerpoint!
+ fullName: resize(rowCount, columnCount)
+ summary: >-
+ Resizes the table cell to span across a specified number of rows and
+ columns. If rowCount or columnCount are greater than 1, the cell will
+ become a merged area. If the cell is already a merged area and rowCount
+ and columnCount are set to 1, the cell will no longer be a merged area.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'resize(rowCount: number, columnCount: number): void;'
+ parameters:
+ - id: rowCount
+ description: >-
+ The number of rows the cell will span across. Must be greater than
+ 0.
+ type: number
+ - id: columnCount
+ description: >-
+ The number of columns the cell will span across. Must be greater
+ than 0.
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: split(rowCount, columnCount)
+ uid: powerpoint!PowerPoint.TableCell#split:member(1)
+ package: powerpoint!
+ fullName: split(rowCount, columnCount)
+ summary: Splits the cell into the specified number of rows and columns.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'split(rowCount: number, columnCount: number): void;'
+ parameters:
+ - id: rowCount
+ description: The number of rows to split into. Must be greater than 0.
+ type: number
+ - id: columnCount
+ description: The number of columns to split into. Must be greater than 0.
+ type: number
+ return:
+ type: void
+ 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_10/powerpoint/powerpoint.tablecellborders.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellborders.yml
new file mode 100644
index 0000000000..a15e9ef380
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellborders.yml
@@ -0,0 +1,291 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'top?: PowerPoint.BorderProperties;'
+ return:
+ type:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellcollection.yml
new file mode 100644
index 0000000000..0f812ae2da
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellcollection.yml
@@ -0,0 +1,200 @@
+### 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` 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: >-
+ 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_10/powerpoint/powerpoint.tablecellmargins.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellmargins.yml
new file mode 100644
index 0000000000..c8181d43c9
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.tablecellproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellproperties.yml
new file mode 100644
index 0000000000..e54d753ed7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecellproperties.yml
@@ -0,0 +1,515 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies a table's borders.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying border styles.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ borders: {
+ left: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ right: { color: "blue", dashStyle: PowerPoint.ShapeLineDashStyle.solid, weight: 4 },
+ top: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 },
+ bottom: { color: "red", dashStyle: PowerPoint.ShapeLineDashStyle.longDashDotDot, weight: 2 }
+ }
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the font formatting and fill colors of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying font formatting and fill colors.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [
+ { fill: { color: "red" }, font: { color: "yellow", name: "Calibri" } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", name: "Coolvetica" } },
+ { fill: { color: "red" }, font: { color: "yellow", italic: true } },
+ { fill: { color: "red" }, font: { color: "#9966cc", strikethrough: true } }
+ ],
+ [
+ { fill: { color: "#fbceb1" }, font: { color: "yellow", doubleStrikethrough: true } },
+ { fill: { color: "red" }, font: { color: "yellow", subscript: true } },
+ { fill: { color: "#0048ba" }, font: { color: "yellow", superscript: true } },
+ { fill: { color: "red" }, font: { color: "yellow" } }
+ ],
+ [
+ { fill: { color: "red" }, font: { color: "#b0bf1a" } },
+ { fill: { color: "#9966cc" }, font: { color: "yellow" } },
+ { fill: { color: "#b0bf1a" }, font: { color: "yellow" } },
+ { fill: { color: "red" }, font: { color: "#fbceb1" } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'font?: PowerPoint.FontProperties;'
+ return:
+ type:
+ - name: horizontalAlignment
+ uid: powerpoint!PowerPoint.TableCellProperties#horizontalAlignment:member
+ package: powerpoint!
+ fullName: horizontalAlignment
+ summary: Specifies the horizontal alignment of the text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/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/add-modify-tables.yaml
+
+
+ // Specifies the horizontal and vertical alignments of the cells in a
+ table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying horizontal and vertical alignment.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment.justify,
+ verticalAlignment: PowerPoint.TextVerticalAlignment.middle
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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: Specifies 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifying the indents for a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying the indent level for cells.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ specificCellProperties: [
+ [{ indentLevel: 0 }, { indentLevel: 1 }, { indentLevel: 2 }, { indentLevel: 3 }],
+ [{ indentLevel: 0 }, { indentLevel: 1 }, { indentLevel: 2 }, { indentLevel: 3 }],
+ [{ indentLevel: 0 }, { indentLevel: 1 }, { indentLevel: 2 }, { indentLevel: 3 }]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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
+ [PowerPoint.TextRun](xref:powerpoint!PowerPoint.TextRun:interface)
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the text runs of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying text runs.
+ shapes.addTable(3, 4, {
+ specificCellProperties: [
+ [
+ { text: "Title text", font: { bold: true } },
+ { text: "Title text", font: { bold: true } },
+ { text: "Title text", font: { bold: true } },
+ { text: "Title text", font: { bold: true } }
+ ],
+ [
+ { text: "Bold text", font: { bold: true } },
+ {
+ textRuns: [
+ { text: "Text runs with " },
+ { text: "Underlined text", font: { underline: PowerPoint.ShapeFontUnderlineStyle.double } },
+ { text: " and plain text" }
+ ]
+ },
+ { text: "Italicized text", font: { italic: true } },
+ { text: "Plain text" }
+ ],
+ [
+ { text: "Bold text", font: { bold: true } },
+ { text: "Underlined text", font: { underline: PowerPoint.ShapeFontUnderlineStyle.dotted } },
+ {
+ font: { bold: true },
+ textRuns: [
+ { text: "Text runs with " },
+ { text: "italicized text", font: { italic: true } },
+ { text: " and (inherited) bold text" }
+ ]
+ },
+ { text: "Italicized text", font: { italic: true } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'textRuns?: PowerPoint.TextRun[];'
+ return:
+ type: []
+ - name: verticalAlignment
+ uid: powerpoint!PowerPoint.TableCellProperties#verticalAlignment:member
+ package: powerpoint!
+ fullName: verticalAlignment
+ summary: Specifies the vertical alignment of the text in the table cell.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.8](/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/add-modify-tables.yaml
+
+
+ // Specifies the horizontal and vertical alignments of the cells in a
+ table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying horizontal and vertical alignment.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "GGG", "HHHH"],
+ ["1", "12", "123", "1234"]
+ ],
+ uniformCellProperties: {
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment.justify,
+ verticalAlignment: PowerPoint.TextVerticalAlignment.middle
+ }
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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_10/powerpoint/powerpoint.tableclearoptions.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tableclearoptions.yml
new file mode 100644
index 0000000000..269602605d
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tableclearoptions.yml
@@ -0,0 +1,63 @@
+### YamlMime:TSType
+name: PowerPoint.TableClearOptions
+uid: powerpoint!PowerPoint.TableClearOptions:interface
+package: powerpoint!
+fullName: PowerPoint.TableClearOptions
+summary: Represents the available options when clearing a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: all
+ uid: powerpoint!PowerPoint.TableClearOptions#all:member
+ package: powerpoint!
+ fullName: all
+ summary: Specifies if both values and formatting of the table should be cleared.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'all?: boolean;'
+ return:
+ type: boolean
+ - name: format
+ uid: powerpoint!PowerPoint.TableClearOptions#format:member
+ package: powerpoint!
+ fullName: format
+ summary: Specifies if the formatting of the table should be cleared.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'format?: boolean;'
+ return:
+ type: boolean
+ - name: text
+ uid: powerpoint!PowerPoint.TableClearOptions#text:member
+ package: powerpoint!
+ fullName: text
+ summary: Specifies if the values of the table should be cleared.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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_10/powerpoint/powerpoint.tablecolumn.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumn.yml
new file mode 100644
index 0000000000..4d5b98cb45
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumn.yml
@@ -0,0 +1,189 @@
+### YamlMime:TSType
+name: PowerPoint.TableColumn
+uid: powerpoint!PowerPoint.TableColumn:class
+package: powerpoint!
+fullName: PowerPoint.TableColumn
+summary: Represents a column in a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: columnIndex
+ uid: powerpoint!PowerPoint.TableColumn#columnIndex:member
+ package: powerpoint!
+ fullName: columnIndex
+ summary: >-
+ Returns the index number of the column within the column collection of the
+ table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.TableColumn#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: width
+ uid: powerpoint!PowerPoint.TableColumn#width:member
+ package: powerpoint!
+ fullName: width
+ summary: >-
+ Retrieves the width of the column in points. If the set column width is
+ less than the minimum width, the column width will be increased to the
+ minimum width.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'width: number;'
+ return:
+ type: number
+methods:
+ - name: delete()
+ uid: powerpoint!PowerPoint.TableColumn#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: Deletes the column.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.TableColumn#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.TableColumnLoadOptions):
+ PowerPoint.TableColumn;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TableColumn#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.TableColumn;'
+ 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.TableColumn#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.TableColumn;
+ 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.TableColumn#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.TableColumn`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.TableColumnData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TableColumnData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumncollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumncollection.yml
new file mode 100644
index 0000000000..ec9eb52952
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumncollection.yml
@@ -0,0 +1,243 @@
+### YamlMime:TSType
+name: PowerPoint.TableColumnCollection
+uid: powerpoint!PowerPoint.TableColumnCollection:class
+package: powerpoint!
+fullName: PowerPoint.TableColumnCollection
+summary: Represents a collection of table columns.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.TableColumnCollection#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.TableColumnCollection#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.TableColumn[];'
+ return:
+ type: []
+methods:
+ - name: add(index, count)
+ uid: powerpoint!PowerPoint.TableColumnCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(index, count)
+ summary: Adds one or more columns to the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ add(index?: number | null | undefined, count?: number | undefined):
+ void;
+ parameters:
+ - id: index
+ description: >-
+ Optional. Specifies the zero-based index where the new columns are
+ added. Existing columns starting at the index location are shifted
+ right. If the index value is undefined, null, -1, or greater than
+ the number of columns in the table, the new columns are added at the
+ end of the table.
+ type: number | null | undefined
+ - id: count
+ description: >-
+ Optional. The number of columns to add. If the value is undefined or
+ 0, only one column is added.
+ type: number | undefined
+ return:
+ type: void
+ description: ''
+ - name: deleteColumns(columns)
+ uid: powerpoint!PowerPoint.TableColumnCollection#deleteColumns:member(1)
+ package: powerpoint!
+ fullName: deleteColumns(columns)
+ summary: Deletes the specified columns from the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'deleteColumns(columns: PowerPoint.TableColumn[]): void;'
+ parameters:
+ - id: columns
+ description: >-
+ An array of `TableColumn` objects representing the columns to be
+ deleted.
+ type: []
+ return:
+ type: void
+ description: ''
+ - name: getCount()
+ uid: powerpoint!PowerPoint.TableColumnCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of columns in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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 columns in the collection.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.TableColumnCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: Gets the column using its zero-based index in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.TableColumn;'
+ parameters:
+ - id: index
+ description: Index value of the column to be retrieved, as a zero-based index.
+ type: number
+ return:
+ type:
+ description: The column object.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TableColumnCollection#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.TableColumnCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.TableColumnCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TableColumnCollection#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.TableColumnCollection;
+ 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.TableColumnCollection#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.TableColumnCollection;
+ 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.TableColumnCollection#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.TableColumnCollection` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.TableColumnCollectionData`) 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.TableColumnCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumnproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumnproperties.yml
new file mode 100644
index 0000000000..8335a0443f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablecolumnproperties.yml
@@ -0,0 +1,88 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the column widths and row heights of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying column widths and row heights.
+ shapes.addTable(3, 4, {
+ columns: [{ columnWidth: 100 }, { columnWidth: 200 }, { columnWidth: 100 }, { columnWidth: 200 }],
+ rows: [{ rowHeight: 60 }, { rowHeight: 120 }, { rowHeight: 180 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+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 doesn't 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the column widths and row heights of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying column widths and row heights.
+ shapes.addTable(3, 4, {
+ columns: [{ columnWidth: 100 }, { columnWidth: 200 }, { columnWidth: 100 }, { columnWidth: 200 }],
+ rows: [{ rowHeight: 60 }, { rowHeight: 120 }, { rowHeight: 180 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'columnWidth?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablemergedareaproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablemergedareaproperties.yml
new file mode 100644
index 0000000000..c1d8fee710
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablemergedareaproperties.yml
@@ -0,0 +1,232 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the merge areas of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying one 2x2 merged area.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "", "HHHH"],
+ ["1", "", "", "1234"]
+ ],
+ mergedAreas: [{ rowIndex: 1, columnIndex: 1, rowCount: 2, columnCount: 2 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the merge areas of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying one 2x2 merged area.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "", "HHHH"],
+ ["1", "", "", "1234"]
+ ],
+ mergedAreas: [{ rowIndex: 1, columnIndex: 1, rowCount: 2, columnCount: 2 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the merge areas of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying one 2x2 merged area.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "", "HHHH"],
+ ["1", "", "", "1234"]
+ ],
+ mergedAreas: [{ rowIndex: 1, columnIndex: 1, rowCount: 2, columnCount: 2 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the merge areas of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying one 2x2 merged area.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "", "HHHH"],
+ ["1", "", "", "1234"]
+ ],
+ mergedAreas: [{ rowIndex: 1, columnIndex: 1, rowCount: 2, columnCount: 2 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the merge areas of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying one 2x2 merged area.
+ shapes.addTable(3, 4, {
+ values: [
+ ["A", "BB", "CCC", "DDDD"],
+ ["E", "FF", "", "HHHH"],
+ ["1", "", "", "1234"]
+ ],
+ mergedAreas: [{ rowIndex: 1, columnIndex: 1, rowCount: 2, columnCount: 2 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowIndex: number;'
+ return:
+ type: number
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerow.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerow.yml
new file mode 100644
index 0000000000..be0f2cea71
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerow.yml
@@ -0,0 +1,203 @@
+### YamlMime:TSType
+name: PowerPoint.TableRow
+uid: powerpoint!PowerPoint.TableRow:class
+package: powerpoint!
+fullName: PowerPoint.TableRow
+summary: Represents a row in a table.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.TableRow#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: currentHeight
+ uid: powerpoint!PowerPoint.TableRow#currentHeight:member
+ package: powerpoint!
+ fullName: currentHeight
+ summary: Retrieves the current height of the row in points.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly currentHeight: number;'
+ return:
+ type: number
+ - name: height
+ uid: powerpoint!PowerPoint.TableRow#height:member
+ package: powerpoint!
+ fullName: height
+ summary: >-
+ Specifies the height of the row in points. If the set row height is less
+ than the minimum height, the row height will be increased to the minimum
+ height.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'height: number;'
+ return:
+ type: number
+ - name: rowIndex
+ uid: powerpoint!PowerPoint.TableRow#rowIndex:member
+ package: powerpoint!
+ fullName: rowIndex
+ summary: >-
+ Returns the index number of the row within the rows collection of the
+ table. Zero-indexed.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly rowIndex: number;'
+ return:
+ type: number
+methods:
+ - name: delete()
+ uid: powerpoint!PowerPoint.TableRow#delete:member(1)
+ package: powerpoint!
+ fullName: delete()
+ summary: Deletes the row.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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.TableRow#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.TableRowLoadOptions):
+ PowerPoint.TableRow;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TableRow#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.TableRow;'
+ 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.TableRow#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.TableRow;
+ 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.TableRow#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.TableRow`
+ object is an API object, the `toJSON` method returns a plain JavaScript
+ object (typed as `PowerPoint.Interfaces.TableRowData`) that
+ contains shallow copies of any loaded child properties from the original
+ object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TableRowData;'
+ return:
+ type:
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerowcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerowcollection.yml
new file mode 100644
index 0000000000..77f5c07ddb
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerowcollection.yml
@@ -0,0 +1,239 @@
+### YamlMime:TSType
+name: PowerPoint.TableRowCollection
+uid: powerpoint!PowerPoint.TableRowCollection:class
+package: powerpoint!
+fullName: PowerPoint.TableRowCollection
+summary: Represents a collection of table rows.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.TableRowCollection#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.TableRowCollection#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.TableRow[];'
+ return:
+ type: []
+methods:
+ - name: add(index, count)
+ uid: powerpoint!PowerPoint.TableRowCollection#add:member(1)
+ package: powerpoint!
+ fullName: add(index, count)
+ summary: Adds one or more rows to the table.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ add(index?: number | null | undefined, count?: number | undefined):
+ void;
+ parameters:
+ - id: index
+ description: >-
+ Optional. Specifies the zero-based index where the new rows are
+ added. Existing rows starting at the index location are shifted
+ down. If the index value is undefined, null, -1, or greater than the
+ number of rows in the table, the new rows are added at the end of
+ the table.
+ type: number | null | undefined
+ - id: count
+ description: >-
+ Optional. The number of rows to add. If the value is undefined or 0,
+ only one row is added.
+ type: number | undefined
+ return:
+ type: void
+ description: ''
+ - name: deleteRows(rows)
+ uid: powerpoint!PowerPoint.TableRowCollection#deleteRows:member(1)
+ package: powerpoint!
+ fullName: deleteRows(rows)
+ summary: Deletes the specified rows from the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'deleteRows(rows: PowerPoint.TableRow[]): void;'
+ parameters:
+ - id: rows
+ description: An array of `TableRow` objects representing the rows to be deleted.
+ type: []
+ return:
+ type: void
+ description: ''
+ - name: getCount()
+ uid: powerpoint!PowerPoint.TableRowCollection#getCount:member(1)
+ package: powerpoint!
+ fullName: getCount()
+ summary: Gets the number of rows in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/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 rows in the collection.
+ - name: getItemAt(index)
+ uid: powerpoint!PowerPoint.TableRowCollection#getItemAt:member(1)
+ package: powerpoint!
+ fullName: getItemAt(index)
+ summary: Gets the row using its zero-based index in the collection.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getItemAt(index: number): PowerPoint.TableRow;'
+ parameters:
+ - id: index
+ description: Index value of the row to be retrieved, as a zero-based index.
+ type: number
+ return:
+ type:
+ description: The row object.
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TableRowCollection#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.TableRowCollectionLoadOptions &
+ PowerPoint.Interfaces.CollectionLoadOptions):
+ PowerPoint.TableRowCollection;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+ &
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TableRowCollection#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.TableRowCollection;'
+ 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.TableRowCollection#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.TableRowCollection;
+ 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.TableRowCollection#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.TableRowCollection` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.TableRowCollectionData`) 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.TableRowCollectionData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerowproperties.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerowproperties.yml
new file mode 100644
index 0000000000..474466862e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablerowproperties.yml
@@ -0,0 +1,88 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the column widths and row heights of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying column widths and row heights.
+ shapes.addTable(3, 4, {
+ columns: [{ columnWidth: 100 }, { columnWidth: 200 }, { columnWidth: 100 }, { columnWidth: 200 }],
+ rows: [{ rowHeight: 60 }, { rowHeight: 120 }, { rowHeight: 180 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+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 doesn't 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the column widths and row heights of a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying column widths and row heights.
+ shapes.addTable(3, 4, {
+ columns: [{ columnWidth: 100 }, { columnWidth: 200 }, { columnWidth: 100 }, { columnWidth: 200 }],
+ rows: [{ rowHeight: 60 }, { rowHeight: 120 }, { rowHeight: 180 }]
+ });
+ await context.sync();
+ });
+
+ ```
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'rowHeight?: number | undefined;'
+ return:
+ type: number | undefined
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablestyle.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablestyle.yml
new file mode 100644
index 0000000000..529659e7a7
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablestyle.yml
@@ -0,0 +1,828 @@
+### YamlMime:TSEnum
+name: PowerPoint.TableStyle
+uid: powerpoint!PowerPoint.TableStyle:enum
+package: powerpoint!
+fullName: PowerPoint.TableStyle
+summary: Represents the available built-in table styles.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: darkStyle1
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark Style 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle1"'
+ - name: darkStyle1Accent1
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle1Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 1 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle1Accent1"'
+ - name: darkStyle1Accent2
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle1Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 1 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle1Accent2"'
+ - name: darkStyle1Accent3
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle1Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 1 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle1Accent3"'
+ - name: darkStyle1Accent4
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle1Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 1 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle1Accent4"'
+ - name: darkStyle1Accent5
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle1Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 1 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle1Accent5"'
+ - name: darkStyle1Accent6
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle1Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 1 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle1Accent6"'
+ - name: darkStyle2
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark Style 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle2"'
+ - name: darkStyle2Accent1
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle2Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 2 - Accent 1/Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle2Accent1"'
+ - name: darkStyle2Accent2
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle2Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 2 - Accent 3/Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle2Accent2"'
+ - name: darkStyle2Accent3
+ uid: powerpoint!PowerPoint.TableStyle.darkStyle2Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Dark style 2 - Accent 5/Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"DarkStyle2Accent3"'
+ - name: lightStyle1
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light Style 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle1"'
+ - name: lightStyle1Accent1
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle1Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 1 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle1Accent1"'
+ - name: lightStyle1Accent2
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle1Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 1 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle1Accent2"'
+ - name: lightStyle1Accent3
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle1Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 1 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle1Accent3"'
+ - name: lightStyle1Accent4
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle1Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 1 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle1Accent4"'
+ - name: lightStyle1Accent5
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle1Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 1 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle1Accent5"'
+ - name: lightStyle1Accent6
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle1Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 1 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle1Accent6"'
+ - name: lightStyle2
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light Style 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle2"'
+ - name: lightStyle2Accent1
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle2Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 2 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle2Accent1"'
+ - name: lightStyle2Accent2
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle2Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 2 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle2Accent2"'
+ - name: lightStyle2Accent3
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle2Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 2 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle2Accent3"'
+ - name: lightStyle2Accent4
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle2Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 2 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle2Accent4"'
+ - name: lightStyle2Accent5
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle2Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 2 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle2Accent5"'
+ - name: lightStyle2Accent6
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle2Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 2 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle2Accent6"'
+ - name: lightStyle3
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light Style 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle3"'
+ - name: lightStyle3Accent1
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle3Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 3 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle3Accent1"'
+ - name: lightStyle3Accent2
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle3Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 3 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle3Accent2"'
+ - name: lightStyle3Accent3
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle3Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 3 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle3Accent3"'
+ - name: lightStyle3Accent4
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle3Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 3 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle3Accent4"'
+ - name: lightStyle3Accent5
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle3Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 3 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle3Accent5"'
+ - name: lightStyle3Accent6
+ uid: powerpoint!PowerPoint.TableStyle.lightStyle3Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Light style 3 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"LightStyle3Accent6"'
+ - name: mediumStyle1
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium Style 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle1"'
+ - name: mediumStyle1Accent1
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle1Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 1 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle1Accent1"'
+ - name: mediumStyle1Accent2
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle1Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 1 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle1Accent2"'
+ - name: mediumStyle1Accent3
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle1Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 1 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle1Accent3"'
+ - name: mediumStyle1Accent4
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle1Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 1 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle1Accent4"'
+ - name: mediumStyle1Accent5
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle1Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 1 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle1Accent5"'
+ - name: mediumStyle1Accent6
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle1Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 1 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle1Accent6"'
+ - name: mediumStyle2
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium Style 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle2"'
+ - name: mediumStyle2Accent1
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle2Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 2 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle2Accent1"'
+ - name: mediumStyle2Accent2
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle2Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 2 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle2Accent2"'
+ - name: mediumStyle2Accent3
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle2Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 2 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle2Accent3"'
+ - name: mediumStyle2Accent4
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle2Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 2 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle2Accent4"'
+ - name: mediumStyle2Accent5
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle2Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 2 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle2Accent5"'
+ - name: mediumStyle2Accent6
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle2Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 2 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle2Accent6"'
+ - name: mediumStyle3
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium Style 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle3"'
+ - name: mediumStyle3Accent1
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle3Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 3 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle3Accent1"'
+ - name: mediumStyle3Accent2
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle3Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 3 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle3Accent2"'
+ - name: mediumStyle3Accent3
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle3Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 3 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle3Accent3"'
+ - name: mediumStyle3Accent4
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle3Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 3 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle3Accent4"'
+ - name: mediumStyle3Accent5
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle3Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 3 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle3Accent5"'
+ - name: mediumStyle3Accent6
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle3Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 3 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle3Accent6"'
+ - name: mediumStyle4
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium Style 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle4"'
+ - name: mediumStyle4Accent1
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle4Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 4 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle4Accent1"'
+ - name: mediumStyle4Accent2
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle4Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 4 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle4Accent2"'
+ - name: mediumStyle4Accent3
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle4Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 4 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle4Accent3"'
+ - name: mediumStyle4Accent4
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle4Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 4 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle4Accent4"'
+ - name: mediumStyle4Accent5
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle4Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 4 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle4Accent5"'
+ - name: mediumStyle4Accent6
+ uid: powerpoint!PowerPoint.TableStyle.mediumStyle4Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Medium style 4 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"MediumStyle4Accent6"'
+ - name: noStyleNoGrid
+ uid: powerpoint!PowerPoint.TableStyle.noStyleNoGrid:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "No style, No grid" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NoStyleNoGrid"'
+ - name: noStyleTableGrid
+ uid: powerpoint!PowerPoint.TableStyle.noStyleTableGrid:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "No style, Table grid" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"NoStyleTableGrid"'
+ - name: themedStyle1Accent1
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle1Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 1 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle1Accent1"'
+ - name: themedStyle1Accent2
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle1Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 1 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle1Accent2"'
+ - name: themedStyle1Accent3
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle1Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 1 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle1Accent3"'
+ - name: themedStyle1Accent4
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle1Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 1 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle1Accent4"'
+ - name: themedStyle1Accent5
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle1Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 1 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle1Accent5"'
+ - name: themedStyle1Accent6
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle1Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 1 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle1Accent6"'
+ - name: themedStyle2Accent1
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle2Accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 2 - Accent 1" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle2Accent1"'
+ - name: themedStyle2Accent2
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle2Accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 2 - Accent 2" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle2Accent2"'
+ - name: themedStyle2Accent3
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle2Accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 2 - Accent 3" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle2Accent3"'
+ - name: themedStyle2Accent4
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle2Accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 2 - Accent 4" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle2Accent4"'
+ - name: themedStyle2Accent5
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle2Accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 2 - Accent 5" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle2Accent5"'
+ - name: themedStyle2Accent6
+ uid: powerpoint!PowerPoint.TableStyle.themedStyle2Accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the style "Themed style 2 - Accent 6" in UI.
+
+
+ * \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"ThemedStyle2Accent6"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablestylesettings.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablestylesettings.yml
new file mode 100644
index 0000000000..de7a6b832f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tablestylesettings.yml
@@ -0,0 +1,304 @@
+### YamlMime:TSType
+name: PowerPoint.TableStyleSettings
+uid: powerpoint!PowerPoint.TableStyleSettings:class
+package: powerpoint!
+fullName: PowerPoint.TableStyleSettings
+summary: Represents the available table style settings.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: areColumnsBanded
+ uid: powerpoint!PowerPoint.TableStyleSettings#areColumnsBanded:member
+ package: powerpoint!
+ fullName: areColumnsBanded
+ summary: >-
+ Specifies if the columns show banded formatting in which odd columns are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areColumnsBanded: boolean;'
+ return:
+ type: boolean
+ - name: areRowsBanded
+ uid: powerpoint!PowerPoint.TableStyleSettings#areRowsBanded:member
+ package: powerpoint!
+ fullName: areRowsBanded
+ summary: >-
+ Specifies if the rows show banded formatting in which odd rows are
+ highlighted differently from even ones, to make reading the table easier.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'areRowsBanded: boolean;'
+ return:
+ type: boolean
+ - name: context
+ uid: powerpoint!PowerPoint.TableStyleSettings#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: isFirstColumnHighlighted
+ uid: powerpoint!PowerPoint.TableStyleSettings#isFirstColumnHighlighted:member
+ package: powerpoint!
+ fullName: isFirstColumnHighlighted
+ summary: Specifies if the first column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstColumnHighlighted: boolean;'
+ return:
+ type: boolean
+ - name: isFirstRowHighlighted
+ uid: powerpoint!PowerPoint.TableStyleSettings#isFirstRowHighlighted:member
+ package: powerpoint!
+ fullName: isFirstRowHighlighted
+ summary: Specifies if the first row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isFirstRowHighlighted: boolean;'
+ return:
+ type: boolean
+ - name: isLastColumnHighlighted
+ uid: powerpoint!PowerPoint.TableStyleSettings#isLastColumnHighlighted:member
+ package: powerpoint!
+ fullName: isLastColumnHighlighted
+ summary: Specifies if the last column contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastColumnHighlighted: boolean;'
+ return:
+ type: boolean
+ - name: isLastRowHighlighted
+ uid: powerpoint!PowerPoint.TableStyleSettings#isLastRowHighlighted:member
+ package: powerpoint!
+ fullName: isLastRowHighlighted
+ summary: Specifies if the last row contains special formatting.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'isLastRowHighlighted: boolean;'
+ return:
+ type: boolean
+ - name: style
+ uid: powerpoint!PowerPoint.TableStyleSettings#style:member
+ package: powerpoint!
+ fullName: style
+ summary: Specifies the table style.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.9](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ style: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" |
+ "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" |
+ "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" |
+ "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" |
+ "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" |
+ "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" |
+ "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" |
+ "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" |
+ "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" |
+ "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" |
+ "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" |
+ "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" |
+ "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" |
+ "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" |
+ "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" |
+ "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" |
+ "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" |
+ "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" |
+ "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" |
+ "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" |
+ "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" |
+ "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ return:
+ type: >-
+ | "NoStyleNoGrid"
+ | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" |
+ "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5"
+ | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" |
+ "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4"
+ | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" |
+ "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" |
+ "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" |
+ "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" |
+ "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" |
+ "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" |
+ "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" |
+ "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" |
+ "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3"
+ | "MediumStyle1Accent4" | "MediumStyle1Accent5" |
+ "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" |
+ "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4"
+ | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" |
+ "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3"
+ | "MediumStyle3Accent4" | "MediumStyle3Accent5" |
+ "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" |
+ "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4"
+ | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" |
+ "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" |
+ "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" |
+ "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" |
+ "DarkStyle2Accent3"
+methods:
+ - name: load(options)
+ uid: powerpoint!PowerPoint.TableStyleSettings#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.TableStyleSettingsLoadOptions):
+ PowerPoint.TableStyleSettings;
+ parameters:
+ - id: options
+ description: Provides options for which properties of the object to load.
+ type: >-
+
+ return:
+ type:
+ description: ''
+ - name: load(propertyNames)
+ uid: powerpoint!PowerPoint.TableStyleSettings#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.TableStyleSettings;'
+ 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.TableStyleSettings#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.TableStyleSettings;
+ 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.TableStyleSettings#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.TableStyleSettings` object is an API object, the `toJSON`
+ method returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.TableStyleSettingsData`) that contains
+ shallow copies of any loaded child properties from the original object.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;'
+ return:
+ type: >-
+
+ description: ''
+extends:
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tag.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tag.yml
new file mode 100644
index 0000000000..711c4e840c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/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_10/powerpoint/powerpoint.tagcollection.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tagcollection.yml
new file mode 100644
index 0000000000..5b699acf60
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.tagcollection.yml
@@ -0,0 +1,413 @@
+### 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's 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` doesn't 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 doesn't
+ 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 doesn't 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 doesn't 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(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 doesn't 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_10/powerpoint/powerpoint.textframe.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textframe.yml
new file mode 100644
index 0000000000..6824c29342
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textframe.yml
@@ -0,0 +1,415 @@
+### 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)
+ \]
+
+
+ #### 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.textRange.font.underline = PowerPoint.ShapeFontUnderlineStyle.heavy;
+ braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
+ braces.textFrame.autoSizeSetting = PowerPoint.ShapeAutoSize.autoSizeShapeToFitText;
+
+ return context.sync();
+ });
+
+ ```
+
+ 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_10/powerpoint/powerpoint.textrange.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textrange.yml
new file mode 100644
index 0000000000..26d08bad49
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textrange.yml
@@ -0,0 +1,476 @@
+### 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: hyperlinks
+ uid: powerpoint!PowerPoint.TextRange#hyperlinks:member
+ package: powerpoint!
+ fullName: hyperlinks
+ summary: Returns a collection of hyperlinks that exist on this `TextRange`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;'
+ 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
+
+
+ // Gets navigational (complex) properties of the selected text range.
+
+ await PowerPoint.run(async (context) => {
+ const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
+ textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
+ await context.sync();
+
+ console.log("Font properties of selected text range:");
+ console.log(`\tallCaps: ${textRange.font.allCaps}`);
+ console.log(`\tbold: ${textRange.font.bold}`);
+ console.log(`\tcolor: ${textRange.font.color}`);
+ console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
+ console.log(`\titalic: ${textRange.font.italic}`);
+ console.log(`\tname: ${textRange.font.name}`);
+ console.log(`\tsize: ${textRange.font.size}`);
+ console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
+ console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
+ console.log(`\tsubscript: ${textRange.font.subscript}`);
+ console.log(`\tsuperscript: ${textRange.font.superscript}`);
+ console.log(`\tunderline: ${textRange.font.underline}`);
+
+ console.log("Paragraph format properties of selected text range:");
+ console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
+ console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
+ });
+
+ ```
+
+ 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: setHyperlink(options)
+ uid: powerpoint!PowerPoint.TextRange#setHyperlink:member(1)
+ package: powerpoint!
+ fullName: setHyperlink(options)
+ summary: >-
+ Sets a hyperlink on this `TextRange` with the specified options. This will
+ delete all existing hyperlinks on this `TextRange`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setHyperlink(options?: PowerPoint.HyperlinkAddOptions):
+ PowerPoint.Hyperlink;
+ parameters:
+ - id: options
+ description: Optional. The options for the hyperlink.
+ type:
+ return:
+ type:
+ description: >-
+ The newly created
+ [PowerPoint.Hyperlink](xref:powerpoint!PowerPoint.Hyperlink:class)
+ object.
+ - 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_10/powerpoint/powerpoint.textrun.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textrun.yml
new file mode 100644
index 0000000000..0923e70920
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textrun.yml
@@ -0,0 +1,105 @@
+### 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)
+ \]
+
+
+ #### Examples
+
+
+ ```TypeScript
+
+ // Link to full sample:
+ https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
+
+
+ // Specifies the text runs of the cells in a table.
+
+ await PowerPoint.run(async (context) => {
+ const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
+
+ // Add a table, specifying text runs.
+ shapes.addTable(3, 4, {
+ specificCellProperties: [
+ [
+ { text: "Title text", font: { bold: true } },
+ { text: "Title text", font: { bold: true } },
+ { text: "Title text", font: { bold: true } },
+ { text: "Title text", font: { bold: true } }
+ ],
+ [
+ { text: "Bold text", font: { bold: true } },
+ {
+ textRuns: [
+ { text: "Text runs with " },
+ { text: "Underlined text", font: { underline: PowerPoint.ShapeFontUnderlineStyle.double } },
+ { text: " and plain text" }
+ ]
+ },
+ { text: "Italicized text", font: { italic: true } },
+ { text: "Plain text" }
+ ],
+ [
+ { text: "Bold text", font: { bold: true } },
+ { text: "Underlined text", font: { underline: PowerPoint.ShapeFontUnderlineStyle.dotted } },
+ {
+ font: { bold: true },
+ textRuns: [
+ { text: "Text runs with " },
+ { text: "italicized text", font: { italic: true } },
+ { text: " and (inherited) bold text" }
+ ]
+ },
+ { text: "Italicized text", font: { italic: true } }
+ ]
+ ]
+ });
+ await context.sync();
+ });
+
+ ```
+
+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_10/powerpoint/powerpoint.textverticalalignment.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textverticalalignment.yml
new file mode 100644
index 0000000000..77e9126450
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.textverticalalignment.yml
@@ -0,0 +1,137 @@
+### 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 of
+ the centered options is 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.textRange.font.underline = PowerPoint.ShapeFontUnderlineStyle.heavy;
+ braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
+ braces.textFrame.autoSizeSetting = PowerPoint.ShapeAutoSize.autoSizeShapeToFitText;
+
+ 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_10/powerpoint/powerpoint.themecolor.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.themecolor.yml
new file mode 100644
index 0000000000..ff58878d32
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.themecolor.yml
@@ -0,0 +1,168 @@
+### YamlMime:TSEnum
+name: PowerPoint.ThemeColor
+uid: powerpoint!PowerPoint.ThemeColor:enum
+package: powerpoint!
+fullName: PowerPoint.ThemeColor
+summary: Specifies the theme colors used in PowerPoint.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+fields:
+ - name: accent1
+ uid: powerpoint!PowerPoint.ThemeColor.accent1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Accent 1 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Accent1"'
+ - name: accent2
+ uid: powerpoint!PowerPoint.ThemeColor.accent2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Accent 2 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Accent2"'
+ - name: accent3
+ uid: powerpoint!PowerPoint.ThemeColor.accent3:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Accent 3 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Accent3"'
+ - name: accent4
+ uid: powerpoint!PowerPoint.ThemeColor.accent4:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Accent 4 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Accent4"'
+ - name: accent5
+ uid: powerpoint!PowerPoint.ThemeColor.accent5:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Accent 5 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Accent5"'
+ - name: accent6
+ uid: powerpoint!PowerPoint.ThemeColor.accent6:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Accent 6 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Accent6"'
+ - name: dark1
+ uid: powerpoint!PowerPoint.ThemeColor.dark1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Dark 1 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Dark1"'
+ - name: dark2
+ uid: powerpoint!PowerPoint.ThemeColor.dark2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Dark 2 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Dark2"'
+ - name: followedHyperlink
+ uid: powerpoint!PowerPoint.ThemeColor.followedHyperlink:member
+ package: powerpoint!
+ summary: >-
+ Specifies the clicked hyperlink theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"FollowedHyperlink"'
+ - name: hyperlink
+ uid: powerpoint!PowerPoint.ThemeColor.hyperlink:member
+ package: powerpoint!
+ summary: >-
+ Specifies the hyperlink theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Hyperlink"'
+ - name: light1
+ uid: powerpoint!PowerPoint.ThemeColor.light1:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Light 1 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Light1"'
+ - name: light2
+ uid: powerpoint!PowerPoint.ThemeColor.light2:member
+ package: powerpoint!
+ summary: >-
+ Specifies the Light 2 theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Light2"'
+ - name: mixed
+ uid: powerpoint!PowerPoint.ThemeColor.mixed:member
+ package: powerpoint!
+ summary: >-
+ Specifies a mixed theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"Mixed"'
+ - name: none
+ uid: powerpoint!PowerPoint.ThemeColor.none:member
+ package: powerpoint!
+ summary: >-
+ Specifies no theme color.
+
+
+ * \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+ value: '"None"'
diff --git a/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.themecolorscheme.yml b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.themecolorscheme.yml
new file mode 100644
index 0000000000..1cd0ad45cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/powerpoint/powerpoint.themecolorscheme.yml
@@ -0,0 +1,170 @@
+### YamlMime:TSType
+name: PowerPoint.ThemeColorScheme
+uid: powerpoint!PowerPoint.ThemeColorScheme:class
+package: powerpoint!
+fullName: PowerPoint.ThemeColorScheme
+summary: Represents a theme color scheme.
+remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+isPreview: false
+isDeprecated: false
+type: class
+properties:
+ - name: context
+ uid: powerpoint!PowerPoint.ThemeColorScheme#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: getThemeColor(color)
+ uid: powerpoint!PowerPoint.ThemeColorScheme#getThemeColor:member(1)
+ package: powerpoint!
+ fullName: getThemeColor(color)
+ summary: Gets the color value for the specified `ThemeColor`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getThemeColor(color: PowerPoint.ThemeColor):
+ OfficeExtension.ClientResult;
+ parameters:
+ - id: color
+ description: The theme color.
+ type:
+ return:
+ type: <string>
+ description: The color value in \#RRGGBB format (e.g., "FFA500").
+ - name: getThemeColor(color)
+ uid: powerpoint!PowerPoint.ThemeColorScheme#getThemeColor:member(2)
+ package: powerpoint!
+ fullName: getThemeColor(color)
+ summary: Gets the color value for the specified `ThemeColor`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" |
+ "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" |
+ "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"):
+ OfficeExtension.ClientResult;
+ parameters:
+ - id: color
+ description: The theme color.
+ type: >-
+ "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" |
+ "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" |
+ "Hyperlink" | "Light1" | "Light2"
+ return:
+ type: <string>
+ description: The color value in \#RRGGBB format (e.g., "FFA500").
+ - name: setThemeColor(color, rgbColor)
+ uid: powerpoint!PowerPoint.ThemeColorScheme#setThemeColor:member(1)
+ package: powerpoint!
+ fullName: setThemeColor(color, rgbColor)
+ summary: Sets the color value for the specified `ThemeColor`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;'
+ parameters:
+ - id: color
+ description: The theme color.
+ type:
+ - id: rgbColor
+ description: >-
+ The color value in \#RRGGBB format (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange").
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setThemeColor(color, rgbColor)
+ uid: powerpoint!PowerPoint.ThemeColorScheme#setThemeColor:member(2)
+ package: powerpoint!
+ fullName: setThemeColor(color, rgbColor)
+ summary: Sets the color value for the specified `ThemeColor`.
+ remarks: >-
+ \[ [API set: PowerPointApi
+ 1.10](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)
+ \]
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: >-
+ setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" |
+ "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" |
+ "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor:
+ string): void;
+ parameters:
+ - id: color
+ description: The theme color.
+ type: >-
+ "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" |
+ "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" |
+ "Hyperlink" | "Light1" | "Light2"
+ - id: rgbColor
+ description: >-
+ The color value in \#RRGGBB format (e.g., "FFA500") or as a named
+ HTML color (e.g., "orange").
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: toJSON()
+ uid: powerpoint!PowerPoint.ThemeColorScheme#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.ThemeColorScheme` object is an API object, the `toJSON` method
+ returns a plain JavaScript object (typed as
+ `PowerPoint.Interfaces.ThemeColorSchemeData`) 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_10/toc.yml b/docs/docs-ref-autogen/powerpoint_1_10/toc.yml
new file mode 100644
index 0000000000..84e46bbe61
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_10/toc.yml
@@ -0,0 +1,1188 @@
+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: BulletStyle
+ uid: powerpoint!PowerPoint.BulletStyle:enum
+ - name: BulletType
+ uid: powerpoint!PowerPoint.BulletType: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: HyperlinkType
+ uid: powerpoint!PowerPoint.HyperlinkType: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: ShapeGetImageFormatType
+ uid: powerpoint!PowerPoint.ShapeGetImageFormatType: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: SlideBackgroundFillType
+ uid: powerpoint!PowerPoint.SlideBackgroundFillType:enum
+ - name: SlideBackgroundGradientFillType
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillType:enum
+ - name: SlideBackgroundPatternFillType
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillType:enum
+ - name: SlideLayoutType
+ uid: powerpoint!PowerPoint.SlideLayoutType:enum
+ - name: TableStyle
+ uid: powerpoint!PowerPoint.TableStyle:enum
+ - name: TextVerticalAlignment
+ uid: powerpoint!PowerPoint.TextVerticalAlignment:enum
+ - name: ThemeColor
+ uid: powerpoint!PowerPoint.ThemeColor:enum
+ - name: AddSlideOptions
+ uid: powerpoint!PowerPoint.AddSlideOptions:interface
+ - name: Adjustments
+ uid: powerpoint!PowerPoint.Adjustments:class
+ - name: Application
+ uid: powerpoint!PowerPoint.Application:class
+ - name: Binding
+ uid: powerpoint!PowerPoint.Binding:class
+ - name: BindingCollection
+ uid: powerpoint!PowerPoint.BindingCollection:class
+ - name: Border
+ uid: powerpoint!PowerPoint.Border:class
+ - name: BorderProperties
+ uid: powerpoint!PowerPoint.BorderProperties:interface
+ - name: Borders
+ uid: powerpoint!PowerPoint.Borders:class
+ - 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: HyperlinkAddOptions
+ uid: powerpoint!PowerPoint.HyperlinkAddOptions:interface
+ - name: HyperlinkCollection
+ uid: powerpoint!PowerPoint.HyperlinkCollection:class
+ - name: HyperlinkScopedCollection
+ uid: powerpoint!PowerPoint.HyperlinkScopedCollection:class
+ - name: InsertSlideOptions
+ uid: powerpoint!PowerPoint.InsertSlideOptions:interface
+ - name: Margins
+ uid: powerpoint!PowerPoint.Margins:class
+ - name: PageSetup
+ uid: powerpoint!PowerPoint.PageSetup:class
+ - 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: ShapeGetImageOptions
+ uid: powerpoint!PowerPoint.ShapeGetImageOptions:interface
+ - 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: SlideBackground
+ uid: powerpoint!PowerPoint.SlideBackground:class
+ - name: SlideBackgroundFill
+ uid: powerpoint!PowerPoint.SlideBackgroundFill:class
+ - name: SlideBackgroundGradientFill
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFill:class
+ - name: SlideBackgroundGradientFillOptions
+ uid: powerpoint!PowerPoint.SlideBackgroundGradientFillOptions:interface
+ - name: SlideBackgroundPatternFill
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFill:class
+ - name: SlideBackgroundPatternFillOptions
+ uid: powerpoint!PowerPoint.SlideBackgroundPatternFillOptions:interface
+ - name: SlideBackgroundPictureOrTextureFill
+ uid: powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFill:class
+ - name: SlideBackgroundPictureOrTextureFillOptions
+ uid: >-
+ powerpoint!PowerPoint.SlideBackgroundPictureOrTextureFillOptions:interface
+ - name: SlideBackgroundSolidFill
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFill:class
+ - name: SlideBackgroundSolidFillOptions
+ uid: powerpoint!PowerPoint.SlideBackgroundSolidFillOptions:interface
+ - name: SlideCollection
+ uid: powerpoint!PowerPoint.SlideCollection:class
+ - name: SlideGetImageOptions
+ uid: powerpoint!PowerPoint.SlideGetImageOptions:interface
+ - name: SlideLayout
+ uid: powerpoint!PowerPoint.SlideLayout:class
+ - name: SlideLayoutBackground
+ uid: powerpoint!PowerPoint.SlideLayoutBackground:class
+ - name: SlideLayoutCollection
+ uid: powerpoint!PowerPoint.SlideLayoutCollection:class
+ - name: SlideMaster
+ uid: powerpoint!PowerPoint.SlideMaster:class
+ - name: SlideMasterBackground
+ uid: powerpoint!PowerPoint.SlideMasterBackground: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: TableClearOptions
+ uid: powerpoint!PowerPoint.TableClearOptions:interface
+ - name: TableColumn
+ uid: powerpoint!PowerPoint.TableColumn:class
+ - name: TableColumnCollection
+ uid: powerpoint!PowerPoint.TableColumnCollection:class
+ - name: TableColumnProperties
+ uid: powerpoint!PowerPoint.TableColumnProperties:interface
+ - name: TableMergedAreaProperties
+ uid: powerpoint!PowerPoint.TableMergedAreaProperties:interface
+ - name: TableRow
+ uid: powerpoint!PowerPoint.TableRow:class
+ - name: TableRowCollection
+ uid: powerpoint!PowerPoint.TableRowCollection:class
+ - name: TableRowProperties
+ uid: powerpoint!PowerPoint.TableRowProperties:interface
+ - name: TableStyleSettings
+ uid: powerpoint!PowerPoint.TableStyleSettings:class
+ - 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: ThemeColorScheme
+ uid: powerpoint!PowerPoint.ThemeColorScheme:class
+ - 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: AuthContext
+ uid: office!Office.AuthContext: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: ExtensionLifeCycle
+ uid: office!Office.ExtensionLifeCycle: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: TaskPane
+ uid: office!Office.TaskPane:interface
+ - 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
+ uid: ''
+ 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: ExcelApiDesktop 1.1 requirement set
+ href: >-
+ ../../requirement-sets/excel/excel-api-desktop-1-1-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.20 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md
+ displayName: Excel
+ - name: ExcelApi 1.19 requirement set
+ href: ../../requirement-sets/excel/excel-api-1-19-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.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
+ - name: PowerPointApi 1.9 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.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.4 requirement set
+ href: >-
+ ../../requirement-sets/word/word-api-desktop-1.4-requirement-set.md
+ displayName: Word
+ - name: WordApiDesktop 1.3 requirement set
+ href: >-
+ ../../requirement-sets/word/word-api-desktop-1.3-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
+ - name: Task Pane API requirement sets
+ href: ../../requirement-sets/common/task-pane-api-requirement-sets.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml
index 622df31b5c..ac270eec7b 100644
--- a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint.yml
@@ -14,6 +14,7 @@ enums:
- powerpoint!PowerPoint.InsertSlideFormatting:enum
interfaces:
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.BindingData:interface
@@ -39,9 +40,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
@@ -60,14 +66,33 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideLayoutCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideLayoutData:interface
- powerpoint!PowerPoint.Interfaces.SlideLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_2/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_2/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_2/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.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 9f01b4f412..a49bfde435 100644
--- a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml
@@ -866,6 +866,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 0d22361384..58720c6773 100644
--- a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint.yml
@@ -6,6 +6,7 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.BindingData:interface
@@ -31,9 +32,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
- powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface
@@ -54,16 +60,35 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_3/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_3/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_3/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml
index d8cacf07a8..2546dcf097 100644
--- a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml
@@ -884,6 +884,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 3b948d582d..9e9a010fa0 100644
--- a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint.yml
@@ -6,6 +6,7 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.BindingData:interface
@@ -32,9 +33,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
@@ -59,16 +65,35 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionData:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_4/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_4/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml
index 2c2c792081..38e21b0cd2 100644
--- a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml
@@ -920,6 +920,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 e86618542e..b0ca65fc99 100644
--- a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint.yml
@@ -6,6 +6,7 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.BindingData:interface
@@ -32,9 +33,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
@@ -60,16 +66,35 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_5/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_5/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml
index c0db41b50a..80eed02e7f 100644
--- a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml
@@ -924,6 +924,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 9cfb299003..731fa2fd45 100644
--- a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint.yml
@@ -6,6 +6,7 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.BindingData:interface
@@ -34,9 +35,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
@@ -62,16 +68,35 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_6/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_6/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml
index bf351f56c8..5fb8aa484d 100644
--- a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml
@@ -928,6 +928,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 a1cfd66fcf..a8d6594607 100644
--- a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint.yml
@@ -6,6 +6,7 @@ summary: ''
interfaces:
- powerpoint!PowerPoint.AddSlideOptions:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.BindingData:interface
@@ -43,9 +44,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
@@ -71,16 +77,35 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_7/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_7/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml
index 72ecae756d..dc03daaf10 100644
--- a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml
@@ -942,6 +942,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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
index 3bbb80e5fe..1145372612 100644
--- a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint.yml
@@ -9,6 +9,7 @@ interfaces:
- powerpoint!PowerPoint.FillProperties:interface
- powerpoint!PowerPoint.FontProperties:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
@@ -48,9 +49,14 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
@@ -78,16 +84,35 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml
index 3f161c6322..2fdd12d143 100644
--- a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml
@@ -988,6 +988,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint.yml
index a668e7f7c8..803c467984 100644
--- a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint.yml
@@ -9,6 +9,7 @@ interfaces:
- powerpoint!PowerPoint.FillProperties:interface
- powerpoint!PowerPoint.FontProperties:interface
- powerpoint!PowerPoint.InsertSlideOptions:interface
+ - powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionData:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.BindingCollectionUpdateData:interface
@@ -50,10 +51,15 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.HyperlinkCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkLoadOptions:interface
+ - powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.HyperlinkUpdateData:interface
- powerpoint!PowerPoint.Interfaces.MarginsData:interface
- powerpoint!PowerPoint.Interfaces.MarginsLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.MarginsUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+ - powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatData:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ParagraphFormatUpdateData:interface
@@ -81,16 +87,35 @@ interfaces:
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.ShapeScopedCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.ShapeUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+ - >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideCollectionUpdateData:interface
- powerpoint!PowerPoint.Interfaces.SlideData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+ - powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData: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.SlideMasterBackgroundData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionData:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionLoadOptions:interface
- powerpoint!PowerPoint.Interfaces.SlideMasterCollectionUpdateData:interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.adjustmentsdata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
new file mode 100644
index 0000000000..7abcdc03de
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.adjustmentsdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.AdjustmentsData
+uid: powerpoint!PowerPoint.Interfaces.AdjustmentsData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.AdjustmentsData
+summary: >-
+ An interface describing the data returned by calling
+ `adjustments.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
new file mode 100644
index 0000000000..3231732b5b
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectiondata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionData
+summary: >-
+ An interface describing the data returned by calling
+ `hyperlinkScopedCollection.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionData#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_9/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
new file mode 100644
index 0000000000..56050fa77e
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.hyperlinkscopedcollectionupdatedata.yml
@@ -0,0 +1,30 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+uid: powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData
+summary: >-
+ An interface for updating data on the `HyperlinkScopedCollection` object, for
+ use in `hyperlinkScopedCollection.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
+properties:
+ - name: items
+ uid: >-
+ powerpoint!PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData#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_9/powerpoint/powerpoint.interfaces.pagesetupdata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.pagesetupdata.yml
new file mode 100644
index 0000000000..a001e6debf
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.pagesetupdata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupData
+summary: >-
+ An interface describing the data returned by calling `pageSetup.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
new file mode 100644
index 0000000000..7ffb095cd0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.pagesetupupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.PageSetupUpdateData
+uid: powerpoint!PowerPoint.Interfaces.PageSetupUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.PageSetupUpdateData
+summary: >-
+ An interface for updating data on the `PageSetup` object, for use in
+ `pageSetup.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
new file mode 100644
index 0000000000..3450e5be83
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
new file mode 100644
index 0000000000..31af343ffc
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
new file mode 100644
index 0000000000..475650172c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundgradientfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundGradientFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
new file mode 100644
index 0000000000..f8c8c6ef81
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundgradientfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundGradientFill` object,
+ for use in `slideBackgroundGradientFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
new file mode 100644
index 0000000000..592c175516
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpatternfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPatternFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
new file mode 100644
index 0000000000..3611e7a52f
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpatternfillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPatternFill` object, for
+ use in `slideBackgroundPatternFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
new file mode 100644
index 0000000000..ec20c131cd
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefilldata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundPictureOrTextureFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
new file mode 100644
index 0000000000..dbe45250b1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundpictureortexturefillupdatedata.yml
@@ -0,0 +1,14 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+uid: >-
+ powerpoint!PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundPictureOrTextureFill`
+ object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
new file mode 100644
index 0000000000..474a704423
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundsolidfilldata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillData
+summary: >-
+ An interface describing the data returned by calling
+ `slideBackgroundSolidFill.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
new file mode 100644
index 0000000000..c49930559c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundsolidfillupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackgroundSolidFill` object, for
+ use in `slideBackgroundSolidFill.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
new file mode 100644
index 0000000000..8143b2e075
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidebackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideBackground` object, for use in
+ `slideBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
new file mode 100644
index 0000000000..dc0ad69c3c
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidelayoutbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideLayoutBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
new file mode 100644
index 0000000000..375bc0d7d0
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidelayoutbackgroundupdatedata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+uid: powerpoint!PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData
+summary: >-
+ An interface for updating data on the `SlideLayoutBackground` object, for use
+ in `slideLayoutBackground.set({ ... })`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
new file mode 100644
index 0000000000..4487b49ed1
--- /dev/null
+++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.interfaces.slidemasterbackgrounddata.yml
@@ -0,0 +1,13 @@
+### YamlMime:TSType
+name: PowerPoint.Interfaces.SlideMasterBackgroundData
+uid: powerpoint!PowerPoint.Interfaces.SlideMasterBackgroundData:interface
+package: powerpoint!
+fullName: PowerPoint.Interfaces.SlideMasterBackgroundData
+summary: >-
+ An interface describing the data returned by calling
+ `slideMasterBackground.toJSON()`.
+remarks: ''
+
+isPreview: false
+isDeprecated: false
+type: interface
diff --git a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml
index 3a5d29fb76..55c4d1aae8 100644
--- a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml
+++ b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml
@@ -1008,6 +1008,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/visio/toc.yml b/docs/docs-ref-autogen/visio/toc.yml
index 0916093c8c..57c70e1d5f 100644
--- a/docs/docs-ref-autogen/visio/toc.yml
+++ b/docs/docs-ref-autogen/visio/toc.yml
@@ -691,6 +691,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml
index 30040d398d..69ebd75b68 100644
--- a/docs/docs-ref-autogen/word/toc.yml
+++ b/docs/docs-ref-autogen/word/toc.yml
@@ -1810,6 +1810,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 45f64e8c3f..2eb5999c35 100644
--- a/docs/docs-ref-autogen/word_1_1/toc.yml
+++ b/docs/docs-ref-autogen/word_1_1/toc.yml
@@ -900,6 +900,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 45f64e8c3f..2eb5999c35 100644
--- a/docs/docs-ref-autogen/word_1_2/toc.yml
+++ b/docs/docs-ref-autogen/word_1_2/toc.yml
@@ -900,6 +900,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 6acb2cfd10..87c25f2070 100644
--- a/docs/docs-ref-autogen/word_1_3/toc.yml
+++ b/docs/docs-ref-autogen/word_1_3/toc.yml
@@ -956,6 +956,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 6acb2cfd10..87c25f2070 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
@@ -956,6 +956,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 b5935651db..916732a4c9 100644
--- a/docs/docs-ref-autogen/word_1_4/toc.yml
+++ b/docs/docs-ref-autogen/word_1_4/toc.yml
@@ -984,6 +984,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 b5935651db..916732a4c9 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
@@ -984,6 +984,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 f58ae414b9..3cf9a59347 100644
--- a/docs/docs-ref-autogen/word_1_5/toc.yml
+++ b/docs/docs-ref-autogen/word_1_5/toc.yml
@@ -1026,6 +1026,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 f58ae414b9..3cf9a59347 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
@@ -1026,6 +1026,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 00c71a49d9..d78da52b18 100644
--- a/docs/docs-ref-autogen/word_1_6/toc.yml
+++ b/docs/docs-ref-autogen/word_1_6/toc.yml
@@ -1042,6 +1042,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 74ee821e44..2fdec85548 100644
--- a/docs/docs-ref-autogen/word_1_7/toc.yml
+++ b/docs/docs-ref-autogen/word_1_7/toc.yml
@@ -1068,6 +1068,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 3487fdf744..6a23fc0ccb 100644
--- a/docs/docs-ref-autogen/word_1_8/toc.yml
+++ b/docs/docs-ref-autogen/word_1_8/toc.yml
@@ -1072,6 +1072,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 01b41f18ac..aed4d9486a 100644
--- a/docs/docs-ref-autogen/word_1_9/toc.yml
+++ b/docs/docs-ref-autogen/word_1_9/toc.yml
@@ -1080,6 +1080,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 47bc9b398c..d298322868 100644
--- a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml
+++ b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml
@@ -1098,6 +1098,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-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 8d8359b601..e1460311e8 100644
--- a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml
+++ b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml
@@ -1160,6 +1160,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_desktop_1_3/toc.yml b/docs/docs-ref-autogen/word_desktop_1_3/toc.yml
index 1ce6f94a34..8921ab41e5 100644
--- a/docs/docs-ref-autogen/word_desktop_1_3/toc.yml
+++ b/docs/docs-ref-autogen/word_desktop_1_3/toc.yml
@@ -1422,6 +1422,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_desktop_1_4/toc.yml b/docs/docs-ref-autogen/word_desktop_1_4/toc.yml
index d6c044b750..e3aa64c110 100644
--- a/docs/docs-ref-autogen/word_desktop_1_4/toc.yml
+++ b/docs/docs-ref-autogen/word_desktop_1_4/toc.yml
@@ -1754,6 +1754,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/docs-ref-autogen/word_online/toc.yml b/docs/docs-ref-autogen/word_online/toc.yml
index 01b41f18ac..aed4d9486a 100644
--- a/docs/docs-ref-autogen/word_online/toc.yml
+++ b/docs/docs-ref-autogen/word_online/toc.yml
@@ -1080,6 +1080,10 @@ items:
- name: PowerPoint preview APIs
href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: >-
+ ../../requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: >-
../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
diff --git a/docs/includes/powerpoint-1_10.md b/docs/includes/powerpoint-1_10.md
new file mode 100644
index 0000000000..531f45f166
--- /dev/null
+++ b/docs/includes/powerpoint-1_10.md
@@ -0,0 +1,83 @@
+| Class | Fields | Description |
+|:---|:---|:---|
+|[Adjustments](/javascript/api/powerpoint/powerpoint.adjustments)|[count](/javascript/api/powerpoint/powerpoint.adjustments#powerpoint-powerpoint-adjustments-count-member)|Specifies the number of adjustment points.|
+||[get(index: number)](/javascript/api/powerpoint/powerpoint.adjustments#powerpoint-powerpoint-adjustments-get-member(1))|Gets the adjustment value at the specified zero-based index.|
+|[BulletFormat](/javascript/api/powerpoint/powerpoint.bulletformat)|[style](/javascript/api/powerpoint/powerpoint.bulletformat#powerpoint-powerpoint-bulletformat-style-member)|Specifies the style of the bullets in the paragraph.|
+||[type](/javascript/api/powerpoint/powerpoint.bulletformat#powerpoint-powerpoint-bulletformat-type-member)|Specifies the type of the bullets in the paragraph.|
+|[CustomPropertyCollection](/javascript/api/powerpoint/powerpoint.custompropertycollection)|[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getitemat-member(1))|Gets a `CustomProperty` by its zero-based index in the collection.|
+|[CustomXmlPartCollection](/javascript/api/powerpoint/powerpoint.customxmlpartcollection)|[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getitemat-member(1))|Gets a `CustomXmlPart` by its zero-based index in the collection.|
+|[CustomXmlPartScopedCollection](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection)|[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getitemat-member(1))|Gets a `CustomXmlPart` by its zero-based index in the collection.|
+|[Hyperlink](/javascript/api/powerpoint/powerpoint.hyperlink)|[delete()](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-delete-member(1))|Deletes the hyperlink.|
+||[getLinkedShapeOrNullObject()](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-getlinkedshapeornullobject-member(1))|Returns the PowerPoint.Shape object that the hyperlink is applied to.|
+||[getLinkedTextRangeOrNullObject()](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-getlinkedtextrangeornullobject-member(1))|Returns the PowerPoint.TextRange object that the hyperlink is applied to.|
+||[type](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-type-member)|Returns the type of object that the hyperlink is applied to.|
+|[HyperlinkAddOptions](/javascript/api/powerpoint/powerpoint.hyperlinkaddoptions)|[address](/javascript/api/powerpoint/powerpoint.hyperlinkaddoptions#powerpoint-powerpoint-hyperlinkaddoptions-address-member)|Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.|
+||[screenTip](/javascript/api/powerpoint/powerpoint.hyperlinkaddoptions#powerpoint-powerpoint-hyperlinkaddoptions-screentip-member)|Specifies the string displayed when hovering over the hyperlink.|
+|[HyperlinkCollection](/javascript/api/powerpoint/powerpoint.hyperlinkcollection)|[add(target: TextRange \| Shape, options?: PowerPoint.HyperlinkAddOptions)](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-add-member(1))|Adds a hyperlink to the specified target with the given options.|
+|[HyperlinkScopedCollection](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection#powerpoint-powerpoint-hyperlinkscopedcollection-getcount-member(1))|Gets the number of hyperlinks in the collection.|
+||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection#powerpoint-powerpoint-hyperlinkscopedcollection-getitemat-member(1))|Gets a hyperlink using its zero-based index in the collection.|
+||[items](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection#powerpoint-powerpoint-hyperlinkscopedcollection-items-member)|Gets the loaded child items in this collection.|
+|[PageSetup](/javascript/api/powerpoint/powerpoint.pagesetup)|[slideHeight](/javascript/api/powerpoint/powerpoint.pagesetup#powerpoint-powerpoint-pagesetup-slideheight-member)|Specifies the height of the slides in the presentation, in points.|
+||[slideWidth](/javascript/api/powerpoint/powerpoint.pagesetup#powerpoint-powerpoint-pagesetup-slidewidth-member)|Specifies the width of the slides in the presentation, in points.|
+|[ParagraphFormat](/javascript/api/powerpoint/powerpoint.paragraphformat)|[indentLevel](/javascript/api/powerpoint/powerpoint.paragraphformat#powerpoint-powerpoint-paragraphformat-indentlevel-member)|Represents the indent level of the paragraph.|
+|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[pageSetup](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-pagesetup-member)|Returns the page setup information whose properties control slide setup attributes for the presentation.|
+|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[adjustments](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-adjustments-member)|Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.|
+||[altTextDescription](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-alttextdescription-member)|The alt text description of the Shape.|
+||[altTextTitle](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-alttexttitle-member)|The alt text title of the Shape.|
+||[creationId](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-creationid-member)|Gets the creation ID of the shape.|
+||[getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getimageasbase64-member(1))|Renders an image of the shape.|
+||[getTextFrameOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-gettextframeornullobject-member(1))|Returns the PowerPoint.TextFrame object of this `Shape`.|
+||[isDecorative](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-isdecorative-member)|Represents whether the shape is decorative or not.|
+||[rotation](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-rotation-member)|Specifies the rotation, in degrees, of the shape around the z-axis.|
+||[setHyperlink(options?: PowerPoint.HyperlinkAddOptions)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-sethyperlink-member(1))|Sets a hyperlink on this `Shape` with the specified options.|
+||[visible](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-visible-member)|Specifies if the shape is visible.|
+|[ShapeGetImageOptions](/javascript/api/powerpoint/powerpoint.shapegetimageoptions)|[format](/javascript/api/powerpoint/powerpoint.shapegetimageoptions#powerpoint-powerpoint-shapegetimageoptions-format-member)|The desired format of the resulting image.|
+||[height](/javascript/api/powerpoint/powerpoint.shapegetimageoptions#powerpoint-powerpoint-shapegetimageoptions-height-member)|The desired height of the resulting image in pixels.|
+||[width](/javascript/api/powerpoint/powerpoint.shapegetimageoptions#powerpoint-powerpoint-shapegetimageoptions-width-member)|The desired width of the resulting image in pixels.|
+|[ShapeGroup](/javascript/api/powerpoint/powerpoint.shapegroup)|[creationId](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-creationid-member)|Gets the creation ID of the shape group.|
+|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[background](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-background-member)|Gets the background of the slide.|
+||[themeColorScheme](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide.|
+|[SlideBackground](/javascript/api/powerpoint/powerpoint.slidebackground)|[areBackgroundGraphicsHidden](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.|
+||[fill](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-fill-member)|Returns the fill formatting of the background.|
+||[isMasterBackgroundFollowed](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-ismasterbackgroundfollowed-member)|Specifies if the slide background follows the slide master background.|
+||[reset()](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-reset-member(1))|Resets the fill formatting of the slide background.|
+|[SlideBackgroundFill](/javascript/api/powerpoint/powerpoint.slidebackgroundfill)|[getGradientFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getgradientfillornullobject-member(1))|Gets the gradient fill properties.|
+||[getPatternFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getpatternfillornullobject-member(1))|Gets the pattern fill properties.|
+||[getPictureOrTextureFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getpictureortexturefillornullobject-member(1))|Gets the picture or texture fill properties.|
+||[getSolidFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getsolidfillornullobject-member(1))|Gets the solid fill properties.|
+||[setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setgradientfill-member(1))|Sets the fill formatting of the slide background to a gradient fill.|
+||[setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setpatternfill-member(1))|Sets the fill formatting of the slide background to a pattern fill.|
+||[setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setpictureortexturefill-member(1))|Sets the fill formatting of the slide background to a picture or texture fill.|
+||[setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setsolidfill-member(1))|Sets the fill formatting of the slide background to a solid fill.|
+||[type](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-type-member)|Returns the fill type of the slide background.|
+|[SlideBackgroundGradientFill](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfill)|[type](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfill#powerpoint-powerpoint-slidebackgroundgradientfill-type-member)|Specifies the type of gradient fill.|
+|[SlideBackgroundGradientFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfilloptions)|[type](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfilloptions#powerpoint-powerpoint-slidebackgroundgradientfilloptions-type-member)|If provided, specifies the type of gradient fill.|
+|[SlideBackgroundPatternFill](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill)|[backgroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill#powerpoint-powerpoint-slidebackgroundpatternfill-backgroundcolor-member)|Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").|
+||[foregroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill#powerpoint-powerpoint-slidebackgroundpatternfill-foregroundcolor-member)|Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").|
+||[pattern](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill#powerpoint-powerpoint-slidebackgroundpatternfill-pattern-member)|Specifies the pattern type.|
+|[SlideBackgroundPatternFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions)|[backgroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions#powerpoint-powerpoint-slidebackgroundpatternfilloptions-backgroundcolor-member)|If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").|
+||[foregroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions#powerpoint-powerpoint-slidebackgroundpatternfilloptions-foregroundcolor-member)|If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").|
+||[pattern](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions#powerpoint-powerpoint-slidebackgroundpatternfilloptions-pattern-member)|If provided, specifies the pattern type.|
+|[SlideBackgroundPictureOrTextureFill](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefill)|[setImage(base64EncodedImage: string)](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefill#powerpoint-powerpoint-slidebackgroundpictureortexturefill-setimage-member(1))|Sets the image used to fill.|
+||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefill#powerpoint-powerpoint-slidebackgroundpictureortexturefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
+|[SlideBackgroundPictureOrTextureFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions)|[imageBase64](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions#powerpoint-powerpoint-slidebackgroundpictureortexturefilloptions-imagebase64-member)|If provided, specifies the Base64-encoded image data for the fill.|
+||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions#powerpoint-powerpoint-slidebackgroundpictureortexturefilloptions-transparency-member)|If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
+|[SlideBackgroundSolidFill](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfill)|[color](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfill#powerpoint-powerpoint-slidebackgroundsolidfill-color-member)|Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").|
+||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfill#powerpoint-powerpoint-slidebackgroundsolidfill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
+|[SlideBackgroundSolidFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfilloptions)|[color](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfilloptions#powerpoint-powerpoint-slidebackgroundsolidfilloptions-color-member)|If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").|
+||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfilloptions#powerpoint-powerpoint-slidebackgroundsolidfilloptions-transparency-member)|If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
+|[SlideCollection](/javascript/api/powerpoint/powerpoint.slidecollection)|[exportAsBase64Presentation(values: Array)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-exportasbase64presentation-member(1))|Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.|
+|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[background](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-background-member)|Gets the background of the slide layout.|
+||[themeColorScheme](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide layout.|
+|[SlideLayoutBackground](/javascript/api/powerpoint/powerpoint.slidelayoutbackground)|[areBackgroundGraphicsHidden](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.|
+||[fill](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-fill-member)|Returns the fill formatting of the background.|
+||[isMasterBackgroundFollowed](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-ismasterbackgroundfollowed-member)|Specifies if the slide layout background follows the slide master background.|
+||[reset()](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-reset-member(1))|Resets the fill formatting of the slide layout background.|
+|[SlideMaster](/javascript/api/powerpoint/powerpoint.slidemaster)|[background](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-background-member)|Gets the background of the Slide Master.|
+||[themeColorScheme](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-themecolorscheme-member)|Returns the `ThemeColorScheme` of the Slide Master.|
+|[SlideMasterBackground](/javascript/api/powerpoint/powerpoint.slidemasterbackground)|[fill](/javascript/api/powerpoint/powerpoint.slidemasterbackground#powerpoint-powerpoint-slidemasterbackground-fill-member)|Returns the fill formatting of the background.|
+|[SlideScopedCollection](/javascript/api/powerpoint/powerpoint.slidescopedcollection)|[exportAsBase64Presentation()](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-exportasbase64presentation-member(1))|Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.|
+|[TextRange](/javascript/api/powerpoint/powerpoint.textrange)|[hyperlinks](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-hyperlinks-member)|Returns a collection of hyperlinks that exist on this `TextRange`.|
+||[setHyperlink(options?: PowerPoint.HyperlinkAddOptions)](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-sethyperlink-member(1))|Sets a hyperlink on this `TextRange` with the specified options.|
+|[ThemeColorScheme](/javascript/api/powerpoint/powerpoint.themecolorscheme)|[getThemeColor(color: PowerPoint.ThemeColor)](/javascript/api/powerpoint/powerpoint.themecolorscheme#powerpoint-powerpoint-themecolorscheme-getthemecolor-member(1))|Gets the color value for the specified `ThemeColor`.|
+||[setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string)](/javascript/api/powerpoint/powerpoint.themecolorscheme#powerpoint-powerpoint-themecolorscheme-setthemecolor-member(1))|Sets the color value for the specified `ThemeColor`.|
diff --git a/docs/includes/powerpoint-preview.md b/docs/includes/powerpoint-preview.md
index bcb2a59fc8..a700bc1ae7 100644
--- a/docs/includes/powerpoint-preview.md
+++ b/docs/includes/powerpoint-preview.md
@@ -1,84 +1,3 @@
| Class | Fields | Description |
|:---|:---|:---|
-|[Adjustments](/javascript/api/powerpoint/powerpoint.adjustments)|[count](/javascript/api/powerpoint/powerpoint.adjustments#powerpoint-powerpoint-adjustments-count-member)|Specifies the number of adjustment points.|
-||[get(index: number)](/javascript/api/powerpoint/powerpoint.adjustments#powerpoint-powerpoint-adjustments-get-member(1))|Gets the adjustment value at the specified zero-based index.|
-|[BulletFormat](/javascript/api/powerpoint/powerpoint.bulletformat)|[style](/javascript/api/powerpoint/powerpoint.bulletformat#powerpoint-powerpoint-bulletformat-style-member)|Specifies the style of the bullets in the paragraph.|
-||[type](/javascript/api/powerpoint/powerpoint.bulletformat#powerpoint-powerpoint-bulletformat-type-member)|Specifies the type of the bullets in the paragraph.|
-|[CustomPropertyCollection](/javascript/api/powerpoint/powerpoint.custompropertycollection)|[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getitemat-member(1))|Gets a `CustomProperty` by its zero-based index in the collection.|
-|[CustomXmlPartCollection](/javascript/api/powerpoint/powerpoint.customxmlpartcollection)|[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getitemat-member(1))|Gets a `CustomXmlPart` by its zero-based index in the collection.|
-|[CustomXmlPartScopedCollection](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection)|[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getitemat-member(1))|Gets a `CustomXmlPart` by its zero-based index in the collection.|
-|[Hyperlink](/javascript/api/powerpoint/powerpoint.hyperlink)|[delete()](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-delete-member(1))|Deletes the hyperlink.|
-||[getLinkedShapeOrNullObject()](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-getlinkedshapeornullobject-member(1))|Returns the PowerPoint.Shape object that the hyperlink is applied to.|
-||[getLinkedTextRangeOrNullObject()](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-getlinkedtextrangeornullobject-member(1))|Returns the PowerPoint.TextRange object that the hyperlink is applied to.|
-||[type](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-type-member)|Returns the type of object that the hyperlink is applied to.|
-|[HyperlinkAddOptions](/javascript/api/powerpoint/powerpoint.hyperlinkaddoptions)|[address](/javascript/api/powerpoint/powerpoint.hyperlinkaddoptions#powerpoint-powerpoint-hyperlinkaddoptions-address-member)|Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.|
-||[screenTip](/javascript/api/powerpoint/powerpoint.hyperlinkaddoptions#powerpoint-powerpoint-hyperlinkaddoptions-screentip-member)|Specifies the string displayed when hovering over the hyperlink.|
-|[HyperlinkCollection](/javascript/api/powerpoint/powerpoint.hyperlinkcollection)|[add(target: TextRange \| Shape, options?: PowerPoint.HyperlinkAddOptions)](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-add-member(1))|Adds a hyperlink to the specified target with the given options.|
-|[HyperlinkScopedCollection](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection#powerpoint-powerpoint-hyperlinkscopedcollection-getcount-member(1))|Gets the number of hyperlinks in the collection.|
-||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection#powerpoint-powerpoint-hyperlinkscopedcollection-getitemat-member(1))|Gets a hyperlink using its zero-based index in the collection.|
-||[items](/javascript/api/powerpoint/powerpoint.hyperlinkscopedcollection#powerpoint-powerpoint-hyperlinkscopedcollection-items-member)|Gets the loaded child items in this collection.|
-|[PageSetup](/javascript/api/powerpoint/powerpoint.pagesetup)|[slideHeight](/javascript/api/powerpoint/powerpoint.pagesetup#powerpoint-powerpoint-pagesetup-slideheight-member)|Specifies the height of the slides in the presentation, in points.|
-||[slideWidth](/javascript/api/powerpoint/powerpoint.pagesetup#powerpoint-powerpoint-pagesetup-slidewidth-member)|Specifies the width of the slides in the presentation, in points.|
-|[ParagraphFormat](/javascript/api/powerpoint/powerpoint.paragraphformat)|[indentLevel](/javascript/api/powerpoint/powerpoint.paragraphformat#powerpoint-powerpoint-paragraphformat-indentlevel-member)|Represents the indent level of the paragraph.|
|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[getActiveSlideOrNullObject()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getactiveslideornullobject-member(1))|Returns the current active PowerPoint.Slide that is visible in the editing area.|
-||[pageSetup](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-pagesetup-member)|Returns the page setup information whose properties control slide setup attributes for the presentation.|
-|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[adjustments](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-adjustments-member)|Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.|
-||[altTextDescription](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-alttextdescription-member)|The alt text description of the Shape.|
-||[altTextTitle](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-alttexttitle-member)|The alt text title of the Shape.|
-||[creationId](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-creationid-member)|Gets the creation ID of the shape.|
-||[getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getimageasbase64-member(1))|Renders an image of the shape.|
-||[getTextFrameOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-gettextframeornullobject-member(1))|Returns the PowerPoint.TextFrame object of this `Shape`.|
-||[isDecorative](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-isdecorative-member)|Represents whether the shape is decorative or not.|
-||[rotation](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-rotation-member)|Specifies the rotation, in degrees, of the shape around the z-axis.|
-||[setHyperlink(options?: PowerPoint.HyperlinkAddOptions)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-sethyperlink-member(1))|Sets a hyperlink on this `Shape` with the specified options.|
-||[visible](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-visible-member)|Specifies if the shape is visible.|
-|[ShapeGetImageOptions](/javascript/api/powerpoint/powerpoint.shapegetimageoptions)|[format](/javascript/api/powerpoint/powerpoint.shapegetimageoptions#powerpoint-powerpoint-shapegetimageoptions-format-member)|The desired format of the resulting image.|
-||[height](/javascript/api/powerpoint/powerpoint.shapegetimageoptions#powerpoint-powerpoint-shapegetimageoptions-height-member)|The desired height of the resulting image in pixels.|
-||[width](/javascript/api/powerpoint/powerpoint.shapegetimageoptions#powerpoint-powerpoint-shapegetimageoptions-width-member)|The desired width of the resulting image in pixels.|
-|[ShapeGroup](/javascript/api/powerpoint/powerpoint.shapegroup)|[creationId](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-creationid-member)|Gets the creation ID of the shape group.|
-|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[background](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-background-member)|Gets the background of the slide.|
-||[themeColorScheme](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide.|
-|[SlideBackground](/javascript/api/powerpoint/powerpoint.slidebackground)|[areBackgroundGraphicsHidden](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.|
-||[fill](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-fill-member)|Returns the fill formatting of the background.|
-||[isMasterBackgroundFollowed](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-ismasterbackgroundfollowed-member)|Specifies if the slide background follows the slide master background.|
-||[reset()](/javascript/api/powerpoint/powerpoint.slidebackground#powerpoint-powerpoint-slidebackground-reset-member(1))|Resets the fill formatting of the slide background.|
-|[SlideBackgroundFill](/javascript/api/powerpoint/powerpoint.slidebackgroundfill)|[getGradientFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getgradientfillornullobject-member(1))|Gets the gradient fill properties.|
-||[getPatternFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getpatternfillornullobject-member(1))|Gets the pattern fill properties.|
-||[getPictureOrTextureFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getpictureortexturefillornullobject-member(1))|Gets the picture or texture fill properties.|
-||[getSolidFillOrNullObject()](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-getsolidfillornullobject-member(1))|Gets the solid fill properties.|
-||[setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setgradientfill-member(1))|Sets the fill formatting of the slide background to a gradient fill.|
-||[setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setpatternfill-member(1))|Sets the fill formatting of the slide background to a pattern fill.|
-||[setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setpictureortexturefill-member(1))|Sets the fill formatting of the slide background to a picture or texture fill.|
-||[setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions)](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-setsolidfill-member(1))|Sets the fill formatting of the slide background to a solid fill.|
-||[type](/javascript/api/powerpoint/powerpoint.slidebackgroundfill#powerpoint-powerpoint-slidebackgroundfill-type-member)|Returns the fill type of the slide background.|
-|[SlideBackgroundGradientFill](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfill)|[type](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfill#powerpoint-powerpoint-slidebackgroundgradientfill-type-member)|Specifies the type of gradient fill.|
-|[SlideBackgroundGradientFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfilloptions)|[type](/javascript/api/powerpoint/powerpoint.slidebackgroundgradientfilloptions#powerpoint-powerpoint-slidebackgroundgradientfilloptions-type-member)|If provided, specifies the type of gradient fill.|
-|[SlideBackgroundPatternFill](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill)|[backgroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill#powerpoint-powerpoint-slidebackgroundpatternfill-backgroundcolor-member)|Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").|
-||[foregroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill#powerpoint-powerpoint-slidebackgroundpatternfill-foregroundcolor-member)|Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").|
-||[pattern](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfill#powerpoint-powerpoint-slidebackgroundpatternfill-pattern-member)|Specifies the pattern type.|
-|[SlideBackgroundPatternFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions)|[backgroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions#powerpoint-powerpoint-slidebackgroundpatternfilloptions-backgroundcolor-member)|If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").|
-||[foregroundColor](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions#powerpoint-powerpoint-slidebackgroundpatternfilloptions-foregroundcolor-member)|If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").|
-||[pattern](/javascript/api/powerpoint/powerpoint.slidebackgroundpatternfilloptions#powerpoint-powerpoint-slidebackgroundpatternfilloptions-pattern-member)|If provided, specifies the pattern type.|
-|[SlideBackgroundPictureOrTextureFill](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefill)|[setImage(base64EncodedImage: string)](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefill#powerpoint-powerpoint-slidebackgroundpictureortexturefill-setimage-member(1))|Sets the image used to fill.|
-||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefill#powerpoint-powerpoint-slidebackgroundpictureortexturefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
-|[SlideBackgroundPictureOrTextureFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions)|[imageBase64](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions#powerpoint-powerpoint-slidebackgroundpictureortexturefilloptions-imagebase64-member)|If provided, specifies the Base64-encoded image data for the fill.|
-||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundpictureortexturefilloptions#powerpoint-powerpoint-slidebackgroundpictureortexturefilloptions-transparency-member)|If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
-|[SlideBackgroundSolidFill](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfill)|[color](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfill#powerpoint-powerpoint-slidebackgroundsolidfill-color-member)|Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").|
-||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfill#powerpoint-powerpoint-slidebackgroundsolidfill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
-|[SlideBackgroundSolidFillOptions](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfilloptions)|[color](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfilloptions#powerpoint-powerpoint-slidebackgroundsolidfilloptions-color-member)|If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").|
-||[transparency](/javascript/api/powerpoint/powerpoint.slidebackgroundsolidfilloptions#powerpoint-powerpoint-slidebackgroundsolidfilloptions-transparency-member)|If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).|
-|[SlideCollection](/javascript/api/powerpoint/powerpoint.slidecollection)|[exportAsBase64Presentation(values: Array)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-exportasbase64presentation-member(1))|Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.|
-|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[background](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-background-member)|Gets the background of the slide layout.|
-||[themeColorScheme](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide layout.|
-|[SlideLayoutBackground](/javascript/api/powerpoint/powerpoint.slidelayoutbackground)|[areBackgroundGraphicsHidden](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.|
-||[fill](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-fill-member)|Returns the fill formatting of the background.|
-||[isMasterBackgroundFollowed](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-ismasterbackgroundfollowed-member)|Specifies if the slide layout background follows the slide master background.|
-||[reset()](/javascript/api/powerpoint/powerpoint.slidelayoutbackground#powerpoint-powerpoint-slidelayoutbackground-reset-member(1))|Resets the fill formatting of the slide layout background.|
-|[SlideMaster](/javascript/api/powerpoint/powerpoint.slidemaster)|[background](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-background-member)|Gets the background of the Slide Master.|
-||[themeColorScheme](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-themecolorscheme-member)|Returns the `ThemeColorScheme` of the Slide Master.|
-|[SlideMasterBackground](/javascript/api/powerpoint/powerpoint.slidemasterbackground)|[fill](/javascript/api/powerpoint/powerpoint.slidemasterbackground#powerpoint-powerpoint-slidemasterbackground-fill-member)|Returns the fill formatting of the background.|
-|[SlideScopedCollection](/javascript/api/powerpoint/powerpoint.slidescopedcollection)|[exportAsBase64Presentation()](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-exportasbase64presentation-member(1))|Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.|
-|[TextRange](/javascript/api/powerpoint/powerpoint.textrange)|[hyperlinks](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-hyperlinks-member)|Returns a collection of hyperlinks that exist on this `TextRange`.|
-||[setHyperlink(options?: PowerPoint.HyperlinkAddOptions)](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-sethyperlink-member(1))|Sets a hyperlink on this `TextRange` with the specified options.|
-|[ThemeColorScheme](/javascript/api/powerpoint/powerpoint.themecolorscheme)|[getThemeColor(color: PowerPoint.ThemeColor)](/javascript/api/powerpoint/powerpoint.themecolorscheme#powerpoint-powerpoint-themecolorscheme-getthemecolor-member(1))|Gets the color value for the specified `ThemeColor`.|
-||[setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string)](/javascript/api/powerpoint/powerpoint.themecolorscheme#powerpoint-powerpoint-themecolorscheme-setthemecolor-member(1))|Sets the color value for the specified `ThemeColor`.|
diff --git a/docs/requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md b/docs/requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
new file mode 100644
index 0000000000..8925b1791a
--- /dev/null
+++ b/docs/requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
@@ -0,0 +1,23 @@
+---
+title: PowerPoint JavaScript API requirement set 1.10
+description: Details about the PowerPointApi 1.10 requirement set.
+ms.date: 12/16/2025
+ms.topic: whats-new
+ms.localizationpriority: medium
+---
+
+# What's new in PowerPoint JavaScript API 1.10
+
+PowerPointApi 1.10 added APIs to better manage accessibility, slide background, and hyperlinks in the presentation.
+
+## API list
+
+The following table lists the PowerPoint JavaScript API requirement set 1.10. 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_10.md)]
+
+## See also
+
+- [PowerPoint JavaScript API Reference Documentation](/javascript/api/powerpoint?view=powerpoint-js-1.10&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 28c281026d..567f23d291 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: 10/17/2025
+ms.date: 12/16/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/[LTSC](/office/dev/add-ins/resources/resources-glossary#long-term-service-channel-ltsc)
| 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.10](powerpoint-api-1-10-requirement-set.md) | Supported | Version 2601 (Build 19610.20002) | Not available | Version 16.105 (25121030) | Not available |
| [PowerPointApi 1.9](powerpoint-api-1-9-requirement-set.md) | Supported | Version 2508 (Build 19127.20154) | Not available | Version 16.100 (25082415) | Not available |
| [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 |
@@ -67,6 +68,10 @@ PowerPoint JavaScript API 1.8 includes APIs to manage bindings, shapes, and tabl
PowerPoint JavaScript API 1.9 includes APIs to format and manage tables within presentations. For more information, see [PowerPoint JavaScript API requirement set 1.9](powerpoint-api-1-9-requirement-set.md).
+## PowerPoint JavaScript API 1.10
+
+PowerPoint JavaScript API 1.10 includes APIs to better manage accessibility, slide background, and hyperlinks within presentations. For more information, see [PowerPoint JavaScript API requirement set 1.10](powerpoint-api-1-10-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 4e11daa787..2c6a00b08b 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: 11/11/2025
+ms.date: 12/16/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 45a18d6399..0d872c90e7 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: 11/18/2025
+ms.date: 12/16/2025
ms.topic: overview
ms.localizationpriority: high
---
@@ -94,12 +94,12 @@ 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)
- [PowerPointApi 1.8](powerpoint/powerpoint-api-1-8-requirement-set.md)
- [PowerPointApi 1.9](powerpoint/powerpoint-api-1-9-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)
- [PowerPointApi 1.9](powerpoint/powerpoint-api-1-9-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)
- [TaskPaneApi 1.1](common/task-pane-api-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)
- [PowerPointApi 1.9](powerpoint/powerpoint-api-1-9-requirement-set.md)
- [PowerPointApi 1.10](powerpoint/powerpoint-api-1-10-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)
- [PowerPointApi 1.9](powerpoint/powerpoint-api-1-9-requirement-set.md)
- [PowerPointApi 1.10](powerpoint/powerpoint-api-1-10-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)
- [TaskPaneApi 1.1](common/task-pane-api-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
|Office on Windows
(retail perpetual Office 2021 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)
- [PowerPointApi 1.9](powerpoint/powerpoint-api-1-9-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)
- [TaskPaneApi 1.1](common/task-pane-api-requirement-sets.md)
- [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
|
|Office 2024 on Windows
(volume-licensed perpetual/LTSC)|- 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/LTSC)|- 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 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)
- [PowerPointApi 1.9](powerpoint/powerpoint-api-1-9-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)
- [TaskPaneApi 1.1](common/task-pane-api-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)
- [PowerPointApi 1.9](powerpoint/powerpoint-api-1-9-requirement-set.md)
- [PowerPointApi 1.10](powerpoint/powerpoint-api-1-10-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)
- [TaskPaneApi 1.1](common/task-pane-api-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 6403db8c15..852950d49f 100644
--- a/docs/toc.yml
+++ b/docs/toc.yml
@@ -531,6 +531,9 @@ items:
- name: PowerPoint preview APIs
href: requirement-sets/powerpoint/powerpoint-preview-apis.md
displayName: PowerPoint
+ - name: PowerPointApi 1.10 requirement set
+ href: requirement-sets/powerpoint/powerpoint-api-1-10-requirement-set.md
+ displayName: PowerPoint
- name: PowerPointApi 1.9 requirement set
href: requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md
displayName: PowerPoint
diff --git a/generate-docs/GenerateDocs.sh b/generate-docs/GenerateDocs.sh
index 3d337efaf8..f4d2625b69 100644
--- a/generate-docs/GenerateDocs.sh
+++ b/generate-docs/GenerateDocs.sh
@@ -85,6 +85,7 @@ npx version-remover api-extractor-inputs-outlook-release/outlook_1_3/outlook.d.t
npx version-remover api-extractor-inputs-outlook-release/outlook_1_2/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_1/outlook.d.ts "Api set: Mailbox 1.2" configs/outlook-1.2-config.json
npx version-remover api-extractor-inputs-outlook-release/outlook_1_1/outlook.d.ts ./tool-inputs/outlook-base.d.ts "Api set: Mailbox 1.1"
+npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_10/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_9/powerpoint.d.ts "Api set: PowerPointApi 1.10" configs/powerpoint-1_10-config.json
npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_9/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_8/powerpoint.d.ts "Api set: PowerPointApi 1.9" configs/powerpoint-1_9-config.json
npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_8/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_7/powerpoint.d.ts "Api set: PowerPointApi 1.8" configs/powerpoint-1_8-config.json
npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_7/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts "Api set: PowerPointApi 1.7" configs/powerpoint-1_7-config.json
@@ -172,7 +173,8 @@ npx whats-new api-extractor-inputs-outlook-release/outlook_1_3/outlook.d.ts api-
npx whats-new 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 javascript/api/outlook/ configs/outlook-1.2-config.json
npx whats-new api-extractor-inputs-outlook-release/outlook_1_1/outlook.d.ts ./tool-inputs/outlook-base.d.ts ../docs/includes/outlook-1_1 javascript/api/outlook/ configs/outlook-1.1-config.json
-npx whats-new api-extractor-inputs-powerpoint/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_9/powerpoint.d.ts ../docs/includes/powerpoint-preview javascript/api/powerpoint/ configs/powerpoint-preview-config.json
+npx whats-new api-extractor-inputs-powerpoint/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_10/powerpoint.d.ts ../docs/includes/powerpoint-preview javascript/api/powerpoint/ configs/powerpoint-preview-config.json
+npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_10/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_9/powerpoint.d.ts ../docs/includes/powerpoint-1_10 javascript/api/powerpoint/ configs/powerpoint-1_10-config.json
npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_9/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_8/powerpoint.d.ts ../docs/includes/powerpoint-1_9 javascript/api/powerpoint/ configs/powerpoint-1_9-config.json
npx whats-new 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 javascript/api/powerpoint/ configs/powerpoint-1_8-config.json
npx whats-new 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 javascript/api/powerpoint/ configs/powerpoint-1_7-config.json
@@ -465,6 +467,12 @@ if [ ! -d "json/powerpoint" ]; then
../node_modules/.bin/api-extractor run
popd
fi
+if [ ! -d "json/powerpoint_1_10" ]; then
+ echo Running API Extractor for PowerPoint 1.10.
+ pushd api-extractor-inputs-powerpoint-release/PowerPoint_1_10
+ ../../node_modules/.bin/api-extractor run
+ popd
+fi
if [ ! -d "json/powerpoint_1_9" ]; then
echo Running API Extractor for PowerPoint 1.9.
pushd api-extractor-inputs-powerpoint-release/PowerPoint_1_9
@@ -812,6 +820,9 @@ fi
if [ ! -d "yaml/powerpoint_1_9" ]; then
./node_modules/.bin/api-documenter yaml --input-folder ./json/powerpoint_1_9 --output-folder ./yaml/powerpoint_1_9 --office 2>/dev/null
fi
+if [ ! -d "yaml/powerpoint_1_10" ]; then
+ ./node_modules/.bin/api-documenter yaml --input-folder ./json/powerpoint_1_10 --output-folder ./yaml/powerpoint_1_10 --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 3545a59a37..ca380aa6e0 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -44,6 +44,7 @@ export declare namespace PowerPoint {
+
/**
* Returns the title of the presentation.
*
@@ -79,9 +80,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -138,6 +139,32 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -184,13 +211,20 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
export interface BulletFormatUpdateData {
+
+
}
/** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */
export interface ParagraphFormatUpdateData {
+
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
@@ -292,6 +326,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -325,6 +388,11 @@ export declare namespace PowerPoint {
+
+
+
+
+
}
/** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
export interface BindingCollectionUpdateData {
@@ -349,6 +417,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -372,6 +445,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -386,13 +463,20 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
export interface BulletFormatData {
+
+
}
/** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
export interface ParagraphFormatData {
+
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
@@ -430,6 +514,7 @@ export declare namespace PowerPoint {
export interface HyperlinkData {
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -517,6 +602,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -528,6 +646,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
@@ -554,6 +675,7 @@ export declare namespace PowerPoint {
/** 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 {
@@ -575,6 +697,12 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
}
/** An interface describing the data returned by calling `binding.toJSON()`. */
export interface BindingData {
@@ -608,6 +736,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -636,6 +769,7 @@ export declare namespace PowerPoint {
$all?: boolean;
+
/**
* Returns the title of the presentation.
*
@@ -674,6 +808,17 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+
+
+
+
+
diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/api-extractor.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/api-extractor.json
new file mode 100644
index 0000000000..7b1734299e
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/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_10/.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_10/package.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/package.json
new file mode 100644
index 0000000000..f8296622ff
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/package.json
@@ -0,0 +1,4 @@
+{
+ "name": "powerpoint",
+ "version": "1.10.0"
+}
\ No newline at end of file
diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/powerpoint.d.ts
new file mode 100644
index 0000000000..1589951ea4
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/powerpoint.d.ts
@@ -0,0 +1,13727 @@
+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 {
+ /**
+ * Represents the PowerPoint application that manages the presentation.
+ *
+ * @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;
+ };
+ }
+ /**
+ * The `Presentation` object is the top-level object with one or more slides that contain the contents of the presentation.
+ To learn more about the PowerPoint object model,
+ see {@link https://learn.microsoft.com/office/dev/add-ins/powerpoint/core-concepts | PowerPoint JavaScript object model}.
+ *
+ * @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;
+ /**
+ * Returns the page setup information whose properties control slide setup attributes for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly pageSetup: PowerPoint.PageSetup;
+ /**
+ * 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;
+ /**
+ * Returns the title of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.0]
+ */
+ 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.
+ 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]
+ */
+ 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 adjustment values for a shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class Adjustments 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 number of adjustment points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly count: number;
+ /**
+ * Gets the adjustment value at the specified zero-based index.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index - The index of the adjustment to retrieve.
+ * @returns The adjustment value at the given index.
+ */
+ get(index: number): OfficeExtension.ClientResult;
+ /**
+ * Sets the adjustment value at the specified zero-based index.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index - The index of the adjustment to set.
+ * @param value - The adjustment value to set.
+ */
+ set(index: number, value: number): 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.AdjustmentsLoadOptions): PowerPoint.Adjustments;
+ /**
+ * 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.Adjustments;
+ /**
+ * 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.Adjustments;
+ /**
+ * 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.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.AdjustmentsData;
+ }
+ /**
+ * 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` by its zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index - The index of the custom XML part in the collection.
+ * @returns The custom XML part at the given index.
+ */
+ getItemAt(index: number): 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` by its zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index - The index of the custom XML part in the collection.
+ * @returns The custom XML part at the given index.
+ */
+ getItemAt(index: number): 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;
+ }
+ /**
+ * Represents the available options when adding a {@link PowerPoint.Hyperlink}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface HyperlinkAddOptions {
+ /**
+ * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ address?: string;
+ /**
+ * Specifies the string displayed when hovering over the hyperlink.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ screenTip?: string;
+ }
+ /**
+ * Represents a scoped collection of hyperlinks.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class HyperlinkScopedCollection 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.10]
+ * @returns The number of hyperlinks in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets a hyperlink using its zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index - The index of the hyperlink in the collection.
+ * @returns The hyperlink at the given index.
+ */
+ 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.HyperlinkScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkScopedCollection;
+ /**
+ * 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.HyperlinkScopedCollection;
+ /**
+ * 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.HyperlinkScopedCollection;
+ /**
+ * 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.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData;
+ }
+ /**
+ * 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's justified across the whole line.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ justify = "Justify",
+ /**
+ * Specifies the alignment or adjustment of kashida length in Arabic text.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ justifyLow = "JustifyLow",
+ /**
+ * Distributes the text words across an entire text line.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ distributed = "Distributed",
+ /**
+ * Distributes Thai text specially, because each character is treated as a word.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ thaiDistributed = "ThaiDistributed",
+ }
+ /**
+ * Specifies the style of a bullet.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum BulletStyle {
+ /**
+ * Style is unsupported.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ unsupported = "Unsupported",
+ /**
+ * Lowercase alphabetical characters with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ alphabetLowercasePeriod = "AlphabetLowercasePeriod",
+ /**
+ * Uppercase alphabetical characters with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ alphabetUppercasePeriod = "AlphabetUppercasePeriod",
+ /**
+ * Arabic numerals with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight",
+ /**
+ * Arabic numerals with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicNumeralPeriod = "ArabicNumeralPeriod",
+ /**
+ * Lowercase Roman numerals with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth",
+ /**
+ * Lowercase Roman numerals with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight",
+ /**
+ * Lowercase Roman numerals with period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ romanLowercasePeriod = "RomanLowercasePeriod",
+ /**
+ * Uppercase Roman numerals with period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ romanUppercasePeriod = "RomanUppercasePeriod",
+ /**
+ * Lowercase alphabetical characters with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth",
+ /**
+ * Lowercase alphabetical characters with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight",
+ /**
+ * Uppercase alphabetical characters with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth",
+ /**
+ * Uppercase alphabetical characters with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight",
+ /**
+ * Arabic numerals with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth",
+ /**
+ * Arabic numerals.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicNumeralPlain = "ArabicNumeralPlain",
+ /**
+ * Uppercase Roman numerals with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth",
+ /**
+ * Uppercase Roman numerals with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight",
+ /**
+ * Simplified Chinese without a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ simplifiedChinesePlain = "SimplifiedChinesePlain",
+ /**
+ * Simplified Chinese with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ simplifiedChinesePeriod = "SimplifiedChinesePeriod",
+ /**
+ * Double-byte circled number for values up to 10.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain",
+ /**
+ * Text colored number with same color circle drawn around it.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain",
+ /**
+ * Shadow color number with circular background of normal text color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain",
+ /**
+ * Traditional Chinese without a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ traditionalChinesePlain = "TraditionalChinesePlain",
+ /**
+ * Traditional Chinese with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ traditionalChinesePeriod = "TraditionalChinesePeriod",
+ /**
+ * Arabic alphabet with a dash.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicAlphabetDash = "ArabicAlphabetDash",
+ /**
+ * Arabic Abjad alphabet with a dash.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicAbjadDash = "ArabicAbjadDash",
+ /**
+ * Hebrew alphabet with a dash.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ hebrewAlphabetDash = "HebrewAlphabetDash",
+ /**
+ * Japanese/Korean numbers without a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ kanjiKoreanPlain = "KanjiKoreanPlain",
+ /**
+ * Japanese/Korean numbers with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ kanjiKoreanPeriod = "KanjiKoreanPeriod",
+ /**
+ * Double-byte Arabic numbering scheme (no punctuation).
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicDoubleBytePlain = "ArabicDoubleBytePlain",
+ /**
+ * Double-byte Arabic numbering scheme with double-byte period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ arabicDoubleBytePeriod = "ArabicDoubleBytePeriod",
+ /**
+ * Thai alphabet with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ thaiAlphabetPeriod = "ThaiAlphabetPeriod",
+ /**
+ * Thai alphabet with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight",
+ /**
+ * Thai alphabet with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth",
+ /**
+ * Thai numerals with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ thaiNumeralPeriod = "ThaiNumeralPeriod",
+ /**
+ * Thai numerals with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight",
+ /**
+ * Thai numerals with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth",
+ /**
+ * Hindi alphabet (vowels) with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ hindiAlphabetPeriod = "HindiAlphabetPeriod",
+ /**
+ * Hindi numerals with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ hindiNumeralPeriod = "HindiNumeralPeriod",
+ /**
+ * Kanji Simplified Chinese with double-byte period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod",
+ /**
+ * Hindi numerals with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight",
+ /**
+ * Hindi alphabet (consonants) with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ hindiAlphabet1Period = "HindiAlphabet1Period",
+ }
+ /**
+ * Specifies the type of a bullet.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum BulletType {
+ /**
+ * Type is unsupported.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ unsupported = "Unsupported",
+ /**
+ * No bullets.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ none = "None",
+ /**
+ * Numbered bullet (e.g., 1, 2, 3 or a, b, c).
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ numbered = "Numbered",
+ /**
+ * Symbol-based bullet (e.g., disc, circle, square).
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ unnumbered = "Unnumbered",
+ }
+ /**
+ * 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 the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ /**
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
+ /**
+ * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ visible: boolean | 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.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" | null;
+ /**
+ * Represents the indent level of the paragraph.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ indentLevel: 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.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;
+ }
+ /**
+ * 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;
+ }
+ /**
+ * 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 vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
+ If one of the centered options is selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
+ To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ enum TextVerticalAlignment {
+ /**
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ top = "Top",
+ /**
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ middle = "Middle",
+ /**
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bottom = "Bottom",
+ /**
+ * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ topCentered = "TopCentered",
+ /**
+ * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ middleCentered = "MiddleCentered",
+ /**
+ * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bottomCentered = "BottomCentered",
+ }
+ /**
+ * Represents the 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;
+ }
+ /**
+ * 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;
+ /**
+ * Returns a collection of hyperlinks that exist on this `TextRange`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;
+ /**
+ * 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;
+ /**
+ * Sets a hyperlink on this `TextRange` with the specified options. This will delete all existing hyperlinks on this `TextRange`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options - Optional. The options for the hyperlink.
+ * @returns The newly created {@link PowerPoint.Hyperlink} object.
+ */
+ setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
+ /**
+ * 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;
+ }
+ /**
+ * Specifies the type of object that a hyperlink is applied to.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum HyperlinkType {
+ /**
+ * Specifies that the hyperlink is applied to a TextRange.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ textRange = "TextRange",
+ /**
+ * Specifies that the hyperlink is applied to a Shape.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ shape = "Shape",
+ }
+ /**
+ * 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 address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @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;
+ /**
+ * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";
+ /**
+ * Deletes the hyperlink.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ delete(): void;
+ /**
+ * Returns the {@link PowerPoint.Shape} object that the hyperlink is applied to.
+ If the hyperlink is not of type `shape`, or it is within a domain that does not currently support a {@link PowerPoint.Shape}, 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.10]
+ */
+ getLinkedShapeOrNullObject(): PowerPoint.Shape;
+ /**
+ * Returns the {@link PowerPoint.TextRange} object that the hyperlink is applied to.
+ If the hyperlink is not of type `textRange`, or it is within a domain that does not currently support a {@link PowerPoint.TextRange}, 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.10]
+ */
+ getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;
+ /**
+ * 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;
+ }
+ /**
+ * 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 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[];
+ /**
+ * Adds a hyperlink to the specified target with the given options. If the target already contains any hyperlinks, they will be deleted.
+ The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param target - The target to add the hyperlink to. Can be a {@link PowerPoint.TextRange} or a {@link PowerPoint.Shape}.
+ * @param options - Optional. The options for the hyperlink.
+ * @returns The newly created {@link PowerPoint.Hyperlink} object.
+ */
+ add(target: TextRange | Shape, options?: PowerPoint.HyperlinkAddOptions): 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.
+ Throws an `InvalidArgument` exception 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.
+ */
+ 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 properties for a table cell border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class Border 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 the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ color: string | undefined;
+ /**
+ * Represents the dash style of the line.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ 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.9]
+ */
+ transparency: number | undefined;
+ /**
+ * Represents the weight of the line, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ weight: number | undefined;
+ /**
+ * 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.BorderLoadOptions): PowerPoint.Border;
+ /**
+ * 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.Border;
+ /**
+ * 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.Border;
+ /**
+ * 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.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.BorderData;
+ }
+ /**
+ * Represents the borders for a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class Borders 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 bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly bottom: PowerPoint.Border;
+ /**
+ * Gets the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly diagonalDown: PowerPoint.Border;
+ /**
+ * Gets the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly diagonalUp: PowerPoint.Border;
+ /**
+ * Gets the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly left: PowerPoint.Border;
+ /**
+ * Gets the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly right: PowerPoint.Border;
+ /**
+ * Gets the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly top: PowerPoint.Border;
+ /**
+ * 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.BordersLoadOptions): PowerPoint.Borders;
+ /**
+ * 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.Borders;
+ /**
+ * 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.Borders;
+ /**
+ * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.BordersData;
+ }
+ /**
+ * Represents the margins of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class Margins 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 bottom margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ bottom: number | undefined;
+ /**
+ * Specifies the left margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ left: number | undefined;
+ /**
+ * Specifies the right margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ right: number | undefined;
+ /**
+ * Specifies the top margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ top: number | undefined;
+ /**
+ * 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.MarginsLoadOptions): PowerPoint.Margins;
+ /**
+ * 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.Margins;
+ /**
+ * 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.Margins;
+ /**
+ * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.MarginsData;
+ }
+ /**
+ * 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 doesn't 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;
+ }
+ /**
+ * 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 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 collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly borders: PowerPoint.Borders;
+ /**
+ * Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly fill: PowerPoint.ShapeFill;
+ /**
+ * Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly font: PowerPoint.ShapeFont;
+ /**
+ * Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly margins: PowerPoint.Margins;
+ /**
+ * 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;
+ /**
+ * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+ /**
+ * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ indentLevel: number | null;
+ /**
+ * 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;
+ /**
+ * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ textRuns: PowerPoint.TextRun[];
+ /**
+ * Specifies the vertical alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ /**
+ * Resizes the table cell to span across a specified number of rows and columns.
+ If rowCount or columnCount are greater than 1, the cell will become a merged area. If the cell
+ is already a merged area and rowCount and columnCount are set to 1, the cell will no longer be
+ a merged area.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param rowCount - The number of rows the cell will span across. Must be greater than 0.
+ * @param columnCount - The number of columns the cell will span across. Must be greater than 0.
+ */
+ resize(rowCount: number, columnCount: number): void;
+ /**
+ * Splits the cell into the specified number of rows and columns.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param rowCount - The number of rows to split into. Must be greater than 0.
+ * @param columnCount - The number of columns to split into. Must be greater than 0.
+ */
+ split(rowCount: number, columnCount: number): 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.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` 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 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 a column in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class TableColumn 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 index number of the column within the column collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly columnIndex: number;
+ /**
+ * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ width: number;
+ /**
+ * Deletes the column.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ 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.TableColumnLoadOptions): PowerPoint.TableColumn;
+ /**
+ * 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.TableColumn;
+ /**
+ * 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.TableColumn;
+ /**
+ * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableColumnData;
+ }
+ /**
+ * Represents a collection of table columns.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class TableColumnCollection 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.TableColumn[];
+ /**
+ * Adds one or more columns to the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param index - Optional. Specifies the zero-based index where the new columns are added. Existing columns starting at the index location are shifted right. If the index value is undefined, null, -1, or greater than the number of columns in the table, the new columns are added at the end of the table.
+ * @param count - Optional. The number of columns to add. If the value is undefined or 0, only one column is added.
+ */
+ // eslint-disable-next-line @definitelytyped/redundant-undefined
+ add(index?: number | null | undefined, count?: number | undefined): void;
+ /**
+ * Deletes the specified columns from the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param columns - An array of `TableColumn` objects representing the columns to be deleted.
+ */
+ deleteColumns(columns: PowerPoint.TableColumn[]): void;
+ /**
+ * Gets the number of columns in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ * @returns The number of columns in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets the column using its zero-based index in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param index - Index value of the column to be retrieved, as a zero-based index.
+ * @returns The column object.
+ */
+ getItemAt(index: number): PowerPoint.TableColumn;
+ /**
+ * 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.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableColumnCollection;
+ /**
+ * 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.TableColumnCollection;
+ /**
+ * 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.TableColumnCollection;
+ /**
+ * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
+ }
+ /**
+ * Represents the available options when clearing a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface TableClearOptions {
+ /**
+ * Specifies if both values and formatting of the table should be cleared.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ all?: boolean;
+ /**
+ * Specifies if the formatting of the table should be cleared.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ format?: boolean;
+ /**
+ * Specifies if the values of the table should be cleared.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ text?: boolean;
+ }
+ /**
+ * Represents a row in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class TableRow 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;
+ /**
+ * Retrieves the current height of the row in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly currentHeight: number;
+ /**
+ * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ height: number;
+ /**
+ * Returns the index number of the row within the rows collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly rowIndex: number;
+ /**
+ * Deletes the row.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ 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.TableRowLoadOptions): PowerPoint.TableRow;
+ /**
+ * 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.TableRow;
+ /**
+ * 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.TableRow;
+ /**
+ * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableRowData;
+ }
+ /**
+ * Represents a collection of table rows.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class TableRowCollection 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.TableRow[];
+ /**
+ * Adds one or more rows to the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param index - Optional. Specifies the zero-based index where the new rows are added. Existing rows starting at the index location are shifted down. If the index value is undefined, null, -1, or greater than the number of rows in the table, the new rows are added at the end of the table.
+ * @param count - Optional. The number of rows to add. If the value is undefined or 0, only one row is added.
+ */
+ // eslint-disable-next-line @definitelytyped/redundant-undefined
+ add(index?: number | null | undefined, count?: number | undefined): void;
+ /**
+ * Deletes the specified rows from the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param rows - An array of `TableRow` objects representing the rows to be deleted.
+ */
+ deleteRows(rows: PowerPoint.TableRow[]): void;
+ /**
+ * Gets the number of rows in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ * @returns The number of rows in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets the row using its zero-based index in the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param index - Index value of the row to be retrieved, as a zero-based index.
+ * @returns The row object.
+ */
+ getItemAt(index: number): PowerPoint.TableRow;
+ /**
+ * 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.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableRowCollection;
+ /**
+ * 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.TableRowCollection;
+ /**
+ * 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.TableRowCollection;
+ /**
+ * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
+ }
+ /**
+ * Represents the available built-in table styles.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ enum TableStyle {
+ /**
+ * Specifies the style "No style, No grid" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ noStyleNoGrid = "NoStyleNoGrid",
+ /**
+ * Specifies the style "Themed style 1 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent1 = "ThemedStyle1Accent1",
+ /**
+ * Specifies the style "Themed style 1 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent2 = "ThemedStyle1Accent2",
+ /**
+ * Specifies the style "Themed style 1 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent3 = "ThemedStyle1Accent3",
+ /**
+ * Specifies the style "Themed style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent4 = "ThemedStyle1Accent4",
+ /**
+ * Specifies the style "Themed style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent5 = "ThemedStyle1Accent5",
+ /**
+ * Specifies the style "Themed style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent6 = "ThemedStyle1Accent6",
+ /**
+ * Specifies the style "No style, Table grid" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ noStyleTableGrid = "NoStyleTableGrid",
+ /**
+ * Specifies the style "Themed style 2 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent1 = "ThemedStyle2Accent1",
+ /**
+ * Specifies the style "Themed style 2 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent2 = "ThemedStyle2Accent2",
+ /**
+ * Specifies the style "Themed style 2 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent3 = "ThemedStyle2Accent3",
+ /**
+ * Specifies the style "Themed style 2 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent4 = "ThemedStyle2Accent4",
+ /**
+ * Specifies the style "Themed style 2 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent5 = "ThemedStyle2Accent5",
+ /**
+ * Specifies the style "Themed style 2 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent6 = "ThemedStyle2Accent6",
+ /**
+ * Specifies the style "Light Style 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1 = "LightStyle1",
+ /**
+ * Specifies the style "Light style 1 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent1 = "LightStyle1Accent1",
+ /**
+ * Specifies the style "Light style 1 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent2 = "LightStyle1Accent2",
+ /**
+ * Specifies the style "Light style 1 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent3 = "LightStyle1Accent3",
+ /**
+ * Specifies the style "Light style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent4 = "LightStyle1Accent4",
+ /**
+ * Specifies the style "Light style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent5 = "LightStyle1Accent5",
+ /**
+ * Specifies the style "Light style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent6 = "LightStyle1Accent6",
+ /**
+ * Specifies the style "Light Style 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2 = "LightStyle2",
+ /**
+ * Specifies the style "Light style 2 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent1 = "LightStyle2Accent1",
+ /**
+ * Specifies the style "Light style 2 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent2 = "LightStyle2Accent2",
+ /**
+ * Specifies the style "Light style 2 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent3 = "LightStyle2Accent3",
+ /**
+ * Specifies the style "Light style 2 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent4 = "LightStyle2Accent4",
+ /**
+ * Specifies the style "Light style 2 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent5 = "LightStyle2Accent5",
+ /**
+ * Specifies the style "Light style 2 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent6 = "LightStyle2Accent6",
+ /**
+ * Specifies the style "Light Style 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3 = "LightStyle3",
+ /**
+ * Specifies the style "Light style 3 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent1 = "LightStyle3Accent1",
+ /**
+ * Specifies the style "Light style 3 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent2 = "LightStyle3Accent2",
+ /**
+ * Specifies the style "Light style 3 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent3 = "LightStyle3Accent3",
+ /**
+ * Specifies the style "Light style 3 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent4 = "LightStyle3Accent4",
+ /**
+ * Specifies the style "Light style 3 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent5 = "LightStyle3Accent5",
+ /**
+ * Specifies the style "Light style 3 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent6 = "LightStyle3Accent6",
+ /**
+ * Specifies the style "Medium Style 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1 = "MediumStyle1",
+ /**
+ * Specifies the style "Medium style 1 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent1 = "MediumStyle1Accent1",
+ /**
+ * Specifies the style "Medium style 1 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent2 = "MediumStyle1Accent2",
+ /**
+ * Specifies the style "Medium style 1 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent3 = "MediumStyle1Accent3",
+ /**
+ * Specifies the style "Medium style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent4 = "MediumStyle1Accent4",
+ /**
+ * Specifies the style "Medium style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent5 = "MediumStyle1Accent5",
+ /**
+ * Specifies the style "Medium style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent6 = "MediumStyle1Accent6",
+ /**
+ * Specifies the style "Medium Style 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2 = "MediumStyle2",
+ /**
+ * Specifies the style "Medium style 2 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent1 = "MediumStyle2Accent1",
+ /**
+ * Specifies the style "Medium style 2 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent2 = "MediumStyle2Accent2",
+ /**
+ * Specifies the style "Medium style 2 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent3 = "MediumStyle2Accent3",
+ /**
+ * Specifies the style "Medium style 2 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent4 = "MediumStyle2Accent4",
+ /**
+ * Specifies the style "Medium style 2 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent5 = "MediumStyle2Accent5",
+ /**
+ * Specifies the style "Medium style 2 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent6 = "MediumStyle2Accent6",
+ /**
+ * Specifies the style "Medium Style 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3 = "MediumStyle3",
+ /**
+ * Specifies the style "Medium style 3 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent1 = "MediumStyle3Accent1",
+ /**
+ * Specifies the style "Medium style 3 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent2 = "MediumStyle3Accent2",
+ /**
+ * Specifies the style "Medium style 3 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent3 = "MediumStyle3Accent3",
+ /**
+ * Specifies the style "Medium style 3 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent4 = "MediumStyle3Accent4",
+ /**
+ * Specifies the style "Medium style 3 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent5 = "MediumStyle3Accent5",
+ /**
+ * Specifies the style "Medium style 3 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent6 = "MediumStyle3Accent6",
+ /**
+ * Specifies the style "Medium Style 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4 = "MediumStyle4",
+ /**
+ * Specifies the style "Medium style 4 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent1 = "MediumStyle4Accent1",
+ /**
+ * Specifies the style "Medium style 4 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent2 = "MediumStyle4Accent2",
+ /**
+ * Specifies the style "Medium style 4 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent3 = "MediumStyle4Accent3",
+ /**
+ * Specifies the style "Medium style 4 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent4 = "MediumStyle4Accent4",
+ /**
+ * Specifies the style "Medium style 4 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent5 = "MediumStyle4Accent5",
+ /**
+ * Specifies the style "Medium style 4 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent6 = "MediumStyle4Accent6",
+ /**
+ * Specifies the style "Dark Style 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1 = "DarkStyle1",
+ /**
+ * Specifies the style "Dark style 1 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent1 = "DarkStyle1Accent1",
+ /**
+ * Specifies the style "Dark style 1 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent2 = "DarkStyle1Accent2",
+ /**
+ * Specifies the style "Dark style 1 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent3 = "DarkStyle1Accent3",
+ /**
+ * Specifies the style "Dark style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent4 = "DarkStyle1Accent4",
+ /**
+ * Specifies the style "Dark style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent5 = "DarkStyle1Accent5",
+ /**
+ * Specifies the style "Dark style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent6 = "DarkStyle1Accent6",
+ /**
+ * Specifies the style "Dark Style 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2 = "DarkStyle2",
+ /**
+ * Specifies the style "Dark style 2 - Accent 1/Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2Accent1 = "DarkStyle2Accent1",
+ /**
+ * Specifies the style "Dark style 2 - Accent 3/Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2Accent2 = "DarkStyle2Accent2",
+ /**
+ * Specifies the style "Dark style 2 - Accent 5/Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2Accent3 = "DarkStyle2Accent3",
+ }
+ /**
+ * Represents the available table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export class TableStyleSettings 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 columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areColumnsBanded: boolean;
+ /**
+ * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areRowsBanded: boolean;
+ /**
+ * Specifies if the first column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstColumnHighlighted: boolean;
+ /**
+ * Specifies if the first row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstRowHighlighted: boolean;
+ /**
+ * Specifies if the last column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastColumnHighlighted: boolean;
+ /**
+ * Specifies if the last row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastRowHighlighted: boolean;
+ /**
+ * Specifies the table style.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ style: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ /**
+ * 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.TableStyleSettingsLoadOptions): PowerPoint.TableStyleSettings;
+ /**
+ * 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.TableStyleSettings;
+ /**
+ * 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.TableStyleSettings;
+ /**
+ * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;
+ }
+ /**
+ * 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 collection of columns in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly columns: PowerPoint.TableColumnCollection;
+ /**
+ * Gets the collection of rows in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly rows: PowerPoint.TableRowCollection;
+ /**
+ * Gets the table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly styleSettings: PowerPoint.TableStyleSettings;
+ /**
+ * 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[][];
+ /**
+ * Clears table values and formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param options - Provides options for clearing the table.
+ */
+ clear(options?: PowerPoint.TableClearOptions): void;
+ /**
+ * 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. 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}.
+ */
+ 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;
+ /**
+ * Creates a merged area starting at the cell specified by rowIndex and columnIndex. The merged area spans across a specified number of rows and columns.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param rowIndex - The zero-based row index of the cell to start the merged area.
+ * @param columnIndex - The zero-based column index of the cell to start the merged area.
+ * @param rowCount - The number of rows to merge with the starting cell. Must be greater than 0.
+ * @param columnCount - The number of columns to merge with the starting cell. Must be greater than 0.
+ */
+ mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): 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.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;
+ }
+ /**
+ * 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;
+ /**
+ * Specifies the horizontal alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
+ /**
+ * Specifies 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 PowerPoint.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[];
+ /**
+ * Specifies the vertical alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
+ }
+ /**
+ * 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 doesn't 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 doesn't 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 isn't provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+
+ Note: If the table height isn't evenly divisible by the number of rows, PowerPoint sets it to the nearest possible value.
+ For example, a height of 400 for 3 rows may result in an actual height of 399.9999.
+ *
+ * @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 isn't 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 a 2D array with the same number of rows and columns as the table.
+ If a cell doesn't 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 value that represents the table style.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ /**
+ * 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 isn't 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 don't 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 isn't provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+
+ Note: If the table width isn't evenly divisible by the number of columns, PowerPoint sets it to the nearest possible value.
+ For example, a width of 400 for 3 columns may result in an actual width of 399.9999.
+ *
+ * @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 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: "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 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?: "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 doesn't 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 doesn't 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 doesn't 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 shape.
+ * @returns The shape with the unique ID. If such a shape doesn't 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;
+ }
+ /**
+ * Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum SlideBackgroundGradientFillType {
+ /**
+ * Unsupported gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ unsupported = "Unsupported",
+ /**
+ * Linear gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ linear = "Linear",
+ /**
+ * Radial gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ radial = "Radial",
+ /**
+ * Rectangular gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rectangular = "Rectangular",
+ /**
+ * Path gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ path = "Path",
+ /**
+ * Shade from title gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ shadeFromTitle = "ShadeFromTitle",
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} gradient fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideBackgroundGradientFill 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 type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ /**
+ * 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.SlideBackgroundGradientFillLoadOptions): PowerPoint.SlideBackgroundGradientFill;
+ /**
+ * 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.SlideBackgroundGradientFill;
+ /**
+ * 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.SlideBackgroundGradientFill;
+ /**
+ * 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.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;
+ }
+ /**
+ * Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundGradientFillOptions {
+ /**
+ * If provided, specifies the type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ }
+ /**
+ * Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum SlideBackgroundPatternFillType {
+ /**
+ * Unsupported pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ unsupported = "Unsupported",
+ /**
+ * 5 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent5 = "Percent5",
+ /**
+ * 10 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent10 = "Percent10",
+ /**
+ * 20 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent20 = "Percent20",
+ /**
+ * 25 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent25 = "Percent25",
+ /**
+ * 30 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent30 = "Percent30",
+ /**
+ * 40 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent40 = "Percent40",
+ /**
+ * 50 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent50 = "Percent50",
+ /**
+ * 60 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent60 = "Percent60",
+ /**
+ * 70 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent70 = "Percent70",
+ /**
+ * 75 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent75 = "Percent75",
+ /**
+ * 80 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent80 = "Percent80",
+ /**
+ * 90 percent pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ percent90 = "Percent90",
+ /**
+ * Horizontal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ horizontal = "Horizontal",
+ /**
+ * Vertical pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ vertical = "Vertical",
+ /**
+ * Light horizontal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ lightHorizontal = "LightHorizontal",
+ /**
+ * Light vertical pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ lightVertical = "LightVertical",
+ /**
+ * Dark horizontal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ darkHorizontal = "DarkHorizontal",
+ /**
+ * Dark vertical pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ darkVertical = "DarkVertical",
+ /**
+ * Narrow horizontal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ narrowHorizontal = "NarrowHorizontal",
+ /**
+ * Narrow vertical pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ narrowVertical = "NarrowVertical",
+ /**
+ * Dashed horizontal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dashedHorizontal = "DashedHorizontal",
+ /**
+ * Dashed vertical pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dashedVertical = "DashedVertical",
+ /**
+ * Cross pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ cross = "Cross",
+ /**
+ * Downward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ downwardDiagonal = "DownwardDiagonal",
+ /**
+ * Upward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ upwardDiagonal = "UpwardDiagonal",
+ /**
+ * Light downward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ lightDownwardDiagonal = "LightDownwardDiagonal",
+ /**
+ * Light upward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ lightUpwardDiagonal = "LightUpwardDiagonal",
+ /**
+ * Dark downward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ darkDownwardDiagonal = "DarkDownwardDiagonal",
+ /**
+ * Dark upward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ darkUpwardDiagonal = "DarkUpwardDiagonal",
+ /**
+ * Wide downward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ wideDownwardDiagonal = "WideDownwardDiagonal",
+ /**
+ * Wide upward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ wideUpwardDiagonal = "WideUpwardDiagonal",
+ /**
+ * Dashed downward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dashedDownwardDiagonal = "DashedDownwardDiagonal",
+ /**
+ * Dashed upward diagonal pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dashedUpwardDiagonal = "DashedUpwardDiagonal",
+ /**
+ * Diagonal cross pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ diagonalCross = "DiagonalCross",
+ /**
+ * Small checker board pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ smallCheckerBoard = "SmallCheckerBoard",
+ /**
+ * Large checker board pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ largeCheckerBoard = "LargeCheckerBoard",
+ /**
+ * Small grid pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ smallGrid = "SmallGrid",
+ /**
+ * Large grid pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ largeGrid = "LargeGrid",
+ /**
+ * Dotted grid pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dottedGrid = "DottedGrid",
+ /**
+ * Small confetti pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ smallConfetti = "SmallConfetti",
+ /**
+ * Large confetti pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ largeConfetti = "LargeConfetti",
+ /**
+ * Horizontal brick pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ horizontalBrick = "HorizontalBrick",
+ /**
+ * Diagonal brick pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ diagonalBrick = "DiagonalBrick",
+ /**
+ * Solid diamond pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ solidDiamond = "SolidDiamond",
+ /**
+ * Outlined diamond pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ outlinedDiamond = "OutlinedDiamond",
+ /**
+ * Dotted diamond pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dottedDiamond = "DottedDiamond",
+ /**
+ * Plaid pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ plaid = "Plaid",
+ /**
+ * Sphere pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ sphere = "Sphere",
+ /**
+ * Weave pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ weave = "Weave",
+ /**
+ * Divot pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ divot = "Divot",
+ /**
+ * Shingle pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ shingle = "Shingle",
+ /**
+ * Wave pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ wave = "Wave",
+ /**
+ * Trellis pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ trellis = "Trellis",
+ /**
+ * Zig zag pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ zigZag = "ZigZag",
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} pattern fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideBackgroundPatternFill 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 background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor: string;
+ /**
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor: string;
+ /**
+ * Specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
+ /**
+ * 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.SlideBackgroundPatternFillLoadOptions): PowerPoint.SlideBackgroundPatternFill;
+ /**
+ * 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.SlideBackgroundPatternFill;
+ /**
+ * 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.SlideBackgroundPatternFill;
+ /**
+ * 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.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;
+ }
+ /**
+ * Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundPatternFillOptions {
+ /**
+ * If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor?: string;
+ /**
+ * If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor?: string;
+ /**
+ * If provided, specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideBackgroundPictureOrTextureFill 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 transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency: number;
+ /**
+ * Sets the image used to fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param base64EncodedImage - A string that is a Base64 encoding of the image data.
+ */
+ setImage(base64EncodedImage: 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.SlideBackgroundPictureOrTextureFillLoadOptions): PowerPoint.SlideBackgroundPictureOrTextureFill;
+ /**
+ * 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.SlideBackgroundPictureOrTextureFill;
+ /**
+ * 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.SlideBackgroundPictureOrTextureFill;
+ /**
+ * 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.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} picture or texture fill options.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundPictureOrTextureFillOptions {
+ /**
+ * If provided, specifies the Base64-encoded image data for the fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ imageBase64?: string;
+ /**
+ * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency: number;
+ }
+ /**
+ * Specifies the fill type for a {@link PowerPoint.SlideBackground}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum SlideBackgroundFillType {
+ /**
+ * Unsupported slide background fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ unsupported = "Unsupported",
+ /**
+ * Specifies that the slide background should have regular solid fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ solid = "Solid",
+ /**
+ * Specifies that the slide background should have gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ gradient = "Gradient",
+ /**
+ * Specifies that the slide background should have picture or texture fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pictureOrTexture = "PictureOrTexture",
+ /**
+ * Specifies that the slide background should have pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern = "Pattern",
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} solid fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideBackgroundSolidFill 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 fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color: string;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency: 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.SlideBackgroundSolidFillLoadOptions): PowerPoint.SlideBackgroundSolidFill;
+ /**
+ * 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.SlideBackgroundSolidFill;
+ /**
+ * 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.SlideBackgroundSolidFill;
+ /**
+ * 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.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;
+ }
+ /**
+ * Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundSolidFillOptions {
+ /**
+ * If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color?: string;
+ /**
+ * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /**
+ * Represents the fill formatting of a slide background object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideBackgroundFill extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
+ /**
+ * Gets the gradient fill properties. If the fill type is not `gradient`, 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.10]
+ */
+ getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;
+ /**
+ * Gets the pattern fill properties. If the fill type is not `pattern`, 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.10]
+ */
+ getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;
+ /**
+ * Gets the picture or texture fill properties. If the fill type is not `pictureOrTexture`, 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.10]
+ */
+ getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;
+ /**
+ * Gets the solid fill properties. If the fill type is not `solid`, 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.10]
+ */
+ getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;
+ /**
+ * Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options - Options for the gradient fill.
+ */
+ setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions): void;
+ /**
+ * Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options - Options for the pattern fill.
+ */
+ setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions): void;
+ /**
+ * Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options - Options for the picture or texture fill.
+ */
+ setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void;
+ /**
+ * Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options - Options for the solid fill.
+ */
+ setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions): 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.SlideBackgroundFillLoadOptions): PowerPoint.SlideBackgroundFill;
+ /**
+ * 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.SlideBackgroundFill;
+ /**
+ * 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.SlideBackgroundFill;
+ /**
+ * 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.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;
+ }
+ /**
+ * Represents a background of a slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideBackground extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly fill: PowerPoint.SlideBackgroundFill;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden: boolean;
+ /**
+ * Specifies if the slide background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed: boolean;
+ /**
+ * Resets the fill formatting of the slide background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ reset(): 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.SlideBackgroundLoadOptions): PowerPoint.SlideBackground;
+ /**
+ * 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.SlideBackground;
+ /**
+ * 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.SlideBackground;
+ /**
+ * 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.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundData;
+ }
+ /**
+ * 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;
+ }
+ /**
+ * Represents the background of a slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideLayoutBackground extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly fill: PowerPoint.SlideBackgroundFill;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden: boolean;
+ /**
+ * Specifies if the slide layout background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed: boolean;
+ /**
+ * Resets the fill formatting of the slide layout background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ reset(): 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.SlideLayoutBackgroundLoadOptions): PowerPoint.SlideLayoutBackground;
+ /**
+ * 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.SlideLayoutBackground;
+ /**
+ * 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.SlideLayoutBackground;
+ /**
+ * 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.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;
+ }
+ /**
+ * 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",
+ }
+ /**
+ * Specifies the theme colors used in PowerPoint.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum ThemeColor {
+ /**
+ * Specifies a mixed theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ mixed = "Mixed",
+ /**
+ * Specifies no theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ none = "None",
+ /**
+ * Specifies the Accent 1 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent1 = "Accent1",
+ /**
+ * Specifies the Accent 2 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent2 = "Accent2",
+ /**
+ * Specifies the Accent 3 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent3 = "Accent3",
+ /**
+ * Specifies the Accent 4 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent4 = "Accent4",
+ /**
+ * Specifies the Accent 5 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent5 = "Accent5",
+ /**
+ * Specifies the Accent 6 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent6 = "Accent6",
+ /**
+ * Specifies the Dark 1 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dark1 = "Dark1",
+ /**
+ * Specifies the Dark 2 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dark2 = "Dark2",
+ /**
+ * Specifies the clicked hyperlink theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ followedHyperlink = "FollowedHyperlink",
+ /**
+ * Specifies the hyperlink theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ hyperlink = "Hyperlink",
+ /**
+ * Specifies the Light 1 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ light1 = "Light1",
+ /**
+ * Specifies the Light 2 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ light2 = "Light2",
+ }
+ /**
+ * Represents a theme color scheme.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class ThemeColorScheme 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 color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color - The theme color.
+ * @returns The color value in #RRGGBB format (e.g., "FFA500").
+ */
+ getThemeColor(color: PowerPoint.ThemeColor): OfficeExtension.ClientResult;
+ /**
+ * Gets the color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color - The theme color.
+ * @returns The color value in #RRGGBB format (e.g., "FFA500").
+ */
+ getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"): OfficeExtension.ClientResult;
+ /**
+ * Sets the color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color - The theme color.
+ * @param rgbColor - The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
+ */
+ setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;
+ /**
+ * Sets the color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color - The theme color.
+ * @param rgbColor - The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
+ */
+ setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;
+ /**
+ * 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.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): {
+ [key: string]: string;
+ };
+ }
+ /**
+ * 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;
+ /**
+ * Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly background: PowerPoint.SlideLayoutBackground;
+ /**
+ * 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;
+ /**
+ * Returns the `ThemeColorScheme` of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly themeColorScheme: PowerPoint.ThemeColorScheme;
+ /**
+ * 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 doesn't 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 doesn't 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 background of a slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class SlideMasterBackground extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly fill: PowerPoint.SlideBackgroundFill;
+ /**
+ * 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.SlideMasterBackgroundLoadOptions): PowerPoint.SlideMasterBackground;
+ /**
+ * 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.SlideMasterBackground;
+ /**
+ * 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.SlideMasterBackground;
+ /**
+ * 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.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData;
+ }
+ /**
+ * Represents the Slide Master of a slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.3]
+ */
+ export class SlideMaster extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly background: PowerPoint.SlideMasterBackground;
+ /**
+ * 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;
+ /**
+ * Returns the `ThemeColorScheme` of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly themeColorScheme: PowerPoint.ThemeColorScheme;
+ /**
+ * 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's 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` doesn't 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 doesn't 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 doesn't 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 doesn't 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 key - The ID of the tag.
+ * @returns The tag with the unique ID. If such a tag doesn't 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;
+ /**
+ * Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly background: PowerPoint.SlideBackground;
+ /**
+ * 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;
+ /**
+ * Returns the `ThemeColorScheme` of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly themeColorScheme: PowerPoint.ThemeColorScheme;
+ /**
+ * 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 doesn't exist.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.2]
+ */
+ delete(): void;
+ /**
+ * Exports the slide to its own presentation file, returned as Base64-encoded data.
+
+ Note: This method is optimized to export a single slide. Exporting multiple slides can impact performance.
+ *
+ * @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-encoded 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 the format of an image.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum ShapeGetImageFormatType {
+ /**
+ * The picture is in PNG format.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ png = "Png",
+ }
+ /**
+ * Represents the available options when getting an image of a shape.
+ The image is scaled to fit into the desired dimensions. If width and height aren't specified, the true size of the shape is used.
+ If only one of either width or height is specified, the other will be calculated to preserve aspect ratio.
+ The resulting dimensions will automatically be clamped to the maximum supported size if too large.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface ShapeGetImageOptions {
+ /**
+ * The desired format of the resulting image.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ format?: PowerPoint.ShapeGetImageFormatType | "Png";
+ /**
+ * The desired height of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
+ Throws an `InvalidArgument` exception when set with a non-positive integer.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ height?: number;
+ /**
+ * The desired width of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
+ Throws an `InvalidArgument` exception when set with a non-positive integer.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ width?: number;
+ }
+ /**
+ * 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 doesn't 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 doesn't 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 doesn't 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 shape.
+ * @returns The shape with the unique ID. If such a shape doesn't 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 creation ID of the shape group. Returns `null` if the shape group has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly creationId: string | null;
+ /**
+ * 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 isn't visible or there are inconsistent dash styles. See {@link 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 isn't visible or there are inconsistent styles. See {@link 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 isn't 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;
+ }
+ /**
+ * 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 an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly adjustments: PowerPoint.Adjustments;
+ /**
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ readonly textFrame: PowerPoint.TextFrame;
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription: string;
+ /**
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle: string;
+ /**
+ * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly creationId: string | null;
+ /**
+ * 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;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative: 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: 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;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation: number;
+ /**
+ * 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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible: 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: 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 doesn't exist.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.3]
+ */
+ delete(): void;
+ /**
+ * Renders an image of the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options - Optional. Options to specify the desired output image properties.
+ * @returns A Base64-encoded string of the shape image in the specified format.
+ */
+ getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions): OfficeExtension.ClientResult;
+ /**
+ * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't 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 doesn't 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 doesn't belong to a `SlideLayout`, 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]
+ */
+ getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
+ /**
+ * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape doesn't 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 doesn't belong to a `SlideMaster`, 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]
+ */
+ getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
+ /**
+ * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape doesn't belong to a `Slide`, 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]
+ */
+ getParentSlideOrNullObject(): PowerPoint.Slide;
+ /**
+ * Returns the `Table` object if this shape is a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ getTable(): PowerPoint.Table;
+ /**
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. If the shape doesn't support a `TextFrame`, 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.10]
+ */
+ getTextFrameOrNullObject(): PowerPoint.TextFrame;
+ /**
+ * Sets a hyperlink on this `Shape` with the specified options. This will delete any existing hyperlink on this `Shape`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options - Optional. The options for the hyperlink.
+ * @returns The newly created {@link PowerPoint.Hyperlink} object.
+ */
+ setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
+ /**
+ * 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]
+ */
+ 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. Throws an error if the binding isn't 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 bindingType - Type of binding. See `BindingType`.
+ * @param id - ID of the binding.
+ */
+ add(shape: PowerPoint.Shape, bindingType: "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 bindingType - Type of binding. See `BindingType`.
+ * @param id - ID of the binding.
+ */
+ addFromSelection(bindingType: "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 zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index - The index of the custom property in the collection.
+ * @returns The custom property at the given index.
+ */
+ getItemAt(index: number): 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 aren't 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` isn't 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` isn't provided, the slides will be inserted at the beginning of the presentation.
+ If `targetSlideId` is invalid or if it's 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 page setup information for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export class PageSetup 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 height of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideHeight: number;
+ /**
+ * Specifies the width of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth: 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.PageSetupLoadOptions): PowerPoint.PageSetup;
+ /**
+ * 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.PageSetup;
+ /**
+ * 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.PageSetup;
+ /**
+ * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.PageSetupData;
+ }
+ /**
+ * 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 to the collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.3]
+ *
+ * @param options - Optional. Options for configuring the properties of the new slide.
+ */
+ add(options?: PowerPoint.AddSlideOptions): void;
+ /**
+ * Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.
+ Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param values - An array of slide IDs or `Slide` objects.
+ * @returns A Base64-encoded string.
+ */
+ exportAsBase64Presentation(values: Array): OfficeExtension.ClientResult;
+ /**
+ * 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 doesn't 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 doesn't 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[];
+ /**
+ * Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ * @returns A Base64-encoded string.
+ */
+ exportAsBase64Presentation(): OfficeExtension.ClientResult;
+ /**
+ * 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 doesn't 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 doesn't 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 doesn't 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 doesn't 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 `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
+ /** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
+ export interface BulletFormatUpdateData {
+ /**
+ * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ /**
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
+ /**
+ * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ visible?: boolean | null;
+ }
+ /** 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" | null;
+ /**
+ * Represents the indent level of the paragraph.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ indentLevel?: 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`: 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;
+ }
+ /** 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 `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 `Hyperlink` object, for use in `hyperlink.set({ ... })`. */
+ export interface HyperlinkUpdateData {
+ /**
+ * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @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 `Border` object, for use in `border.set({ ... })`. */
+ export interface BorderUpdateData {
+ /**
+ * 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.9]
+ */
+ color?: string | undefined;
+ /**
+ * Represents the dash style of the line.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ 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.9]
+ */
+ transparency?: number | undefined;
+ /**
+ * Represents the weight of the line, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ weight?: number | undefined;
+ }
+ /** An interface for updating data on the `Margins` object, for use in `margins.set({ ... })`. */
+ export interface MarginsUpdateData {
+ /**
+ * Specifies the bottom margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ bottom?: number | undefined;
+ /**
+ * Specifies the left margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ left?: number | undefined;
+ /**
+ * Specifies the right margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ right?: number | undefined;
+ /**
+ * Specifies the top margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ top?: number | undefined;
+ }
+ /** 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 doesn't 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 `TableCell` object, for use in `tableCell.set({ ... })`. */
+ export interface TableCellUpdateData {
+ /**
+ * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+ /**
+ * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ indentLevel?: number | null;
+ /**
+ * Specifies the text content of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ text?: string;
+ /**
+ * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ textRuns?: PowerPoint.TextRun[];
+ /**
+ * Specifies the vertical alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ }
+ /** 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 `TableColumn` object, for use in `tableColumn.set({ ... })`. */
+ export interface TableColumnUpdateData {
+ /**
+ * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ width?: number;
+ }
+ /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */
+ export interface TableColumnCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableColumnData[];
+ }
+ /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */
+ export interface TableRowUpdateData {
+ /**
+ * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ height?: number;
+ }
+ /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */
+ export interface TableRowCollectionUpdateData {
+ items?: PowerPoint.Interfaces.TableRowData[];
+ }
+ /** An interface for updating data on the `TableStyleSettings` object, for use in `tableStyleSettings.set({ ... })`. */
+ export interface TableStyleSettingsUpdateData {
+ /**
+ * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areColumnsBanded?: boolean;
+ /**
+ * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areRowsBanded?: boolean;
+ /**
+ * Specifies if the first column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstColumnHighlighted?: boolean;
+ /**
+ * Specifies if the first row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstRowHighlighted?: boolean;
+ /**
+ * Specifies if the last column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastColumnHighlighted?: boolean;
+ /**
+ * Specifies if the last row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastRowHighlighted?: boolean;
+ /**
+ * Specifies the table style.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ }
+ /** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+ /**
+ * Specifies the type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+ /**
+ * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor?: string;
+ /**
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor?: string;
+ /**
+ * Specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+ /**
+ * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color?: string;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide layout background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /** 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 isn't visible or there are inconsistent dash styles. See {@link 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 isn't visible or there are inconsistent styles. See {@link 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 isn't visible or there are inconsistent line weights.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ weight?: number;
+ }
+ /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
+ export interface ShapeUpdateData {
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription?: string;
+ /**
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: string;
+ /**
+ * 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;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: 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?: number;
+ /**
+ * Specifies the name of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ name?: string;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: number;
+ /**
+ * 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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: 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?: 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 `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+ /**
+ * Specifies the height of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideHeight?: number;
+ /**
+ * Specifies the width of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth?: number;
+ }
+ /** 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;
+ /**
+ * Returns the title of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.0]
+ */
+ title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+ /**
+ * Specifies the number of adjustment points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ count?: number;
+ }
+ /** 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 `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
+ /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
+ export interface BulletFormatData {
+ /**
+ * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ /**
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
+ /**
+ * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ visible?: boolean | null;
+ }
+ /** 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" | null;
+ /**
+ * Represents the indent level of the paragraph.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ indentLevel?: number;
+ }
+ /** 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`: 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;
+ }
+ /** 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 `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 `hyperlink.toJSON()`. */
+ export interface HyperlinkData {
+ /**
+ * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @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;
+ /**
+ * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";
+ }
+ /** 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 `hyperlinkCollection.toJSON()`. */
+ export interface HyperlinkCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
+ /** An interface describing the data returned by calling `border.toJSON()`. */
+ export interface BorderData {
+ /**
+ * 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.9]
+ */
+ color?: string | undefined;
+ /**
+ * Represents the dash style of the line.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ 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.9]
+ */
+ transparency?: number | undefined;
+ /**
+ * Represents the weight of the line, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ weight?: number | undefined;
+ }
+ /** An interface describing the data returned by calling `borders.toJSON()`. */
+ export interface BordersData {
+ }
+ /** An interface describing the data returned by calling `margins.toJSON()`. */
+ export interface MarginsData {
+ /**
+ * Specifies the bottom margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ bottom?: number | undefined;
+ /**
+ * Specifies the left margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ left?: number | undefined;
+ /**
+ * Specifies the right margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ right?: number | undefined;
+ /**
+ * Specifies the top margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ top?: number | undefined;
+ }
+ /** 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 doesn't 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 `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;
+ /**
+ * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+ /**
+ * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ indentLevel?: number | null;
+ /**
+ * 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;
+ /**
+ * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ textRuns?: PowerPoint.TextRun[];
+ /**
+ * Specifies the vertical alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ }
+ /** 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 `tableColumn.toJSON()`. */
+ export interface TableColumnData {
+ /**
+ * Returns the index number of the column within the column collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ columnIndex?: number;
+ /**
+ * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ width?: number;
+ }
+ /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */
+ export interface TableColumnCollectionData {
+ items?: PowerPoint.Interfaces.TableColumnData[];
+ }
+ /** An interface describing the data returned by calling `tableRow.toJSON()`. */
+ export interface TableRowData {
+ /**
+ * Retrieves the current height of the row in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ currentHeight?: number;
+ /**
+ * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ height?: number;
+ /**
+ * Returns the index number of the row within the rows collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ rowIndex?: number;
+ }
+ /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */
+ export interface TableRowCollectionData {
+ items?: PowerPoint.Interfaces.TableRowData[];
+ }
+ /** An interface describing the data returned by calling `tableStyleSettings.toJSON()`. */
+ export interface TableStyleSettingsData {
+ /**
+ * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areColumnsBanded?: boolean;
+ /**
+ * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areRowsBanded?: boolean;
+ /**
+ * Specifies if the first column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstColumnHighlighted?: boolean;
+ /**
+ * Specifies if the first row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstRowHighlighted?: boolean;
+ /**
+ * Specifies if the last column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastColumnHighlighted?: boolean;
+ /**
+ * Specifies if the last row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastRowHighlighted?: boolean;
+ /**
+ * Specifies the table style.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ }
+ /** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+ /**
+ * Specifies the type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+ /**
+ * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor?: string;
+ /**
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor?: string;
+ /**
+ * Specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+ /**
+ * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color?: string;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+ /**
+ * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide layout background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /** 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 `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
+ /** 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 creation ID of the shape group. Returns `null` if the shape group has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: string | null;
+ /**
+ * 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 isn't visible or there are inconsistent dash styles. See {@link 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 isn't visible or there are inconsistent styles. See {@link 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 isn't visible or there are inconsistent line weights.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ weight?: number;
+ }
+ /** An interface describing the data returned by calling `shape.toJSON()`. */
+ export interface ShapeData {
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription?: string;
+ /**
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: string;
+ /**
+ * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: string | null;
+ /**
+ * 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;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: 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?: 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;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: number;
+ /**
+ * 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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: 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?: 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 `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+ /**
+ * Specifies the height of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideHeight?: number;
+ /**
+ * Specifies the width of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth?: number;
+ }
+ /** 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[];
+ }
+ /**
+ * The `Presentation` object is the top-level object with one or more slides that contain the contents of the presentation.
+ To learn more about the PowerPoint object model,
+ see {@link https://learn.microsoft.com/office/dev/add-ins/powerpoint/core-concepts | PowerPoint JavaScript object model}.
+ *
+ * @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;
+ /**
+ * Returns the page setup information whose properties control slide setup attributes for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;
+ /**
+ * 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;
+ /**
+ * Returns the title of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.0]
+ */
+ title?: boolean;
+ }
+ /**
+ * Represents the adjustment values for a shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface AdjustmentsLoadOptions {
+ /**
+ 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 number of adjustment points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ count?: 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 a scoped collection of hyperlinks.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface HyperlinkScopedCollectionLoadOptions {
+ /**
+ 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 address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @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;
+ /**
+ * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: 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 the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ style?: boolean;
+ /**
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
+ /**
+ * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ visible?: boolean;
+ }
+ /**
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ export interface ParagraphFormatLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
+ /**
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ horizontalAlignment?: boolean;
+ /**
+ * Represents the indent level of the paragraph.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ indentLevel?: 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`: Returned if 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's 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 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;
+ }
+ /**
+ * 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 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 address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @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;
+ /**
+ * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: 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 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 address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @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;
+ /**
+ * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents the properties for a table cell border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface BorderLoadOptions {
+ /**
+ 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 the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ color?: boolean;
+ /**
+ * Represents the dash style of the line.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ dashStyle?: boolean;
+ /**
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ transparency?: boolean;
+ /**
+ * Represents the weight of the line, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ weight?: boolean;
+ }
+ /**
+ * Represents the borders for a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface BordersLoadOptions {
+ /**
+ 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 bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ bottom?: PowerPoint.Interfaces.BorderLoadOptions;
+ /**
+ * Gets the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;
+ /**
+ * Gets the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;
+ /**
+ * Gets the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ left?: PowerPoint.Interfaces.BorderLoadOptions;
+ /**
+ * Gets the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ right?: PowerPoint.Interfaces.BorderLoadOptions;
+ /**
+ * Gets the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ top?: PowerPoint.Interfaces.BorderLoadOptions;
+ }
+ /**
+ * Represents the margins of a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface MarginsLoadOptions {
+ /**
+ 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 bottom margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ bottom?: boolean;
+ /**
+ * Specifies the left margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ left?: boolean;
+ /**
+ * Specifies the right margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ right?: boolean;
+ /**
+ * Specifies the top margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ top?: 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 doesn't 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 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 collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ borders?: PowerPoint.Interfaces.BordersLoadOptions;
+ /**
+ * Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+ /**
+ * Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
+ /**
+ * Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ margins?: PowerPoint.Interfaces.MarginsLoadOptions;
+ /**
+ * 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;
+ /**
+ * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ horizontalAlignment?: boolean;
+ /**
+ * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ indentLevel?: 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;
+ /**
+ * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ textRuns?: boolean;
+ /**
+ * Specifies the vertical alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ verticalAlignment?: 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 collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ borders?: PowerPoint.Interfaces.BordersLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
+ /**
+ * For EACH ITEM in the collection: Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ margins?: PowerPoint.Interfaces.MarginsLoadOptions;
+ /**
+ * 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: Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ horizontalAlignment?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ indentLevel?: 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;
+ /**
+ * For EACH ITEM in the collection: Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ textRuns?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the vertical alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ verticalAlignment?: boolean;
+ }
+ /**
+ * Represents a column in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface TableColumnLoadOptions {
+ /**
+ 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 index number of the column within the column collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ columnIndex?: boolean;
+ /**
+ * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ width?: boolean;
+ }
+ /**
+ * Represents a collection of table columns.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface TableColumnCollectionLoadOptions {
+ /**
+ 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 index number of the column within the column collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ columnIndex?: boolean;
+ /**
+ * For EACH ITEM in the collection: Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ width?: boolean;
+ }
+ /**
+ * Represents a row in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface TableRowLoadOptions {
+ /**
+ 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;
+ /**
+ * Retrieves the current height of the row in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ currentHeight?: boolean;
+ /**
+ * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ height?: boolean;
+ /**
+ * Returns the index number of the row within the rows collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ rowIndex?: boolean;
+ }
+ /**
+ * Represents a collection of table rows.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface TableRowCollectionLoadOptions {
+ /**
+ 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: Retrieves the current height of the row in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ currentHeight?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ height?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the index number of the row within the rows collection of the table. Zero-indexed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ rowIndex?: boolean;
+ }
+ /**
+ * Represents the available table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ export interface TableStyleSettingsLoadOptions {
+ /**
+ 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 columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areColumnsBanded?: boolean;
+ /**
+ * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areRowsBanded?: boolean;
+ /**
+ * Specifies if the first column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstColumnHighlighted?: boolean;
+ /**
+ * Specifies if the first row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstRowHighlighted?: boolean;
+ /**
+ * Specifies if the last column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastColumnHighlighted?: boolean;
+ /**
+ * Specifies if the last row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastRowHighlighted?: boolean;
+ /**
+ * Specifies the table style.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ style?: 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 table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions;
+ /**
+ * 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 an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
+ /**
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ /**
+ * For EACH ITEM in the collection: The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription?: boolean;
+ /**
+ * For EACH ITEM in the collection: The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: boolean;
+ /**
+ * 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: Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: 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: Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: 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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: 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 {@link PowerPoint.SlideBackground} gradient fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundGradientFillLoadOptions {
+ /**
+ 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 type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} pattern fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundPatternFillLoadOptions {
+ /**
+ 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 background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor?: boolean;
+ /**
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor?: boolean;
+ /**
+ * Specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern?: boolean;
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundPictureOrTextureFillLoadOptions {
+ /**
+ 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 transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: boolean;
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} solid fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundSolidFillLoadOptions {
+ /**
+ 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 fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color?: boolean;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: boolean;
+ }
+ /**
+ * Represents the fill formatting of a slide background object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundFillLoadOptions {
+ /**
+ 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 type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents a background of a slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideBackgroundLoadOptions {
+ /**
+ 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 the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /**
+ * Represents the background of a slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideLayoutBackgroundLoadOptions {
+ /**
+ 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 the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide layout background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: 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 background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
+ /**
+ * 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 background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
+ /**
+ * 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 background of a slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface SlideMasterBackgroundLoadOptions {
+ /**
+ 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 the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
+ }
+ /**
+ * 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 background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
+ /**
+ * 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 background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
+ /**
+ * 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 an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
+ /**
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ /**
+ * For EACH ITEM in the collection: The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription?: boolean;
+ /**
+ * For EACH ITEM in the collection: The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: boolean;
+ /**
+ * 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: Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: 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: Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: 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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: 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 creation ID of the shape group. Returns `null` if the shape group has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: boolean;
+ /**
+ * 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 isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ dashStyle?: boolean;
+ /**
+ * Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link 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 isn't visible or there are inconsistent line weights.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ weight?: 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 an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
+ /**
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription?: boolean;
+ /**
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: boolean;
+ /**
+ * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: boolean;
+ /**
+ * 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;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: 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;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: 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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: 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 page setup information for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ export interface PageSetupLoadOptions {
+ /**
+ 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 height of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideHeight?: boolean;
+ /**
+ * Specifies the width of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth?: 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 background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
+ /**
+ * 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 background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
+ /**
+ * 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 background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
+ /**
+ * 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 prepopulated with a Base64-encoded .pptx file.
+ *
+ * [Api set: PowerPointApi 1.1]
+ *
+ * @param base64File - Optional. The Base64-encoded .pptx file. The default value is null. The maximum length of the string is 71,680,000 characters.
+ */
+ 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_10/tsconfig.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/tsconfig.json
new file mode 100644
index 0000000000..c8d2a749f7
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/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_10/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/tsdoc-metadata.json
new file mode 100644
index 0000000000..c7877dbdce
--- /dev/null
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_10/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.53.1"
+ }
+ ]
+}
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 c51deb9140..89bc8725db 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -41,6 +41,7 @@ export declare namespace PowerPoint {
+
/**
* Returns an ordered collection of slides in the presentation.
*
@@ -94,9 +95,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -135,6 +136,29 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -171,6 +195,8 @@ export declare namespace PowerPoint {
+
+
/**
* Gets the unique ID of the slide.
*
@@ -213,9 +239,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -230,6 +256,8 @@ export declare namespace PowerPoint {
+
+
/**
* Specifies the formatting options for when slides are inserted.
*
@@ -285,6 +313,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -297,6 +326,7 @@ export declare namespace PowerPoint {
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Slide[];
+
/**
* Gets the number of slides in the collection.
*
@@ -356,9 +386,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
@@ -388,13 +418,20 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
export interface BulletFormatUpdateData {
+
+
}
/** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */
export interface ParagraphFormatUpdateData {
+
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
@@ -496,6 +533,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -529,6 +595,11 @@ export declare namespace PowerPoint {
+
+
+
+
+
}
/** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
export interface BindingCollectionUpdateData {
@@ -553,6 +624,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -576,6 +652,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -590,13 +670,20 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
export interface BulletFormatData {
+
+
}
/** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
export interface ParagraphFormatData {
+
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
@@ -634,6 +721,7 @@ export declare namespace PowerPoint {
export interface HyperlinkData {
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -721,6 +809,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -732,6 +853,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
@@ -764,6 +888,7 @@ export declare namespace PowerPoint {
/** 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 {
@@ -785,6 +910,12 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
}
/** An interface describing the data returned by calling `binding.toJSON()`. */
export interface BindingData {
@@ -818,6 +949,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -846,6 +982,7 @@ export declare namespace PowerPoint {
$all?: boolean;
+
/**
* Returns the title of the presentation.
*
@@ -872,6 +1009,16 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
+
+
+
+
@@ -896,6 +1043,7 @@ export declare namespace PowerPoint {
$all?: boolean;
+
/**
* Gets the unique ID of the slide.
*
@@ -914,6 +1062,7 @@ export declare namespace PowerPoint {
+
/**
* Represents the collection of slides in the presentation.
*
@@ -927,6 +1076,7 @@ export declare namespace PowerPoint {
$all?: boolean;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide.
*
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 ab5aff2ba9..56762eeba6 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -40,6 +40,7 @@ export declare namespace PowerPoint {
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -106,9 +107,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -179,6 +180,12 @@ export declare namespace PowerPoint {
+
+
+
+
+
+
@@ -261,13 +268,29 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 layout of a slide.
*
@@ -278,6 +301,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of shapes in the slide layout.
*
@@ -285,6 +309,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -322,9 +347,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -396,11 +421,12 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -411,6 +437,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Gets the collection of layouts provided by the Slide Master for slides.
*
@@ -425,6 +452,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -461,9 +489,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -511,9 +539,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -603,9 +631,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -619,6 +647,7 @@ export declare namespace PowerPoint {
context: RequestContext;
+
/**
* Gets the layout of the slide.
*
@@ -647,6 +676,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+
/**
* Gets the unique ID of the slide.
*
@@ -689,9 +719,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -699,6 +729,8 @@ export declare namespace PowerPoint {
+
+
/**
* Represents a single shape in the slide.
*
@@ -714,6 +746,7 @@ export declare namespace PowerPoint {
+
/**
* Returns a collection of tags in the shape.
*
@@ -723,6 +756,9 @@ export declare namespace PowerPoint {
readonly tags: PowerPoint.TagCollection;
+
+
+
/**
* Gets the unique ID of the shape.
*
@@ -737,6 +773,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Deletes the shape from the shape collection. Does nothing if the shape doesn't exist.
*
@@ -753,6 +792,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.
*
@@ -775,9 +817,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -841,6 +883,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -861,6 +904,7 @@ export declare namespace PowerPoint {
* @param options - Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+
/**
* Gets the number of slides in the collection.
*
@@ -920,9 +964,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
@@ -995,9 +1039,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -1025,13 +1069,20 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
export interface BulletFormatUpdateData {
+
+
}
/** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */
export interface ParagraphFormatUpdateData {
+
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
@@ -1133,6 +1184,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -1172,6 +1252,11 @@ export declare namespace PowerPoint {
+
+
+
+
+
}
/** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
export interface BindingCollectionUpdateData {
@@ -1196,6 +1281,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -1219,6 +1309,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -1233,13 +1327,20 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
export interface BulletFormatData {
+
+
}
/** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
export interface ParagraphFormatData {
+
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
@@ -1277,6 +1378,7 @@ export declare namespace PowerPoint {
export interface HyperlinkData {
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -1364,6 +1466,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -1387,6 +1522,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
/**
@@ -1443,6 +1581,7 @@ export declare namespace PowerPoint {
/** 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 {
@@ -1456,6 +1595,9 @@ export declare namespace PowerPoint {
/** An interface describing the data returned by calling `shape.toJSON()`. */
export interface ShapeData {
+
+
+
/**
* Gets the unique ID of the shape.
*
@@ -1470,6 +1612,9 @@ export declare namespace PowerPoint {
+
+
+
}
/** An interface describing the data returned by calling `binding.toJSON()`. */
export interface BindingData {
@@ -1503,6 +1648,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -1531,6 +1681,7 @@ export declare namespace PowerPoint {
$all?: boolean;
+
/**
* Returns the title of the presentation.
*
@@ -1559,6 +1710,8 @@ export declare namespace PowerPoint {
+
+
@@ -1580,6 +1733,10 @@ export declare namespace PowerPoint {
+
+
+
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the shape.
*
@@ -1594,7 +1751,17 @@ export declare namespace PowerPoint {
+
+
+
}
+
+
+
+
+
+
+
/**
* Represents the layout of a slide.
*
@@ -1606,6 +1773,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;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -1633,6 +1801,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -1649,6 +1818,7 @@ export declare namespace PowerPoint {
name?: boolean;
}
+
/**
* Represents the Slide Master of a slide.
*
@@ -1660,6 +1830,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;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -1738,6 +1909,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;
+
/**
* Gets the layout of the slide.
*
@@ -1782,6 +1954,10 @@ export declare namespace PowerPoint {
+
+
+
+
/**
* Gets the unique ID of the shape.
*
@@ -1796,12 +1972,16 @@ export declare namespace PowerPoint {
+
+
+
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -1813,19 +1993,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -1848,6 +2029,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
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 d1d597fa9b..05ca1d6d32 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -40,6 +40,7 @@ export declare namespace PowerPoint {
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -106,9 +107,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -142,6 +143,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
*
@@ -192,6 +196,8 @@ export declare namespace PowerPoint {
*/
thaiDistributed = "ThaiDistributed",
}
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -201,6 +207,8 @@ export declare namespace PowerPoint {
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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -230,9 +238,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -258,6 +266,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -280,9 +289,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -486,9 +495,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -671,9 +680,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -692,6 +701,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly font: PowerPoint.ShapeFont;
+
/**
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
*
@@ -720,6 +730,7 @@ export declare namespace PowerPoint {
*/
getSubstring(start: number, length?: number): PowerPoint.TextRange;
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -742,13 +753,14 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
+
/**
* Specifies the type of a shape.
*
@@ -2358,13 +2370,29 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 layout of a slide.
*
@@ -2375,6 +2403,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of shapes in the slide layout.
*
@@ -2382,6 +2411,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -2419,9 +2449,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2493,11 +2523,12 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -2508,6 +2539,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Gets the collection of layouts provided by the Slide Master for slides.
*
@@ -2522,6 +2554,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -2558,9 +2591,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2608,9 +2641,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2700,9 +2733,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -2716,6 +2749,7 @@ export declare namespace PowerPoint {
context: RequestContext;
+
/**
* Gets the layout of the slide.
*
@@ -2744,6 +2778,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+
/**
* Gets the unique ID of the slide.
*
@@ -2786,13 +2821,15 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
+
+
/**
* Specifies the style for a line.
*
@@ -2904,9 +2941,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -2920,6 +2957,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns the fill formatting of this shape.
*
@@ -2951,6 +2989,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -2965,6 +3006,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -2980,6 +3022,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -2994,6 +3037,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3018,6 +3062,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.
*
@@ -3040,9 +3087,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -3106,6 +3153,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -3126,6 +3174,7 @@ export declare namespace PowerPoint {
* @param options - Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+
/**
* Gets the number of slides in the collection.
*
@@ -3185,9 +3234,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
@@ -3260,9 +3309,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -3290,8 +3339,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -3309,6 +3364,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
@@ -3316,11 +3372,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3337,11 +3393,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3518,6 +3574,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -3588,6 +3673,8 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -3595,6 +3682,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3609,6 +3697,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3616,6 +3705,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3647,6 +3737,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -3670,6 +3765,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -3684,8 +3783,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -3703,6 +3808,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
@@ -3710,11 +3816,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3731,11 +3837,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3842,6 +3948,7 @@ export declare namespace PowerPoint {
export interface HyperlinkData {
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -3947,6 +4054,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -3970,6 +4110,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
/**
@@ -4026,6 +4169,7 @@ export declare namespace PowerPoint {
/** 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 {
@@ -4074,6 +4218,9 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -4088,6 +4235,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4103,6 +4251,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4117,6 +4266,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4158,6 +4308,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -4186,6 +4341,7 @@ export declare namespace PowerPoint {
$all?: boolean;
+
/**
* Returns the title of the presentation.
*
@@ -4197,6 +4353,8 @@ export declare namespace PowerPoint {
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -4208,6 +4366,8 @@ 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 if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -4241,6 +4401,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: boolean;
+
}
/**
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -4482,30 +4643,34 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @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.
*
@@ -4520,6 +4685,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4535,6 +4701,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4549,6 +4716,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4558,6 +4726,13 @@ export declare namespace PowerPoint {
width?: boolean;
}
+
+
+
+
+
+
+
/**
* Represents the layout of a slide.
*
@@ -4569,6 +4744,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;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -4596,6 +4772,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -4612,6 +4789,7 @@ export declare namespace PowerPoint {
name?: boolean;
}
+
/**
* Represents the Slide Master of a slide.
*
@@ -4623,6 +4801,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;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -4701,6 +4880,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;
+
/**
* Gets the layout of the slide.
*
@@ -4791,30 +4971,34 @@ 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;
+
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -4829,6 +5013,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4844,6 +5029,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4858,6 +5044,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4872,6 +5059,7 @@ export declare namespace PowerPoint {
+
/**
* Represents the collection of slides in the presentation.
*
@@ -4883,19 +5071,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -4918,6 +5107,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
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 3e53c331c2..188393166d 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -40,6 +40,7 @@ export declare namespace PowerPoint {
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -150,9 +151,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -186,6 +187,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
*
@@ -236,6 +240,8 @@ export declare namespace PowerPoint {
*/
thaiDistributed = "ThaiDistributed",
}
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -245,6 +251,8 @@ export declare namespace PowerPoint {
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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -274,9 +282,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -302,6 +310,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -324,9 +333,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -530,9 +539,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -721,9 +730,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -742,6 +751,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly font: PowerPoint.ShapeFont;
+
/**
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
*
@@ -789,6 +799,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -818,13 +829,14 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
+
/**
* Specifies the type of a shape.
*
@@ -2434,13 +2446,29 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 layout of a slide.
*
@@ -2451,6 +2479,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of shapes in the slide layout.
*
@@ -2458,6 +2487,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -2495,9 +2525,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2569,11 +2599,12 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -2584,6 +2615,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Gets the collection of layouts provided by the Slide Master for slides.
*
@@ -2598,6 +2630,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -2634,9 +2667,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2684,9 +2717,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2776,9 +2809,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -2792,6 +2825,7 @@ export declare namespace PowerPoint {
context: RequestContext;
+
/**
* Gets the layout of the slide.
*
@@ -2820,6 +2854,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+
/**
* Gets the unique ID of the slide.
*
@@ -2870,11 +2905,13 @@ export declare namespace PowerPoint {
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.
- */
+ * 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.
*
@@ -2944,9 +2981,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
@@ -3061,9 +3098,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -3077,6 +3114,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns the fill formatting of this shape.
*
@@ -3108,6 +3146,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3122,6 +3163,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3137,6 +3179,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3151,6 +3194,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3166,6 +3210,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
delete(): void;
+
/**
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
*
@@ -3211,6 +3256,8 @@ 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.
*
@@ -3233,9 +3280,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -3299,6 +3346,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -3319,6 +3367,7 @@ export declare namespace PowerPoint {
* @param options - Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+
/**
* Gets the number of slides in the collection.
*
@@ -3378,9 +3427,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3394,6 +3443,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Slide[];
+
/**
* Gets the number of slides in the collection.
*
@@ -3452,9 +3502,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3526,9 +3576,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -3556,8 +3606,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -3575,6 +3631,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
@@ -3582,11 +3639,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3603,11 +3660,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3798,6 +3855,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -3868,6 +3954,8 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -3875,6 +3963,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3889,6 +3978,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3896,6 +3986,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3927,6 +4018,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -3956,6 +4052,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -3970,8 +4070,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -3989,6 +4095,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
@@ -3996,11 +4103,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4017,11 +4124,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4142,6 +4249,7 @@ export declare namespace PowerPoint {
export interface HyperlinkData {
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -4247,6 +4355,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -4270,6 +4411,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
/**
@@ -4326,6 +4470,7 @@ export declare namespace PowerPoint {
/** 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 {
@@ -4374,6 +4519,9 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -4388,6 +4536,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4403,6 +4552,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4417,6 +4567,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4458,6 +4609,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -4485,6 +4641,7 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
+
/**
* Gets the ID of the presentation.
*
@@ -4503,6 +4660,8 @@ export declare namespace PowerPoint {
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -4514,6 +4673,8 @@ 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 if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -4547,6 +4708,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: boolean;
+
}
/**
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -4802,30 +4964,34 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @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.
*
@@ -4840,6 +5006,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4855,6 +5022,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4869,6 +5037,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4878,6 +5047,13 @@ export declare namespace PowerPoint {
width?: boolean;
}
+
+
+
+
+
+
+
/**
* Represents the layout of a slide.
*
@@ -4889,6 +5065,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;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -4916,6 +5093,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -4932,6 +5110,7 @@ export declare namespace PowerPoint {
name?: boolean;
}
+
/**
* Represents the Slide Master of a slide.
*
@@ -4943,6 +5122,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;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -5021,6 +5201,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;
+
/**
* Gets the layout of the slide.
*
@@ -5055,30 +5236,34 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -5093,6 +5278,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5108,6 +5294,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5122,6 +5309,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5197,30 +5385,34 @@ 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;
+
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -5235,6 +5427,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5250,6 +5443,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5264,6 +5458,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5278,6 +5473,7 @@ export declare namespace PowerPoint {
+
/**
* Represents the collection of slides in the presentation.
*
@@ -5289,19 +5485,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -5323,19 +5520,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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.
@@ -5357,6 +5555,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
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 6a5e9560c4..ff5f503dbc 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -40,6 +40,7 @@ export declare namespace PowerPoint {
+
/**
* Returns the collection of `SlideMaster` objects that are in the presentation.
*
@@ -150,9 +151,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -186,6 +187,9 @@ export declare namespace PowerPoint {
+
+
+
/**
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
*
@@ -236,6 +240,8 @@ export declare namespace PowerPoint {
*/
thaiDistributed = "ThaiDistributed",
}
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -245,6 +251,8 @@ export declare namespace PowerPoint {
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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -274,9 +282,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -302,6 +310,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -324,9 +333,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -530,9 +539,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -721,9 +730,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -742,6 +751,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly font: PowerPoint.ShapeFont;
+
/**
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
*
@@ -789,6 +799,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -818,11 +829,12 @@ export declare namespace PowerPoint {
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.
- */
+ * 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 a single hyperlink.
*
@@ -846,6 +858,10 @@ export declare namespace PowerPoint {
* [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.
*
@@ -868,9 +884,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -1008,6 +1024,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Hyperlink[];
+
/**
* Gets the number of hyperlinks in the collection.
*
@@ -1046,9 +1063,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -2536,13 +2553,29 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 layout of a slide.
*
@@ -2553,6 +2586,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of shapes in the slide layout.
*
@@ -2560,6 +2594,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -2597,9 +2632,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2671,11 +2706,12 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -2686,6 +2722,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Gets the collection of layouts provided by the Slide Master for slides.
*
@@ -2700,6 +2737,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -2736,9 +2774,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2786,9 +2824,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2878,9 +2916,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -2893,6 +2931,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of hyperlinks in the slide.
*
@@ -2928,6 +2967,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+
/**
* Gets the unique ID of the slide.
*
@@ -2978,11 +3018,13 @@ export declare namespace PowerPoint {
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.
- */
+ * 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.
*
@@ -3052,9 +3094,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
@@ -3169,9 +3211,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -3185,6 +3227,7 @@ export declare namespace PowerPoint {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns the fill formatting of this shape.
*
@@ -3216,6 +3259,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3230,6 +3276,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3245,6 +3292,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3259,6 +3307,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3274,6 +3323,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
delete(): void;
+
/**
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
*
@@ -3319,6 +3369,8 @@ 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.
*
@@ -3341,9 +3393,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -3407,6 +3459,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -3427,6 +3480,7 @@ export declare namespace PowerPoint {
* @param options - Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+
/**
* Gets the number of slides in the collection.
*
@@ -3486,9 +3540,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3502,6 +3556,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Slide[];
+
/**
* Gets the number of slides in the collection.
*
@@ -3560,9 +3615,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3634,9 +3689,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -3664,8 +3719,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -3683,6 +3744,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
@@ -3690,11 +3752,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3711,11 +3773,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -3918,6 +3980,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -3988,6 +4079,8 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -3995,6 +4088,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4009,6 +4103,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4016,6 +4111,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4047,6 +4143,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -4076,6 +4177,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -4090,8 +4195,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -4109,6 +4220,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
@@ -4116,11 +4228,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4137,11 +4249,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4274,6 +4386,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: string;
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -4379,6 +4492,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -4402,6 +4548,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
/**
@@ -4458,6 +4607,7 @@ export declare namespace PowerPoint {
/** 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 {
@@ -4506,6 +4656,9 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -4520,6 +4673,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4535,6 +4689,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4549,6 +4704,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4590,6 +4746,11 @@ export declare namespace PowerPoint {
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -4617,6 +4778,7 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
+
/**
* Gets the ID of the presentation.
*
@@ -4635,6 +4797,8 @@ export declare namespace PowerPoint {
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -4646,6 +4810,8 @@ 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 if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -4679,6 +4845,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: boolean;
+
}
/**
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -4901,6 +5068,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
/**
@@ -4928,6 +5096,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
@@ -4984,30 +5153,34 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @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.
*
@@ -5022,6 +5195,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5037,6 +5211,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5051,6 +5226,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5060,6 +5236,13 @@ export declare namespace PowerPoint {
width?: boolean;
}
+
+
+
+
+
+
+
/**
* Represents the layout of a slide.
*
@@ -5071,6 +5254,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;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -5098,6 +5282,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -5114,6 +5299,7 @@ export declare namespace PowerPoint {
name?: boolean;
}
+
/**
* Represents the Slide Master of a slide.
*
@@ -5125,6 +5311,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;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -5203,6 +5390,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;
+
/**
* Gets the layout of the slide.
*
@@ -5237,30 +5425,34 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -5275,6 +5467,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5290,6 +5483,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5304,6 +5498,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5379,30 +5574,34 @@ 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;
+
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -5417,6 +5616,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5432,6 +5632,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5446,6 +5647,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5460,6 +5662,7 @@ export declare namespace PowerPoint {
+
/**
* Represents the collection of slides in the presentation.
*
@@ -5471,19 +5674,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -5505,19 +5709,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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.
@@ -5539,6 +5744,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
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 a3cbb37d21..acf5f66a52 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -45,6 +45,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+
/**
* Gets the properties of the presentation.
*
@@ -162,9 +163,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -195,6 +196,7 @@ export declare namespace PowerPoint {
slideMasterId?: string;
}
+
/**
* Represents a custom XML part object.
*
@@ -263,9 +265,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -298,6 +300,7 @@ export declare namespace PowerPoint {
* @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`.
@@ -344,9 +347,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -395,6 +398,7 @@ export declare namespace PowerPoint {
* @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`.
@@ -425,11 +429,13 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
+
+
/**
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
*
@@ -480,6 +486,8 @@ export declare namespace PowerPoint {
*/
thaiDistributed = "ThaiDistributed",
}
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -489,6 +497,8 @@ export declare namespace PowerPoint {
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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -518,9 +528,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -546,6 +556,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -568,9 +579,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -774,9 +785,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -965,9 +976,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -986,6 +997,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly font: PowerPoint.ShapeFont;
+
/**
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
*
@@ -1033,6 +1045,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -1062,11 +1075,12 @@ export declare namespace PowerPoint {
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.
- */
+ * 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 a single hyperlink.
*
@@ -1090,6 +1104,10 @@ export declare namespace PowerPoint {
* [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.
*
@@ -1112,9 +1130,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -1252,6 +1270,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Hyperlink[];
+
/**
* Gets the number of hyperlinks in the collection.
*
@@ -1290,9 +1309,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -2780,13 +2799,29 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 layout of a slide.
*
@@ -2796,6 +2831,7 @@ export declare namespace PowerPoint {
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.
*
@@ -2810,6 +2846,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -2847,9 +2884,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2921,11 +2958,12 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -2935,6 +2973,7 @@ export declare namespace PowerPoint {
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.
*
@@ -2956,6 +2995,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -2992,9 +3032,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -3042,9 +3082,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -3134,9 +3174,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3148,6 +3188,7 @@ export declare namespace PowerPoint {
export class Slide extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of custom XML parts in the slide.
*
@@ -3190,6 +3231,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+
/**
* Gets the unique ID of the slide.
*
@@ -3240,11 +3282,13 @@ export declare namespace PowerPoint {
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.
- */
+ * 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.
*
@@ -3314,9 +3358,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
@@ -3431,9 +3475,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -3446,6 +3490,7 @@ export declare namespace PowerPoint {
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.
*
@@ -3484,6 +3529,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3498,6 +3546,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3513,6 +3562,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3527,6 +3577,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -3542,6 +3593,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
delete(): void;
+
/**
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
*
@@ -3587,6 +3639,8 @@ 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.
*
@@ -3609,9 +3663,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
@@ -3708,9 +3762,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -3761,6 +3815,7 @@ export declare namespace PowerPoint {
* 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`.
@@ -3792,9 +3847,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3912,9 +3967,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -3972,6 +4027,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -3992,6 +4048,7 @@ export declare namespace PowerPoint {
* @param options - Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+
/**
* Gets the number of slides in the collection.
*
@@ -4051,9 +4108,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -4067,6 +4124,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Slide[];
+
/**
* Gets the number of slides in the collection.
*
@@ -4125,9 +4183,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -4199,9 +4257,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -4229,8 +4287,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -4248,6 +4312,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
export interface ShapeFontUpdateData {
@@ -4255,11 +4320,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4276,11 +4341,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4483,6 +4548,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -4553,6 +4647,8 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -4560,6 +4656,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4574,6 +4671,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4581,6 +4679,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4673,6 +4772,11 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
title?: string;
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -4702,6 +4806,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -4728,8 +4836,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -4747,6 +4861,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
export interface ShapeFontData {
@@ -4754,11 +4869,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4775,11 +4890,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -4912,6 +5027,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: string;
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -5017,6 +5133,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -5040,6 +5189,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
/**
@@ -5096,6 +5248,7 @@ export declare namespace PowerPoint {
/** 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 {
@@ -5144,6 +5297,9 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -5158,6 +5314,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5173,6 +5330,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5187,6 +5345,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5313,6 +5472,11 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -5339,12 +5503,13 @@ 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;
+
/**
- * Gets the properties of the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi 1.7]
- */
+ * Gets the properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
/**
* Gets the ID of the presentation.
@@ -5361,6 +5526,7 @@ export declare namespace PowerPoint {
*/
title?: boolean;
}
+
/**
* Represents a custom XML part object.
*
@@ -5441,6 +5607,7 @@ export declare namespace PowerPoint {
*/
namespaceUri?: boolean;
}
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -5452,6 +5619,8 @@ 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 if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -5485,6 +5654,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: boolean;
+
}
/**
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -5707,6 +5877,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
/**
@@ -5734,6 +5905,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
@@ -5790,30 +5962,34 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @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.
*
@@ -5828,6 +6004,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5843,6 +6020,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5857,6 +6035,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5866,6 +6045,13 @@ export declare namespace PowerPoint {
width?: boolean;
}
+
+
+
+
+
+
+
/**
* Represents the layout of a slide.
*
@@ -5877,6 +6063,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;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -5904,6 +6091,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -5920,6 +6108,7 @@ export declare namespace PowerPoint {
name?: boolean;
}
+
/**
* Represents the Slide Master of a slide.
*
@@ -5931,6 +6120,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;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -6009,6 +6199,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;
+
/**
* Gets the layout of the slide.
*
@@ -6043,30 +6234,34 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -6081,6 +6276,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6096,6 +6292,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6110,6 +6307,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6185,30 +6383,34 @@ 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;
+
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -6223,6 +6425,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6238,6 +6441,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6252,6 +6456,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6420,6 +6625,7 @@ export declare namespace PowerPoint {
*/
title?: boolean;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -6431,19 +6637,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -6465,19 +6672,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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.
@@ -6499,6 +6707,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
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
index 6efcb7b8da..ffd9e5f608 100644
--- 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
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -51,6 +51,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+
/**
* Gets the properties of the presentation.
*
@@ -168,9 +169,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -200,6 +201,7 @@ export declare namespace PowerPoint {
*/
slideMasterId?: string;
}
+
/**
* Represents the possible binding types.
*
@@ -282,9 +284,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -317,6 +319,7 @@ export declare namespace PowerPoint {
* @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`.
@@ -363,9 +366,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -414,6 +417,7 @@ export declare namespace PowerPoint {
* @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`.
@@ -444,11 +448,13 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
+
+
/**
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
*
@@ -499,6 +505,8 @@ export declare namespace PowerPoint {
*/
thaiDistributed = "ThaiDistributed",
}
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -508,6 +516,8 @@ export declare namespace PowerPoint {
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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -537,9 +547,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -565,6 +575,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -587,9 +598,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -865,9 +876,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1056,9 +1067,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1077,6 +1088,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly font: PowerPoint.ShapeFont;
+
/**
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
*
@@ -1124,6 +1136,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -1153,11 +1166,12 @@ export declare namespace PowerPoint {
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.
- */
+ * 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 a single hyperlink.
*
@@ -1181,6 +1195,10 @@ export declare namespace PowerPoint {
* [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.
*
@@ -1203,9 +1221,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1520,6 +1538,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Hyperlink[];
+
/**
* Gets the number of hyperlinks in the collection.
*
@@ -1558,9 +1577,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3102,9 +3121,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -3156,9 +3175,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
@@ -3251,9 +3270,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -3812,11 +3831,24 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -3839,6 +3871,7 @@ export declare namespace PowerPoint {
*/
width?: number;
}
+
/**
* Specifies the type of a slide layout.
*
@@ -4069,6 +4102,8 @@ export declare namespace PowerPoint {
*/
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
}
+
+
/**
* Represents the layout of a slide.
*
@@ -4078,6 +4113,7 @@ export declare namespace PowerPoint {
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.
*
@@ -4092,6 +4128,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -4135,9 +4172,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -4209,11 +4246,12 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -4223,6 +4261,7 @@ export declare namespace PowerPoint {
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.
*
@@ -4244,6 +4283,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -4280,9 +4320,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -4330,9 +4370,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -4422,9 +4462,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -4436,6 +4476,7 @@ export declare namespace PowerPoint {
export class Slide extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of custom XML parts in the slide.
*
@@ -4478,6 +4519,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+
/**
* Gets the unique ID of the slide.
*
@@ -4569,11 +4611,13 @@ export declare namespace PowerPoint {
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.
- */
+ * 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.
*
@@ -4651,9 +4695,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -4679,6 +4723,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.8]
*/
readonly shapes: PowerPoint.ShapeScopedCollection;
+
/**
* Gets the unique ID of the shape group.
*
@@ -4831,9 +4876,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -4877,6 +4922,7 @@ export declare namespace PowerPoint {
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.
*
@@ -4936,6 +4982,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4950,6 +4999,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4977,6 +5027,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -4991,6 +5042,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5013,6 +5065,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
delete(): void;
+
/**
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
*
@@ -5062,6 +5115,8 @@ export declare namespace PowerPoint {
* [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.
*
@@ -5102,9 +5157,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -5377,9 +5432,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -5430,6 +5485,7 @@ export declare namespace PowerPoint {
* 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`.
@@ -5461,9 +5517,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -5581,9 +5637,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -5641,6 +5697,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -5661,6 +5718,7 @@ export declare namespace PowerPoint {
* @param options - Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+
/**
* Gets the number of slides in the collection.
*
@@ -5720,9 +5778,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -5736,6 +5794,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Slide[];
+
/**
* Gets the number of slides in the collection.
*
@@ -5794,9 +5853,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -5868,9 +5927,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -5898,8 +5957,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -5917,17 +5982,18 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -5936,11 +6002,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -5956,11 +6022,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -5969,11 +6035,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -5996,11 +6062,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6009,11 +6075,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6022,11 +6088,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6035,11 +6101,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6230,6 +6296,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -6300,6 +6395,8 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -6307,6 +6404,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6321,6 +6419,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6328,6 +6427,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6420,6 +6520,11 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
title?: string;
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -6449,6 +6554,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -6475,8 +6584,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -6494,17 +6609,18 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6513,11 +6629,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -6533,11 +6649,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6546,11 +6662,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -6573,11 +6689,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6586,11 +6702,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6599,11 +6715,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6612,11 +6728,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -6731,6 +6847,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: string;
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -6899,6 +7016,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -6928,6 +7078,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
/**
@@ -6989,6 +7142,7 @@ export declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
export interface ShapeGroupData {
+
/**
* Gets the unique ID of the shape group.
*
@@ -7044,6 +7198,9 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -7058,6 +7215,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -7085,6 +7243,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -7099,6 +7258,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -7244,6 +7404,11 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -7270,12 +7435,13 @@ 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;
+
/**
- * Gets the properties of the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi 1.7]
- */
+ * Gets the properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
/**
* Gets the ID of the presentation.
@@ -7292,6 +7458,7 @@ export declare namespace PowerPoint {
*/
title?: boolean;
}
+
/**
* Represents a custom XML part object.
*
@@ -7372,6 +7539,7 @@ export declare namespace PowerPoint {
*/
namespaceUri?: boolean;
}
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -7383,6 +7551,8 @@ 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 if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -7416,6 +7586,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: boolean;
+
}
/**
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -7710,6 +7881,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
/**
* Represents the properties of a `placeholder` shape.
@@ -7763,6 +7935,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
@@ -7964,12 +8137,13 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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.
@@ -7980,11 +8154,11 @@ export declare namespace PowerPoint {
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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.
@@ -8004,11 +8178,14 @@ export declare namespace PowerPoint {
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @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.
*
@@ -8023,6 +8200,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8050,6 +8228,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8064,6 +8243,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8080,6 +8260,13 @@ export declare namespace PowerPoint {
*/
zOrderPosition?: boolean;
}
+
+
+
+
+
+
+
/**
* Represents the layout of a slide.
*
@@ -8091,6 +8278,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;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -8124,6 +8312,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -8146,6 +8335,7 @@ export declare namespace PowerPoint {
*/
type?: boolean;
}
+
/**
* Represents the Slide Master of a slide.
*
@@ -8157,6 +8347,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;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -8235,6 +8426,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;
+
/**
* Gets the layout of the slide.
*
@@ -8275,51 +8467,55 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -8334,6 +8530,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8361,6 +8558,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8375,6 +8573,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8409,6 +8608,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.8]
*/
shape?: PowerPoint.Interfaces.ShapeLoadOptions;
+
/**
* Gets the unique ID of the shape group.
*
@@ -8482,51 +8682,55 @@ 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;
+
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the `ShapeGroup` associated with the shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the parent group of this shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
- * Returns the properties that apply specifically to this placeholder.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -8541,6 +8745,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8568,6 +8773,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8582,6 +8788,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8807,6 +9014,7 @@ export declare namespace PowerPoint {
*/
title?: boolean;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -8818,19 +9026,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -8858,19 +9067,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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.
@@ -8898,6 +9108,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts
index a98b7e30b8..11f21e9fbc 100644
--- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts
+++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -51,6 +51,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+
/**
* Gets the properties of the presentation.
*
@@ -168,9 +169,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -200,6 +201,7 @@ export declare namespace PowerPoint {
*/
slideMasterId?: string;
}
+
/**
* Represents the possible binding types.
*
@@ -282,9 +284,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -317,6 +319,7 @@ export declare namespace PowerPoint {
* @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`.
@@ -363,9 +366,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -414,6 +417,7 @@ export declare namespace PowerPoint {
* @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`.
@@ -444,11 +448,13 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
+
+
/**
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
*
@@ -499,6 +505,8 @@ export declare namespace PowerPoint {
*/
thaiDistributed = "ThaiDistributed",
}
+
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -508,6 +516,8 @@ export declare namespace PowerPoint {
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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -537,9 +547,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -565,6 +575,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -587,9 +598,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -865,9 +876,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1056,9 +1067,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1077,6 +1088,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly font: PowerPoint.ShapeFont;
+
/**
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
*
@@ -1124,6 +1136,7 @@ export declare namespace PowerPoint {
* @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.
*
@@ -1153,11 +1166,12 @@ export declare namespace PowerPoint {
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.
- */
+ * 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 a single hyperlink.
*
@@ -1181,6 +1195,10 @@ export declare namespace PowerPoint {
* [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.
*
@@ -1203,9 +1221,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1520,6 +1538,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Hyperlink[];
+
/**
* Gets the number of hyperlinks in the collection.
*
@@ -1558,9 +1577,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -2918,9 +2937,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Borders;
/**
- * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.BordersData;
}
/**
@@ -2982,9 +3001,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Margins;
/**
- * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.MarginsData;
}
/**
@@ -3375,9 +3394,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -3429,9 +3448,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3486,9 +3505,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableColumn;
/**
- * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableColumnData;
}
/**
@@ -3559,9 +3578,9 @@ export declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
/**
- * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
}
/**
@@ -3652,9 +3671,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableRow;
/**
- * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableRowData;
}
/**
@@ -3725,9 +3744,9 @@ export declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection;
/**
- * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
}
/**
@@ -4262,9 +4281,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableStyleSettings;
/**
- * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;
}
/**
@@ -4387,9 +4406,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -4954,11 +4973,24 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -4981,6 +5013,7 @@ export declare namespace PowerPoint {
*/
width?: number;
}
+
/**
* Specifies the type of a slide layout.
*
@@ -5211,6 +5244,8 @@ export declare namespace PowerPoint {
*/
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
}
+
+
/**
* Represents the layout of a slide.
*
@@ -5220,6 +5255,7 @@ export declare namespace PowerPoint {
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.
*
@@ -5234,6 +5270,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -5277,9 +5314,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -5351,11 +5388,12 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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.
*
@@ -5365,6 +5403,7 @@ export declare namespace PowerPoint {
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.
*
@@ -5386,6 +5425,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -5422,9 +5462,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -5472,9 +5512,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -5564,9 +5604,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -5578,6 +5618,7 @@ export declare namespace PowerPoint {
export class Slide extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+
/**
* Returns a collection of custom XML parts in the slide.
*
@@ -5620,6 +5661,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+
/**
* Gets the unique ID of the slide.
*
@@ -5711,11 +5753,13 @@ export declare namespace PowerPoint {
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.
- */
+ * 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.
*
@@ -5793,9 +5837,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -5821,6 +5865,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.8]
*/
readonly shapes: PowerPoint.ShapeScopedCollection;
+
/**
* Gets the unique ID of the shape group.
*
@@ -5973,9 +6018,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -6019,6 +6064,7 @@ export declare namespace PowerPoint {
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.
*
@@ -6078,6 +6124,9 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6092,6 +6141,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6119,6 +6169,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6133,6 +6184,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6155,6 +6207,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
delete(): void;
+
/**
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
*
@@ -6204,6 +6257,8 @@ export declare namespace PowerPoint {
* [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.
*
@@ -6244,9 +6299,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -6519,9 +6574,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -6572,6 +6627,7 @@ export declare namespace PowerPoint {
* 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`.
@@ -6603,9 +6659,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -6723,9 +6779,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -6783,6 +6839,7 @@ export declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -6803,6 +6860,7 @@ export declare namespace PowerPoint {
* @param options - Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+
/**
* Gets the number of slides in the collection.
*
@@ -6862,9 +6920,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -6878,6 +6936,7 @@ export declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Slide[];
+
/**
* Gets the number of slides in the collection.
*
@@ -6936,9 +6995,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -7010,9 +7069,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -7040,8 +7099,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ export interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -7059,17 +7124,18 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7078,11 +7144,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -7098,11 +7164,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7111,11 +7177,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -7138,11 +7204,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7151,11 +7217,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7164,11 +7230,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7177,11 +7243,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7499,6 +7565,35 @@ export declare namespace PowerPoint {
/** 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 `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ export interface SlideBackgroundGradientFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ export interface SlideBackgroundPatternFillUpdateData {
+
+
+
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ export interface SlideBackgroundPictureOrTextureFillUpdateData {
+
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ export interface SlideBackgroundSolidFillUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ export interface SlideBackgroundUpdateData {
+
+
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ export interface SlideLayoutBackgroundUpdateData {
+
+
}
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
export interface SlideLayoutCollectionUpdateData {
@@ -7569,6 +7664,8 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -7576,6 +7673,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -7590,6 +7688,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -7597,6 +7696,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -7689,6 +7789,11 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
title?: string;
+ }
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ export interface PageSetupUpdateData {
+
+
}
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
export interface SlideCollectionUpdateData {
@@ -7718,6 +7823,10 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.0]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ export interface AdjustmentsData {
+
}
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
export interface CustomXmlPartData {
@@ -7744,8 +7853,14 @@ export declare namespace PowerPoint {
export interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ export interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** 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 {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -7763,17 +7878,18 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+
}
/** 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7782,11 +7898,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -7802,11 +7918,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7815,11 +7931,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -7842,11 +7958,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7855,11 +7971,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7868,11 +7984,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -7881,11 +7997,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -8000,6 +8116,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: string;
+
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
export interface PlaceholderFormatData {
@@ -8313,6 +8430,39 @@ export declare namespace PowerPoint {
/** 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 `slideBackgroundGradientFill.toJSON()`. */
+ export interface SlideBackgroundGradientFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ export interface SlideBackgroundPatternFillData {
+
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ export interface SlideBackgroundPictureOrTextureFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ export interface SlideBackgroundSolidFillData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ export interface SlideBackgroundFillData {
+
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ export interface SlideBackgroundData {
+
+
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ export interface SlideLayoutBackgroundData {
+
+
}
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
export interface SlideLayoutData {
@@ -8342,6 +8492,9 @@ export declare namespace PowerPoint {
export interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ export interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
export interface SlideMasterData {
/**
@@ -8403,6 +8556,7 @@ export declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
export interface ShapeGroupData {
+
/**
* Gets the unique ID of the shape group.
*
@@ -8458,6 +8612,9 @@ export declare namespace PowerPoint {
}
/** 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.
*
@@ -8472,6 +8629,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8499,6 +8657,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8513,6 +8672,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -8658,6 +8818,11 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
title?: string;
+ }
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ export interface PageSetupData {
+
+
}
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
export interface SlideCollectionData {
@@ -8684,12 +8849,13 @@ 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;
+
/**
- * Gets the properties of the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi 1.7]
- */
+ * Gets the properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
/**
* Gets the ID of the presentation.
@@ -8706,6 +8872,7 @@ export declare namespace PowerPoint {
*/
title?: boolean;
}
+
/**
* Represents a custom XML part object.
*
@@ -8786,6 +8953,7 @@ export declare namespace PowerPoint {
*/
namespaceUri?: boolean;
}
+
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -8797,6 +8965,8 @@ 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 if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -8830,6 +9000,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: boolean;
+
}
/**
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -9124,6 +9295,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
/**
* Represents the properties of a `placeholder` shape.
@@ -9177,6 +9349,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+
}
/**
* Represents the properties for a table cell border.
@@ -9230,46 +9403,46 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the bottom border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
bottom?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (top-left to bottom-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (bottom-left to top-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the left border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
left?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the right border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
right?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the top border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
top?: PowerPoint.Interfaces.BorderLoadOptions;
}
/**
@@ -9357,32 +9530,32 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* Gets the number of table columns this cell spans across.
@@ -9463,32 +9636,32 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
@@ -9748,11 +9921,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the table style settings.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions;
/**
* Gets the number of columns in the table.
@@ -9787,12 +9960,13 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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.
@@ -9803,11 +9977,11 @@ export declare namespace PowerPoint {
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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.
@@ -9827,11 +10001,14 @@ export declare namespace PowerPoint {
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @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.
*
@@ -9846,6 +10023,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -9873,6 +10051,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -9887,6 +10066,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -9903,6 +10083,13 @@ export declare namespace PowerPoint {
*/
zOrderPosition?: boolean;
}
+
+
+
+
+
+
+
/**
* Represents the layout of a slide.
*
@@ -9914,6 +10101,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;
+
/**
* Gets the unique ID of the slide layout.
*
@@ -9947,6 +10135,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -9969,6 +10158,7 @@ export declare namespace PowerPoint {
*/
type?: boolean;
}
+
/**
* Represents the Slide Master of a slide.
*
@@ -9980,6 +10170,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;
+
/**
* Gets the unique ID of the Slide Master.
*
@@ -10058,6 +10249,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;
+
/**
* Gets the layout of the slide.
*
@@ -10098,51 +10290,55 @@ 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;
+
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -10157,6 +10353,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -10184,6 +10381,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -10198,6 +10396,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -10232,6 +10431,7 @@ export declare namespace PowerPoint {
* [Api set: PowerPointApi 1.8]
*/
shape?: PowerPoint.Interfaces.ShapeLoadOptions;
+
/**
* Gets the unique ID of the shape group.
*
@@ -10305,51 +10505,55 @@ 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;
+
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the `ShapeGroup` associated with the shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the parent group of this shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
- * Returns the properties that apply specifically to this placeholder.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @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.
*
@@ -10364,6 +10568,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -10391,6 +10596,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -10405,6 +10611,7 @@ export declare namespace PowerPoint {
* [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.
*
@@ -10630,6 +10837,7 @@ export declare namespace PowerPoint {
*/
title?: boolean;
}
+
/**
* Represents the collection of slides in the presentation.
*
@@ -10641,19 +10849,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -10681,19 +10890,20 @@ 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;
+
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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.
@@ -10721,6 +10931,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;
+
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
diff --git a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts
index 952e40c4ce..07910dece2 100644
--- a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts
+++ b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts
@@ -19,9 +19,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -55,8 +55,7 @@ export declare namespace PowerPoint {
* Returns the page setup information whose properties control slide setup attributes for the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly pageSetup: PowerPoint.PageSetup;
/**
@@ -186,9 +185,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -222,8 +221,7 @@ export declare namespace PowerPoint {
* Represents the adjustment values for a shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class Adjustments extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -232,8 +230,7 @@ export declare namespace PowerPoint {
* Specifies the number of adjustment points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly count: number;
/**
@@ -241,8 +238,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index - The index of the adjustment to retrieve.
* @returns The adjustment value at the given index.
@@ -253,8 +249,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index - The index of the adjustment to set.
* @param value - The adjustment value to set.
@@ -282,9 +277,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Adjustments;
/**
- * 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.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.AdjustmentsData;
}
/**
@@ -369,9 +364,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -409,8 +404,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index - The index of the custom XML part in the collection.
* @returns The custom XML part at the given index.
@@ -462,9 +456,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -518,8 +512,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index - The index of the custom XML part in the collection.
* @returns The custom XML part at the given index.
@@ -555,33 +548,30 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
* Represents the available options when adding a {@link PowerPoint.Hyperlink}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface HyperlinkAddOptions {
/**
* Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
address?: string;
/**
* Specifies the string displayed when hovering over the hyperlink.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
screenTip?: string;
}
@@ -589,8 +579,7 @@ export declare namespace PowerPoint {
* Represents a scoped collection of hyperlinks.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class HyperlinkScopedCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -601,8 +590,7 @@ export declare namespace PowerPoint {
* Gets the number of hyperlinks in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
* @returns The number of hyperlinks in the collection.
*/
getCount(): OfficeExtension.ClientResult;
@@ -611,8 +599,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index - The index of the hyperlink in the collection.
* @returns The hyperlink at the given index.
@@ -637,9 +624,9 @@ export declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkScopedCollection;
/**
- * 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.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData;
}
/**
@@ -696,302 +683,259 @@ export declare namespace PowerPoint {
* Specifies the style of a bullet.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum BulletStyle {
/**
* Style is unsupported.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* Lowercase alphabetical characters with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetLowercasePeriod = "AlphabetLowercasePeriod",
/**
* Uppercase alphabetical characters with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetUppercasePeriod = "AlphabetUppercasePeriod",
/**
* Arabic numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight",
/**
* Arabic numerals with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralPeriod = "ArabicNumeralPeriod",
/**
* Lowercase Roman numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth",
/**
* Lowercase Roman numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight",
/**
* Lowercase Roman numerals with period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanLowercasePeriod = "RomanLowercasePeriod",
/**
* Uppercase Roman numerals with period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanUppercasePeriod = "RomanUppercasePeriod",
/**
* Lowercase alphabetical characters with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth",
/**
* Lowercase alphabetical characters with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight",
/**
* Uppercase alphabetical characters with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth",
/**
* Uppercase alphabetical characters with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight",
/**
* Arabic numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth",
/**
* Arabic numerals.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralPlain = "ArabicNumeralPlain",
/**
* Uppercase Roman numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth",
/**
* Uppercase Roman numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight",
/**
* Simplified Chinese without a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
simplifiedChinesePlain = "SimplifiedChinesePlain",
/**
* Simplified Chinese with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
simplifiedChinesePeriod = "SimplifiedChinesePeriod",
/**
* Double-byte circled number for values up to 10.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain",
/**
* Text colored number with same color circle drawn around it.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain",
/**
* Shadow color number with circular background of normal text color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain",
/**
* Traditional Chinese without a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
traditionalChinesePlain = "TraditionalChinesePlain",
/**
* Traditional Chinese with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
traditionalChinesePeriod = "TraditionalChinesePeriod",
/**
* Arabic alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicAlphabetDash = "ArabicAlphabetDash",
/**
* Arabic Abjad alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicAbjadDash = "ArabicAbjadDash",
/**
* Hebrew alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hebrewAlphabetDash = "HebrewAlphabetDash",
/**
* Japanese/Korean numbers without a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
kanjiKoreanPlain = "KanjiKoreanPlain",
/**
* Japanese/Korean numbers with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
kanjiKoreanPeriod = "KanjiKoreanPeriod",
/**
* Double-byte Arabic numbering scheme (no punctuation).
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicDoubleBytePlain = "ArabicDoubleBytePlain",
/**
* Double-byte Arabic numbering scheme with double-byte period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicDoubleBytePeriod = "ArabicDoubleBytePeriod",
/**
* Thai alphabet with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiAlphabetPeriod = "ThaiAlphabetPeriod",
/**
* Thai alphabet with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight",
/**
* Thai alphabet with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth",
/**
* Thai numerals with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiNumeralPeriod = "ThaiNumeralPeriod",
/**
* Thai numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight",
/**
* Thai numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth",
/**
* Hindi alphabet (vowels) with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiAlphabetPeriod = "HindiAlphabetPeriod",
/**
* Hindi numerals with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiNumeralPeriod = "HindiNumeralPeriod",
/**
* Kanji Simplified Chinese with double-byte period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod",
/**
* Hindi numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight",
/**
* Hindi alphabet (consonants) with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiAlphabet1Period = "HindiAlphabet1Period",
}
@@ -999,36 +943,31 @@ export declare namespace PowerPoint {
* Specifies the type of a bullet.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum BulletType {
/**
* Type is unsupported.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* No bullets.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
none = "None",
/**
* Numbered bullet (e.g., 1, 2, 3 or a, b, c).
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
numbered = "Numbered",
/**
* Symbol-based bullet (e.g., disc, circle, square).
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unnumbered = "Unnumbered",
}
@@ -1046,8 +985,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
/**
@@ -1055,8 +993,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
@@ -1088,9 +1025,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1120,8 +1057,7 @@ export declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel: number;
/**
@@ -1146,9 +1082,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1424,9 +1360,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1615,9 +1551,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -1640,8 +1576,7 @@ export declare namespace PowerPoint {
* Returns a collection of hyperlinks that exist on this `TextRange`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;
/**
@@ -1695,8 +1630,7 @@ export declare namespace PowerPoint {
* Sets a hyperlink on this `TextRange` with the specified options. This will delete all existing hyperlinks on this `TextRange`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options - Optional. The options for the hyperlink.
* @returns The newly created {@link PowerPoint.Hyperlink} object.
@@ -1731,31 +1665,28 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
* Specifies the type of object that a hyperlink is applied to.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum HyperlinkType {
/**
* Specifies that the hyperlink is applied to a TextRange.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
textRange = "TextRange",
/**
* Specifies that the hyperlink is applied to a Shape.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
shape = "Shape",
}
@@ -1786,16 +1717,14 @@ export declare namespace PowerPoint {
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";
/**
* Deletes the hyperlink.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
delete(): void;
/**
@@ -1804,8 +1733,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.10]
*/
getLinkedShapeOrNullObject(): PowerPoint.Shape;
/**
@@ -1814,8 +1742,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.10]
*/
getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;
/**
@@ -1840,9 +1767,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2141,9 +2068,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -2162,8 +2089,7 @@ export declare namespace PowerPoint {
The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param target - The target to add the hyperlink to. Can be a {@link PowerPoint.TextRange} or a {@link PowerPoint.Shape}.
* @param options - Optional. The options for the hyperlink.
@@ -2208,9 +2134,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -3568,9 +3494,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Borders;
/**
- * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.BordersData;
}
/**
@@ -3632,9 +3558,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Margins;
/**
- * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.MarginsData;
}
/**
@@ -4025,9 +3951,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -4079,9 +4005,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -4136,9 +4062,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableColumn;
/**
- * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableColumnData;
}
/**
@@ -4209,9 +4135,9 @@ export declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
/**
- * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
}
/**
@@ -4302,9 +4228,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableRow;
/**
- * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableRowData;
}
/**
@@ -4375,9 +4301,9 @@ export declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection;
/**
- * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
}
/**
@@ -4912,9 +4838,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableStyleSettings;
/**
- * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;
}
/**
@@ -5037,9 +4963,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -5604,59 +5530,52 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
* Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum SlideBackgroundGradientFillType {
/**
* Unsupported gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* Linear gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
linear = "Linear",
/**
* Radial gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
radial = "Radial",
/**
* Rectangular gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rectangular = "Rectangular",
/**
* Path gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
path = "Path",
/**
* Shade from title gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
shadeFromTitle = "ShadeFromTitle",
}
@@ -5664,8 +5583,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideBackgroundGradientFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -5674,8 +5592,7 @@ export declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
/**
@@ -5700,25 +5617,23 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundGradientFill;
/**
- * 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.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;
}
/**
* Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundGradientFillOptions {
/**
* If provided, specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
}
@@ -5726,393 +5641,337 @@ export declare namespace PowerPoint {
* Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum SlideBackgroundPatternFillType {
/**
* Unsupported pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* 5 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent5 = "Percent5",
/**
* 10 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent10 = "Percent10",
/**
* 20 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent20 = "Percent20",
/**
* 25 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent25 = "Percent25",
/**
* 30 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent30 = "Percent30",
/**
* 40 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent40 = "Percent40",
/**
* 50 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent50 = "Percent50",
/**
* 60 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent60 = "Percent60",
/**
* 70 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent70 = "Percent70",
/**
* 75 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent75 = "Percent75",
/**
* 80 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent80 = "Percent80",
/**
* 90 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent90 = "Percent90",
/**
* Horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
horizontal = "Horizontal",
/**
* Vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
vertical = "Vertical",
/**
* Light horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightHorizontal = "LightHorizontal",
/**
* Light vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightVertical = "LightVertical",
/**
* Dark horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkHorizontal = "DarkHorizontal",
/**
* Dark vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkVertical = "DarkVertical",
/**
* Narrow horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
narrowHorizontal = "NarrowHorizontal",
/**
* Narrow vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
narrowVertical = "NarrowVertical",
/**
* Dashed horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedHorizontal = "DashedHorizontal",
/**
* Dashed vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedVertical = "DashedVertical",
/**
* Cross pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
cross = "Cross",
/**
* Downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
downwardDiagonal = "DownwardDiagonal",
/**
* Upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
upwardDiagonal = "UpwardDiagonal",
/**
* Light downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightDownwardDiagonal = "LightDownwardDiagonal",
/**
* Light upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightUpwardDiagonal = "LightUpwardDiagonal",
/**
* Dark downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkDownwardDiagonal = "DarkDownwardDiagonal",
/**
* Dark upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkUpwardDiagonal = "DarkUpwardDiagonal",
/**
* Wide downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
wideDownwardDiagonal = "WideDownwardDiagonal",
/**
* Wide upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
wideUpwardDiagonal = "WideUpwardDiagonal",
/**
* Dashed downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedDownwardDiagonal = "DashedDownwardDiagonal",
/**
* Dashed upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedUpwardDiagonal = "DashedUpwardDiagonal",
/**
* Diagonal cross pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
diagonalCross = "DiagonalCross",
/**
* Small checker board pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
smallCheckerBoard = "SmallCheckerBoard",
/**
* Large checker board pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
largeCheckerBoard = "LargeCheckerBoard",
/**
* Small grid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
smallGrid = "SmallGrid",
/**
* Large grid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
largeGrid = "LargeGrid",
/**
* Dotted grid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dottedGrid = "DottedGrid",
/**
* Small confetti pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
smallConfetti = "SmallConfetti",
/**
* Large confetti pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
largeConfetti = "LargeConfetti",
/**
* Horizontal brick pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
horizontalBrick = "HorizontalBrick",
/**
* Diagonal brick pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
diagonalBrick = "DiagonalBrick",
/**
* Solid diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
solidDiamond = "SolidDiamond",
/**
* Outlined diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
outlinedDiamond = "OutlinedDiamond",
/**
* Dotted diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dottedDiamond = "DottedDiamond",
/**
* Plaid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
plaid = "Plaid",
/**
* Sphere pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
sphere = "Sphere",
/**
* Weave pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
weave = "Weave",
/**
* Divot pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
divot = "Divot",
/**
* Shingle pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
shingle = "Shingle",
/**
* Wave pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
wave = "Wave",
/**
* Trellis pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
trellis = "Trellis",
/**
* Zig zag pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
zigZag = "ZigZag",
}
@@ -6120,8 +5979,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideBackgroundPatternFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -6130,24 +5988,21 @@ export declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor: string;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor: string;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
/**
@@ -6172,41 +6027,37 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundPatternFill;
/**
- * 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.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;
}
/**
* Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundPatternFillOptions {
/**
* If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: string;
/**
* If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: string;
/**
* If provided, specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
}
@@ -6214,8 +6065,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideBackgroundPictureOrTextureFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -6224,16 +6074,14 @@ export declare namespace PowerPoint {
* 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.10]
*/
transparency: number;
/**
* Sets the image used to fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param base64EncodedImage - A string that is a Base64 encoding of the image data.
*/
@@ -6260,33 +6108,30 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundPictureOrTextureFill;
/**
- * 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.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;
}
/**
* Represents {@link PowerPoint.SlideBackground} picture or texture fill options.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundPictureOrTextureFillOptions {
/**
* If provided, specifies the Base64-encoded image data for the fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
imageBase64?: string;
/**
* If provided, 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.10]
*/
transparency: number;
}
@@ -6294,43 +6139,37 @@ export declare namespace PowerPoint {
* Specifies the fill type for a {@link PowerPoint.SlideBackground}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum SlideBackgroundFillType {
/**
* Unsupported slide background fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* Specifies that the slide background should have regular solid fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
solid = "Solid",
/**
* Specifies that the slide background should have gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
gradient = "Gradient",
/**
* Specifies that the slide background should have picture or texture fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pictureOrTexture = "PictureOrTexture",
/**
* Specifies that the slide background should have pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern = "Pattern",
}
@@ -6338,8 +6177,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideBackgroundSolidFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -6348,16 +6186,14 @@ export declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color: string;
/**
* 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.10]
*/
transparency: number;
/**
@@ -6382,33 +6218,30 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundSolidFill;
/**
- * 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.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;
}
/**
* Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundSolidFillOptions {
/**
* If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: string;
/**
* If provided, 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.10]
*/
transparency?: number;
}
@@ -6416,8 +6249,7 @@ export declare namespace PowerPoint {
* Represents the fill formatting of a slide background object.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideBackgroundFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -6426,8 +6258,7 @@ export declare namespace PowerPoint {
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
/**
@@ -6435,8 +6266,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.10]
*/
getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;
/**
@@ -6444,8 +6274,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.10]
*/
getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;
/**
@@ -6453,8 +6282,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.10]
*/
getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;
/**
@@ -6462,16 +6290,14 @@ 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.10]
*/
getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;
/**
* Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options - Options for the gradient fill.
*/
@@ -6480,8 +6306,7 @@ export declare namespace PowerPoint {
* Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options - Options for the pattern fill.
*/
@@ -6490,8 +6315,7 @@ export declare namespace PowerPoint {
* Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options - Options for the picture or texture fill.
*/
@@ -6500,8 +6324,7 @@ export declare namespace PowerPoint {
* Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options - Options for the solid fill.
*/
@@ -6528,17 +6351,16 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundFill;
/**
- * 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.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;
}
/**
* Represents a background of a slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideBackground extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -6547,32 +6369,28 @@ export declare namespace PowerPoint {
* Returns the fill formatting of the background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly fill: PowerPoint.SlideBackgroundFill;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed: boolean;
/**
* Resets the fill formatting of the slide background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
reset(): void;
/**
@@ -6597,9 +6415,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackground;
/**
- * 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.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundData;
}
/**
@@ -6628,8 +6446,7 @@ export declare namespace PowerPoint {
* Represents the background of a slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideLayoutBackground extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -6638,32 +6455,28 @@ export declare namespace PowerPoint {
* Returns the fill formatting of the background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly fill: PowerPoint.SlideBackgroundFill;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed: boolean;
/**
* Resets the fill formatting of the slide layout background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
reset(): void;
/**
@@ -6688,9 +6501,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideLayoutBackground;
/**
- * 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.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;
}
/**
@@ -6927,106 +6740,91 @@ export declare namespace PowerPoint {
* Specifies the theme colors used in PowerPoint.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum ThemeColor {
/**
* Specifies a mixed theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
mixed = "Mixed",
/**
* Specifies no theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
none = "None",
/**
* Specifies the Accent 1 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent1 = "Accent1",
/**
* Specifies the Accent 2 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent2 = "Accent2",
/**
* Specifies the Accent 3 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent3 = "Accent3",
/**
* Specifies the Accent 4 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent4 = "Accent4",
/**
* Specifies the Accent 5 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent5 = "Accent5",
/**
* Specifies the Accent 6 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent6 = "Accent6",
/**
* Specifies the Dark 1 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dark1 = "Dark1",
/**
* Specifies the Dark 2 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dark2 = "Dark2",
/**
* Specifies the clicked hyperlink theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
followedHyperlink = "FollowedHyperlink",
/**
* Specifies the hyperlink theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hyperlink = "Hyperlink",
/**
* Specifies the Light 1 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
light1 = "Light1",
/**
* Specifies the Light 2 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
light2 = "Light2",
}
@@ -7034,8 +6832,7 @@ export declare namespace PowerPoint {
* Represents a theme color scheme.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class ThemeColorScheme extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -7044,8 +6841,7 @@ export declare namespace PowerPoint {
* Gets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color - The theme color.
* @returns The color value in #RRGGBB format (e.g., "FFA500").
@@ -7055,8 +6851,7 @@ export declare namespace PowerPoint {
* Gets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color - The theme color.
* @returns The color value in #RRGGBB format (e.g., "FFA500").
@@ -7066,8 +6861,7 @@ export declare namespace PowerPoint {
* Sets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color - The theme color.
* @param rgbColor - The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
@@ -7077,17 +6871,16 @@ export declare namespace PowerPoint {
* Sets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color - The theme color.
* @param rgbColor - The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
*/
setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;
/**
- * 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.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): {
[key: string]: string;
};
@@ -7105,8 +6898,7 @@ export declare namespace PowerPoint {
* Gets the background of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly background: PowerPoint.SlideLayoutBackground;
/**
@@ -7127,8 +6919,7 @@ export declare namespace PowerPoint {
* Returns the `ThemeColorScheme` of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
@@ -7174,9 +6965,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -7248,17 +7039,16 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 background of a slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class SlideMasterBackground extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -7267,8 +7057,7 @@ export declare namespace PowerPoint {
* Returns the fill formatting of the background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly fill: PowerPoint.SlideBackgroundFill;
/**
@@ -7293,9 +7082,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideMasterBackground;
/**
- * 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.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData;
}
/**
@@ -7311,8 +7100,7 @@ export declare namespace PowerPoint {
* Gets the background of the Slide Master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly background: PowerPoint.SlideMasterBackground;
/**
@@ -7340,8 +7128,7 @@ export declare namespace PowerPoint {
* Returns the `ThemeColorScheme` of the Slide Master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
@@ -7380,9 +7167,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -7430,9 +7217,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -7522,9 +7309,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -7540,8 +7327,7 @@ export declare namespace PowerPoint {
* Gets the background of the slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly background: PowerPoint.SlideBackground;
/**
@@ -7590,8 +7376,7 @@ export declare namespace PowerPoint {
* Returns the `ThemeColorScheme` of the slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
@@ -7685,24 +7470,22 @@ export declare namespace PowerPoint {
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.
- */
+ * 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 the format of an image.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum ShapeGetImageFormatType {
/**
* The picture is in PNG format.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
png = "Png",
}
@@ -7713,16 +7496,14 @@ export declare namespace PowerPoint {
The resulting dimensions will automatically be clamped to the maximum supported size if too large.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface ShapeGetImageOptions {
/**
* The desired format of the resulting image.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
format?: PowerPoint.ShapeGetImageFormatType | "Png";
/**
@@ -7730,8 +7511,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a non-positive integer.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
height?: number;
/**
@@ -7739,8 +7519,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a non-positive integer.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
width?: number;
}
@@ -7821,9 +7600,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -7853,8 +7632,7 @@ export declare namespace PowerPoint {
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly creationId: string | null;
/**
@@ -7893,9 +7671,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -8009,9 +7787,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -8059,8 +7837,7 @@ export declare namespace PowerPoint {
* Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly adjustments: PowerPoint.Adjustments;
/**
@@ -8129,8 +7906,7 @@ export declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription: string;
/**
@@ -8141,16 +7917,14 @@ export declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle: string;
/**
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly creationId: string | null;
/**
@@ -8174,8 +7948,7 @@ export declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative: boolean;
/**
@@ -8210,8 +7983,7 @@ export declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation: number;
/**
@@ -8232,8 +8004,7 @@ export declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible: boolean;
/**
@@ -8262,8 +8033,7 @@ export declare namespace PowerPoint {
* Renders an image of the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options - Optional. Options to specify the desired output image properties.
* @returns A Base64-encoded string of the shape image in the specified format.
@@ -8323,16 +8093,14 @@ 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.10]
*/
getTextFrameOrNullObject(): PowerPoint.TextFrame;
/**
* Sets a hyperlink on this `Shape` with the specified options. This will delete any existing hyperlink on this `Shape`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options - Optional. The options for the hyperlink.
* @returns The newly created {@link PowerPoint.Hyperlink} object.
@@ -8378,9 +8146,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -8442,9 +8210,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -8556,9 +8324,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -8653,9 +8421,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -8711,8 +8479,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index - The index of the custom property in the collection.
* @returns The custom property at the given index.
@@ -8749,9 +8516,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -8869,9 +8636,9 @@ export declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -8933,8 +8700,7 @@ export declare namespace PowerPoint {
* Represents the page setup information for the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export class PageSetup extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -8943,16 +8709,14 @@ export declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight: number;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth: number;
/**
@@ -8977,9 +8741,9 @@ export declare namespace PowerPoint {
expand?: string;
}): PowerPoint.PageSetup;
/**
- * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.PageSetupData;
}
/**
@@ -9007,8 +8771,7 @@ export declare namespace PowerPoint {
Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param values - An array of slide IDs or `Slide` objects.
* @returns A Base64-encoded string.
@@ -9073,9 +8836,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -9093,8 +8856,7 @@ export declare namespace PowerPoint {
* Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
* @returns A Base64-encoded string.
*/
exportAsBase64Presentation(): OfficeExtension.ClientResult;
@@ -9156,9 +8918,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -9230,9 +8992,9 @@ export declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -9271,8 +9033,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
/**
@@ -9280,8 +9041,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
@@ -9305,8 +9065,7 @@ export declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel?: number;
}
@@ -9315,11 +9074,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -9328,11 +9087,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -9348,11 +9107,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -9361,11 +9120,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -9388,11 +9147,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -9401,11 +9160,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -9414,11 +9173,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -9427,11 +9186,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -9756,8 +9515,7 @@ export declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
}
@@ -9767,24 +9525,21 @@ export declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: string;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: string;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
}
@@ -9794,8 +9549,7 @@ export declare namespace PowerPoint {
* 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.10]
*/
transparency?: number;
}
@@ -9805,16 +9559,14 @@ export declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: string;
/**
* 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.10]
*/
transparency?: number;
}
@@ -9824,16 +9576,14 @@ export declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -9843,16 +9593,14 @@ export declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -9932,8 +9680,7 @@ export declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: string;
/**
@@ -9944,8 +9691,7 @@ export declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: string;
/**
@@ -9962,8 +9708,7 @@ export declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -9985,8 +9730,7 @@ export declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: number;
/**
@@ -10000,8 +9744,7 @@ export declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -10103,16 +9846,14 @@ export declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight?: number;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth?: number;
}
@@ -10151,8 +9892,7 @@ export declare namespace PowerPoint {
* Specifies the number of adjustment points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
count?: number;
}
@@ -10192,8 +9932,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
/**
@@ -10201,8 +9940,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
@@ -10226,8 +9964,7 @@ export declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel?: number;
}
@@ -10236,11 +9973,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -10249,11 +9986,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -10269,11 +10006,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -10282,11 +10019,11 @@ export declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -10309,11 +10046,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -10322,11 +10059,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -10335,11 +10072,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -10348,11 +10085,11 @@ export declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -10471,8 +10208,7 @@ export declare namespace PowerPoint {
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";
}
@@ -10795,8 +10531,7 @@ export declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
}
@@ -10806,24 +10541,21 @@ export declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: string;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: string;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
}
@@ -10833,8 +10565,7 @@ export declare namespace PowerPoint {
* 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.10]
*/
transparency?: number;
}
@@ -10844,16 +10575,14 @@ export declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: string;
/**
* 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.10]
*/
transparency?: number;
}
@@ -10863,8 +10592,7 @@ export declare namespace PowerPoint {
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
}
@@ -10874,16 +10602,14 @@ export declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -10893,16 +10619,14 @@ export declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -11002,8 +10726,7 @@ export declare namespace PowerPoint {
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: string | null;
/**
@@ -11068,8 +10791,7 @@ export declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: string;
/**
@@ -11080,16 +10802,14 @@ export declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: string;
/**
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: string | null;
/**
@@ -11113,8 +10833,7 @@ export declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -11149,8 +10868,7 @@ export declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: number;
/**
@@ -11171,8 +10889,7 @@ export declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -11327,16 +11044,14 @@ export declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight?: number;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth?: number;
}
@@ -11366,19 +11081,18 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the page setup information whose properties control slide setup attributes for the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the page setup information whose properties control slide setup attributes for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;
/**
- * Gets the properties of the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi 1.7]
- */
+ * Gets the properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
/**
* Gets the ID of the presentation.
@@ -11399,8 +11113,7 @@ export declare namespace PowerPoint {
* Represents the adjustment values for a shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface AdjustmentsLoadOptions {
/**
@@ -11411,8 +11124,7 @@ export declare namespace PowerPoint {
* Specifies the number of adjustment points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
count?: boolean;
}
@@ -11500,8 +11212,7 @@ export declare namespace PowerPoint {
* Represents a scoped collection of hyperlinks.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface HyperlinkScopedCollectionLoadOptions {
/**
@@ -11526,8 +11237,7 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -11547,8 +11257,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style?: boolean;
/**
@@ -11556,8 +11265,7 @@ export declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
/**
@@ -11597,8 +11305,7 @@ export declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel?: boolean;
}
@@ -11899,8 +11606,7 @@ export declare namespace PowerPoint {
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -11960,8 +11666,7 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -12017,46 +11722,46 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the bottom border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
bottom?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (top-left to bottom-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (bottom-left to top-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the left border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
left?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the right border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
right?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the top border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
top?: PowerPoint.Interfaces.BorderLoadOptions;
}
/**
@@ -12144,32 +11849,32 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* Gets the number of table columns this cell spans across.
@@ -12250,32 +11955,32 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
@@ -12535,11 +12240,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the table style settings.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions;
/**
* Gets the number of columns in the table.
@@ -12575,57 +12280,56 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
/**
* For EACH ITEM in the collection: The alt text description of the Shape.
@@ -12634,8 +12338,7 @@ export declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: boolean;
/**
@@ -12646,16 +12349,14 @@ export declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: boolean;
/**
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -12679,8 +12380,7 @@ export declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -12715,8 +12415,7 @@ export declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: boolean;
/**
@@ -12737,8 +12436,7 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -12761,8 +12459,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundGradientFillLoadOptions {
/**
@@ -12773,8 +12470,7 @@ export declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -12782,8 +12478,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundPatternFillLoadOptions {
/**
@@ -12794,24 +12489,21 @@ export declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: boolean;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: boolean;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: boolean;
}
@@ -12819,8 +12511,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundPictureOrTextureFillLoadOptions {
/**
@@ -12831,8 +12522,7 @@ export declare namespace PowerPoint {
* 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.10]
*/
transparency?: boolean;
}
@@ -12840,8 +12530,7 @@ export declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundSolidFillLoadOptions {
/**
@@ -12852,16 +12541,14 @@ export declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: boolean;
/**
* 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.10]
*/
transparency?: boolean;
}
@@ -12869,8 +12556,7 @@ export declare namespace PowerPoint {
* Represents the fill formatting of a slide background object.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundFillLoadOptions {
/**
@@ -12881,8 +12567,7 @@ export declare namespace PowerPoint {
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -12890,8 +12575,7 @@ export declare namespace PowerPoint {
* Represents a background of a slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideBackgroundLoadOptions {
/**
@@ -12899,27 +12583,24 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the fill formatting of the background.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -12927,8 +12608,7 @@ export declare namespace PowerPoint {
* Represents the background of a slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideLayoutBackgroundLoadOptions {
/**
@@ -12936,27 +12616,24 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the fill formatting of the background.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -12972,12 +12649,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the background of the slide layout.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
/**
* Gets the unique ID of the slide layout.
@@ -13013,12 +12689,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the slide layout.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
@@ -13046,8 +12721,7 @@ export declare namespace PowerPoint {
* Represents the background of a slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface SlideMasterBackgroundLoadOptions {
/**
@@ -13055,12 +12729,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the fill formatting of the background.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
}
/**
@@ -13075,12 +12748,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the background of the Slide Master.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
/**
* Gets the unique ID of the Slide Master.
@@ -13161,12 +12833,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the background of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
/**
* Gets the layout of the slide.
@@ -13209,57 +12880,56 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
/**
* For EACH ITEM in the collection: The alt text description of the Shape.
@@ -13268,8 +12938,7 @@ export declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: boolean;
/**
@@ -13280,16 +12949,14 @@ export declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: boolean;
/**
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -13313,8 +12980,7 @@ export declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -13349,8 +13015,7 @@ export declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: boolean;
/**
@@ -13371,8 +13036,7 @@ export declare namespace PowerPoint {
* For EACH ITEM in the collection: Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -13413,8 +13077,7 @@ export declare namespace PowerPoint {
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -13494,54 +13157,53 @@ export declare namespace PowerPoint {
* Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the `ShapeGroup` associated with the shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the parent group of this shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
- * Returns the properties that apply specifically to this placeholder.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
/**
* The alt text description of the Shape.
@@ -13550,8 +13212,7 @@ export declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: boolean;
/**
@@ -13562,16 +13223,14 @@ export declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: boolean;
/**
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -13595,8 +13254,7 @@ export declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -13631,8 +13289,7 @@ export declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: boolean;
/**
@@ -13653,8 +13310,7 @@ export declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -13886,8 +13542,7 @@ export declare namespace PowerPoint {
* Represents the page setup information for the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
export interface PageSetupLoadOptions {
/**
@@ -13898,16 +13553,14 @@ export declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight?: boolean;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth?: boolean;
}
@@ -13923,26 +13576,25 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -13971,26 +13623,25 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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.
@@ -14019,12 +13670,11 @@ export declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the Slide Master.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
diff --git a/generate-docs/configs/powerpoint-1_10-config.json b/generate-docs/configs/powerpoint-1_10-config.json
new file mode 100644
index 0000000000..ae0b53f6a1
--- /dev/null
+++ b/generate-docs/configs/powerpoint-1_10-config.json
@@ -0,0 +1,35 @@
+{
+ "excludedFieldPatterns": [
+ "\\w+\\??:\\s*\".*\""
+ ],
+ "excludedFieldNames": [
+ "load",
+ "set",
+ "toJSON",
+ "context",
+ "track",
+ "untrack"
+ ],
+ "excludedClassPatterns": [
+ "LoadOptions$",
+ "Data$"
+ ],
+ "includeStaticFields": false,
+ "includeEnums": false,
+ "filterUnionAdditions": true,
+ "linkConfigs": [
+ {
+ "pathPattern": "javascript/api/powerpoint",
+ "description": "Standard URL pattern for PowerPoint APIs",
+ "globalFunctionTemplate": "/javascript/api/powerpoint/powerpoint#{fieldName}",
+ "interfaceMemberTemplate": "/javascript/api/powerpoint/powerpoint.{className}#powerpoint-powerpoint-{className}-{fieldName}{suffix}",
+ "classMemberTemplate": "/javascript/api/powerpoint/powerpoint.{className}#powerpoint-powerpoint-{className}-{fieldName}{suffix}",
+ "typeAliasTemplate": "/javascript/api/powerpoint/powerpoint.{className}",
+ "name": "PowerPoint Standard Pattern",
+ "classTemplate": "/javascript/api/powerpoint/powerpoint.{className}",
+ "interfaceTemplate": "/javascript/api/powerpoint/powerpoint.{className}",
+ "enumMemberTemplate": "/javascript/api/powerpoint/powerpoint.{className}#powerpoint-powerpoint-{className}-{fieldName}",
+ "enumTemplate": "/javascript/api/powerpoint/powerpoint.{className}"
+ }
+ ]
+}
diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts
index 0585ec0dc7..fa71471c7b 100644
--- a/generate-docs/script-inputs/office.d.ts
+++ b/generate-docs/script-inputs/office.d.ts
@@ -177883,9 +177883,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -177915,6 +177915,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.7]
*/
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
+ /**
+ * Returns the page setup information whose properties control slide setup attributes for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly pageSetup: PowerPoint.PageSetup;
/**
* Gets the properties of the presentation.
*
@@ -178032,9 +178039,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -178064,6 +178071,71 @@ declare namespace PowerPoint {
*/
slideMasterId?: string;
}
+ /**
+ * Represents the adjustment values for a shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class Adjustments 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 number of adjustment points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly count: number;
+ /**
+ * Gets the adjustment value at the specified zero-based index.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index The index of the adjustment to retrieve.
+ * @returns The adjustment value at the given index.
+ */
+ get(index: number): OfficeExtension.ClientResult;
+ /**
+ * Sets the adjustment value at the specified zero-based index.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index The index of the adjustment to set.
+ * @param value The adjustment value to set.
+ */
+ set(index: number, value: number): 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.AdjustmentsLoadOptions): PowerPoint.Adjustments;
+ /**
+ * 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.Adjustments;
+ /**
+ * 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.Adjustments;
+ /**
+ * 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.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.AdjustmentsData;
+ }
/**
* Represents the possible binding types.
*
@@ -178146,9 +178218,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -178181,6 +178253,17 @@ declare namespace PowerPoint {
* @param id ID of the object to be retrieved.
*/
getItem(id: string): PowerPoint.CustomXmlPart;
+ /**
+ * Gets a `CustomXmlPart` by its zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index The index of the custom XML part in the collection.
+ * @returns The custom XML part at the given index.
+ */
+ getItemAt(index: number): 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`.
@@ -178227,9 +178310,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -178278,6 +178361,17 @@ declare namespace PowerPoint {
* @param id ID of the object to be retrieved.
*/
getItem(id: string): PowerPoint.CustomXmlPart;
+ /**
+ * Gets a `CustomXmlPart` by its zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index The index of the custom XML part in the collection.
+ * @returns The custom XML part at the given index.
+ */
+ getItemAt(index: number): 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`.
@@ -178308,11 +178402,87 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
+ /**
+ * Represents the available options when adding a {@link PowerPoint.Hyperlink}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface HyperlinkAddOptions {
+ /**
+ * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ address?: string;
+ /**
+ * Specifies the string displayed when hovering over the hyperlink.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ screenTip?: string;
+ }
+ /**
+ * Represents a scoped collection of hyperlinks.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class HyperlinkScopedCollection 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.10]
+ * @returns The number of hyperlinks in the collection.
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets a hyperlink using its zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index The index of the hyperlink in the collection.
+ * @returns The hyperlink at the given index.
+ */
+ 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.HyperlinkScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkScopedCollection;
+ /**
+ * 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.HyperlinkScopedCollection;
+ /**
+ * 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.HyperlinkScopedCollection;
+ /**
+ * 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.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData;
+ }
/**
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
*
@@ -178364,1000 +178534,981 @@ declare namespace PowerPoint {
thaiDistributed = "ThaiDistributed",
}
/**
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
+ * Specifies the style of a bullet.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- 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;
+ enum BulletStyle {
/**
- * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
- *
+ * Style is unsupported.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- visible: boolean | null;
+ unsupported = "Unsupported",
/**
- * 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.
+ * Lowercase alphabetical characters with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
+ alphabetLowercasePeriod = "AlphabetLowercasePeriod",
/**
- * 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.
+ * Uppercase alphabetical characters with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
+ alphabetUppercasePeriod = "AlphabetUppercasePeriod",
/**
- * 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.
+ * Arabic numerals with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.BulletFormat;
+ arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight",
/**
- * 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.
+ * Arabic numerals with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- 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]
- */
- 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;
+ arabicNumeralPeriod = "ArabicNumeralPeriod",
/**
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
- *
+ * Lowercase Roman numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly bulletFormat: PowerPoint.BulletFormat;
+ romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth",
/**
- * 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.
- *
+ * Lowercase Roman numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+ romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight",
/**
- * 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.
+ * Lowercase Roman numerals with period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
+ romanLowercasePeriod = "RomanLowercasePeriod",
/**
- * 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.
+ * Uppercase Roman numerals with period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
+ romanUppercasePeriod = "RomanUppercasePeriod",
/**
- * 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.
+ * Lowercase alphabetical characters with both parentheses.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.ParagraphFormat;
+ alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth",
/**
- * 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.
+ * Lowercase alphabetical characters with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
- }
- /**
- * The type of underline applied to a font.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- enum ShapeFontUnderlineStyle {
+ alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight",
/**
- * No underlining.
+ * Uppercase alphabetical characters with both parentheses.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- none = "None",
+ alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth",
/**
- * Regular single line underlining.
+ * Uppercase alphabetical characters with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- single = "Single",
+ alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight",
/**
- * Underlining of text with double lines.
+ * Arabic numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- double = "Double",
+ arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth",
/**
- * Underlining of text with a thick line.
+ * Arabic numerals.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- heavy = "Heavy",
+ arabicNumeralPlain = "ArabicNumeralPlain",
/**
- * Underlining of text with a dotted line.
+ * Uppercase Roman numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dotted = "Dotted",
+ romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth",
/**
- * Underlining of text with a thick, dotted line.
+ * Uppercase Roman numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dottedHeavy = "DottedHeavy",
+ romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight",
/**
- * Underlining of text with a line containing dashes.
+ * Simplified Chinese without a period.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dash = "Dash",
+ simplifiedChinesePlain = "SimplifiedChinesePlain",
/**
- * Underlining of text with a thick line containing dashes.
+ * Simplified Chinese with a period.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dashHeavy = "DashHeavy",
+ simplifiedChinesePeriod = "SimplifiedChinesePeriod",
/**
- * Underlining of text with a line containing long dashes.
+ * Double-byte circled number for values up to 10.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dashLong = "DashLong",
+ circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain",
/**
- * Underlining of text with a thick line containing long dashes.
+ * Text colored number with same color circle drawn around it.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dashLongHeavy = "DashLongHeavy",
+ circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain",
/**
- * Underlining of text with a line containing dots and dashes.
+ * Shadow color number with circular background of normal text color.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dotDash = "DotDash",
+ circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain",
/**
- * Underlining of text with a thick line containing dots and dashes.
+ * Traditional Chinese without a period.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dotDashHeavy = "DotDashHeavy",
+ traditionalChinesePlain = "TraditionalChinesePlain",
/**
- * Underlining of text with a line containing double dots and dashes.
+ * Traditional Chinese with a period.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dotDotDash = "DotDotDash",
+ traditionalChinesePeriod = "TraditionalChinesePeriod",
/**
- * Underlining of text with a thick line containing double dots and dashes.
+ * Arabic alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- dotDotDashHeavy = "DotDotDashHeavy",
+ arabicAlphabetDash = "ArabicAlphabetDash",
/**
- * Underlining of text with a wavy line.
+ * Arabic Abjad alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- wavy = "Wavy",
+ arabicAbjadDash = "ArabicAbjadDash",
/**
- * Underlining of text with a thick, wavy line.
+ * Hebrew alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- wavyHeavy = "WavyHeavy",
+ hebrewAlphabetDash = "HebrewAlphabetDash",
/**
- * Underlining of text with double wavy lines.
+ * Japanese/Korean numbers without a period.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- 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]
- */
- 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;
+ kanjiKoreanPlain = "KanjiKoreanPlain",
/**
- * 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.
- *
+ * Japanese/Korean numbers with a period.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- allCaps: boolean | null;
+ kanjiKoreanPeriod = "KanjiKoreanPeriod",
/**
- * 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.
- *
+ * Double-byte Arabic numbering scheme (no punctuation).
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- bold: boolean | null;
+ arabicDoubleBytePlain = "ArabicDoubleBytePlain",
/**
- * 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.
- *
+ * Double-byte Arabic numbering scheme with double-byte period.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- color: string | null;
+ arabicDoubleBytePeriod = "ArabicDoubleBytePeriod",
/**
- * 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.
- *
+ * Thai alphabet with a period.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- doubleStrikethrough: boolean | null;
+ thaiAlphabetPeriod = "ThaiAlphabetPeriod",
/**
- * 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.
- *
+ * Thai alphabet with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- italic: boolean | null;
+ thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight",
/**
- * 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.
- *
+ * Thai alphabet with both parentheses.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- name: string | null;
+ thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth",
/**
- * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
- *
+ * Thai numerals with a period.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- size: number | null;
+ thaiNumeralPeriod = "ThaiNumeralPeriod",
/**
- * 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.
- *
+ * Thai numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- smallCaps: boolean | null;
+ thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight",
/**
- * 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.
- *
+ * Thai numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- strikethrough: boolean | null;
+ thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth",
/**
- * 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.
- *
+ * Hindi alphabet (vowels) with a period.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- subscript: boolean | null;
+ hindiAlphabetPeriod = "HindiAlphabetPeriod",
/**
- * 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.
- *
+ * Hindi numerals with a period.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- superscript: boolean | null;
+ hindiNumeralPeriod = "HindiNumeralPeriod",
/**
- * 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.
- *
+ * Kanji Simplified Chinese with double-byte period.
* @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.
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
+ kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod",
/**
- * 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.
+ * Hindi numerals with closing parenthesis.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.ShapeFont;
+ hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight",
/**
- * 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.
+ * Hindi alphabet (consonants) with a period.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- toJSON(): PowerPoint.Interfaces.ShapeFontData;
+ hindiAlphabet1Period = "HindiAlphabet1Period",
}
/**
- * Determines the type of automatic sizing allowed.
+ * Specifies the type of a bullet.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- enum ShapeAutoSize {
+ enum BulletType {
/**
- * No autosizing.
+ * Type is unsupported.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- autoSizeNone = "AutoSizeNone",
+ unsupported = "Unsupported",
/**
- * The text is adjusted to fit the shape.
+ * No bullets.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- autoSizeTextToFitShape = "AutoSizeTextToFitShape",
+ none = "None",
/**
- * The shape is adjusted to fit the text.
+ * Numbered bullet (e.g., 1, 2, 3 or a, b, c).
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- autoSizeShapeToFitText = "AutoSizeShapeToFitText",
+ numbered = "Numbered",
/**
- * A combination of automatic sizing schemes are used.
+ * Symbol-based bullet (e.g., disc, circle, square).
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- autoSizeMixed = "AutoSizeMixed",
+ unnumbered = "Unnumbered",
}
/**
- * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
- If one of the centered options is 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}.
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- enum TextVerticalAlignment {
+ 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 that the `TextFrame` should be top aligned to the `Shape`.
+ * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- top = "Top",
+ style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
/**
- * Specifies that the `TextFrame` should be center aligned to the `Shape`.
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- middle = "Middle",
+ type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
- * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
+ * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- bottom = "Bottom",
+ visible: boolean | null;
/**
- * 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]
+ * 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.
*/
- topCentered = "TopCentered",
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
/**
- * 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]
+ * 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.
*/
- middleCentered = "MiddleCentered",
+ load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
/**
- * 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]
+ * 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.
*/
- bottomCentered = "BottomCentered",
+ 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 text frame of a shape object.
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
*
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- class TextFrame extends OfficeExtension.ClientObject {
+ 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 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.
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
*
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
+ readonly bulletFormat: PowerPoint.BulletFormat;
/**
- * Represents the bottom margin, in points, of the text frame.
+ * 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]
*/
- bottomMargin: number;
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
/**
- * Specifies if the text frame contains text.
+ * Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly hasText: boolean;
+ indentLevel: number;
/**
- * Represents the left margin, in points, of the text frame.
+ * 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.
*/
- leftMargin: number;
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
/**
- * Represents the right margin, in points, of the text frame.
+ * 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.
*/
- rightMargin: number;
+ load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
/**
- * Represents the top margin, in points, of the text frame.
+ * 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.
*/
- topMargin: number;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.ParagraphFormat;
/**
- * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
- *
+ * 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;
+ }
+ /**
+ * The type of underline applied to a font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ enum ShapeFontUnderlineStyle {
+ /**
+ * No underlining.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ none = "None",
/**
- * Determines whether lines break automatically to fit text inside the shape.
- *
+ * Regular single line underlining.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- wordWrap: boolean;
+ single = "Single",
/**
- * Deletes all the text in the text frame.
- *
+ * Underlining of text with double lines.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- deleteText(): void;
+ double = "Double",
/**
- * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`.
- *
+ * Underlining of text with a thick line.
* @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.
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.TextFrame;
+ heavy = "Heavy",
/**
- * 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.
+ * Underlining of text with a dotted line.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- toJSON(): PowerPoint.Interfaces.TextFrameData;
- }
- /**
- * 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]
- */
- 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;
+ dotted = "Dotted",
/**
- * Returns a `ShapeFont` object that represents the font attributes for the text range.
- *
+ * Underlining of text with a thick, dotted line.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- readonly font: PowerPoint.ShapeFont;
+ dottedHeavy = "DottedHeavy",
/**
- * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
- *
+ * Underlining of text with a line containing dashes.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- readonly paragraphFormat: PowerPoint.ParagraphFormat;
+ dash = "Dash",
/**
- * 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.
- *
+ * Underlining of text with a thick line containing dashes.
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.4]
*/
- length: number;
+ dashHeavy = "DashHeavy",
/**
- * 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.
- *
+ * Underlining of text with a line containing long dashes.
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.4]
*/
- start: number;
+ dashLong = "DashLong",
/**
- * Represents the plain text content of the text range.
- *
+ * Underlining of text with a thick line containing long dashes.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- text: string;
+ dashLongHeavy = "DashLongHeavy",
/**
- * Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`.
- *
+ * Underlining of text with a line containing dots and dashes.
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.4]
*/
- getParentTextFrame(): PowerPoint.TextFrame;
+ dotDash = "DotDash",
/**
- * Returns a `TextRange` object for the substring in the given range.
- *
+ * Underlining of text with a thick line containing dots and dashes.
* @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;
+ dotDashHeavy = "DotDashHeavy",
/**
- * Selects this `TextRange` in the current view.
- *
+ * Underlining of text with a line containing double dots and dashes.
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.4]
*/
- setSelected(): void;
+ dotDotDash = "DotDotDash",
/**
- * 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.
+ * Underlining of text with a thick line containing double dots and dashes.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;
+ dotDotDashHeavy = "DotDotDashHeavy",
/**
- * 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.
+ * Underlining of text with a wavy line.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNames?: string | string[]): PowerPoint.TextRange;
+ wavy = "Wavy",
/**
- * 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.
+ * Underlining of text with a thick, wavy line.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.TextRange;
+ wavyHeavy = "WavyHeavy",
/**
- * 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.
+ * Underlining of text with double wavy lines.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- toJSON(): PowerPoint.Interfaces.TextRangeData;
+ wavyDouble = "WavyDouble",
}
/**
- * Represents a single hyperlink.
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
*
* @remarks
- * [Api set: PowerPointApi 1.6]
+ * [Api set: PowerPointApi 1.4]
*/
- class Hyperlink extends OfficeExtension.ClientObject {
+ 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 the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ * 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.6]
+ * [Api set: PowerPointApi 1.8]
*/
- address: string;
+ allCaps: boolean | null;
/**
- * Specifies the string displayed when hovering over the hyperlink.
+ * 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.6]
+ * [Api set: PowerPointApi 1.4]
*/
- screenTip: string;
+ bold: boolean | null;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * 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.
*
- * @param options Provides options for which properties of the object to load.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;
+ color: string | null;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * 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.
*
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
*/
- load(propertyNames?: string | string[]): PowerPoint.Hyperlink;
+ doubleStrikethrough: boolean | null;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * 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.
*
- * @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.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.Hyperlink;
+ italic: boolean | null;
/**
- * 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.
+ * 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]
*/
- toJSON(): PowerPoint.Interfaces.HyperlinkData;
- }
- /**
- * Specifies the type of a placeholder.
- *
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- enum PlaceholderType {
+ name: string | null;
/**
- * The placeholder is unsupported.
+ * 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.8]
+ * [Api set: PowerPointApi 1.4]
*/
- unsupported = "Unsupported",
+ size: number | null;
/**
- * The placeholder is for a date.
+ * 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]
*/
- date = "Date",
+ smallCaps: boolean | null;
/**
- * 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.
+ * 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]
*/
- subtitle = "Subtitle",
+ strikethrough: boolean | null;
/**
- * The placeholder is for a vertical title.
+ * 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]
*/
- verticalTitle = "VerticalTitle",
+ subscript: boolean | null;
/**
- * The placeholder is for a vertical body.
+ * 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]
*/
- verticalBody = "VerticalBody",
+ superscript: boolean | null;
/**
- * The placeholder is for generic content.
+ * 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.8]
+ * [Api set: PowerPointApi 1.4]
*/
- content = "Content",
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
/**
- * The placeholder is for a chart.
- * @remarks
- * [Api set: PowerPointApi 1.8]
+ * 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.
*/
- chart = "Chart",
+ load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
/**
- * The placeholder is for a table.
- * @remarks
- * [Api set: PowerPointApi 1.8]
+ * 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.
*/
- table = "Table",
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
/**
- * The placeholder is for an online picture.
- * @remarks
- * [Api set: PowerPointApi 1.8]
+ * 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.
*/
- onlinePicture = "OnlinePicture",
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.ShapeFont;
/**
- * The placeholder is for a SmartArt.
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- smartArt = "SmartArt",
+ * 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;
+ }
+ /**
+ * Determines the type of automatic sizing allowed.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ enum ShapeAutoSize {
/**
- * The placeholder is for media.
+ * No autosizing.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- media = "Media",
+ autoSizeNone = "AutoSizeNone",
/**
- * The placeholder is for generic vertical content.
+ * The text is adjusted to fit the shape.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- verticalContent = "VerticalContent",
+ autoSizeTextToFitShape = "AutoSizeTextToFitShape",
/**
- * The placeholder is for a picture.
+ * The shape is adjusted to fit the text.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- picture = "Picture",
+ autoSizeShapeToFitText = "AutoSizeShapeToFitText",
/**
- * The placeholder is for a cameo.
+ * A combination of automatic sizing schemes are used.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- cameo = "Cameo",
+ autoSizeMixed = "AutoSizeMixed",
}
/**
- * Specifies the type of a shape.
+ * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
+ If one of the centered options is 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 ShapeType {
+ enum TextVerticalAlignment {
/**
- * The given shape's type is unsupported.
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- unsupported = "Unsupported",
+ top = "Top",
/**
- * The shape is an image.
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- image = "Image",
+ middle = "Middle",
/**
- * The shape is a geometric shape such as rectangle.
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- geometricShape = "GeometricShape",
+ bottom = "Bottom",
/**
- * The shape is a group shape which contains sub-shapes.
+ * 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]
*/
- group = "Group",
+ topCentered = "TopCentered",
/**
- * The shape is a line.
+ * 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]
*/
- line = "Line",
+ middleCentered = "MiddleCentered",
/**
- * The shape is a table.
+ * 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]
*/
- table = "Table",
+ bottomCentered = "BottomCentered",
+ }
+ /**
+ * Represents the text frame of a shape object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ 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;
/**
- * The shape is a callout.
+ * 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]
*/
- callout = "Callout",
+ readonly textRange: PowerPoint.TextRange;
/**
- * The shape is a chart.
+ * 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]
*/
- chart = "Chart",
+ autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
/**
- * The shape is a content Office Add-in.
+ * Represents the bottom margin, in points, of the text frame.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- contentApp = "ContentApp",
+ bottomMargin: number;
/**
- * The shape is a diagram.
+ * Specifies if the text frame contains text.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- diagram = "Diagram",
+ readonly hasText: boolean;
/**
- * The shape is a freeform object.
+ * Represents the left margin, in points, of the text frame.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- freeform = "Freeform",
+ leftMargin: number;
/**
- * The shape is a graphic.
+ * Represents the right margin, in points, of the text frame.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- graphic = "Graphic",
+ rightMargin: number;
/**
- * The shape is an ink object.
+ * Represents the top margin, in points, of the text frame.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- ink = "Ink",
+ topMargin: number;
/**
- * The shape is a media object.
+ * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- media = "Media",
+ verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
/**
- * The shape is a 3D model.
+ * Determines whether lines break automatically to fit text inside the shape.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- model3D = "Model3D",
+ wordWrap: boolean;
/**
- * The shape is an OLE (Object Linking and Embedding) object.
+ * Deletes all the text in the text frame.
+ *
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- ole = "Ole",
+ deleteText(): void;
/**
- * The shape is a placeholder.
+ * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`.
+ *
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.5]
*/
- placeholder = "Placeholder",
+ getParentShape(): PowerPoint.Shape;
/**
- * The shape is a SmartArt graphic.
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- smartArt = "SmartArt",
+ load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;
/**
- * The shape is a text box.
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- textBox = "TextBox",
- }
+ 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;
+ }
/**
- * Represents the properties of a `placeholder` shape.
+ * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- class PlaceholderFormat extends OfficeExtension.ClientObject {
+ 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;
/**
- * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details.
- Returns `null` if the placeholder is empty.
+ * Returns a `ShapeFont` object that represents the font attributes for the text range.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
+ readonly font: PowerPoint.ShapeFont;
/**
- * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ * Returns a collection of hyperlinks that exist on this `TextRange`.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
+ readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;
+ /**
+ * 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;
+ /**
+ * Sets a hyperlink on this `TextRange` with the specified options. This will delete all existing hyperlinks on this `TextRange`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options Optional. The options for the hyperlink.
+ * @returns The newly created {@link PowerPoint.Hyperlink} object.
+ */
+ setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
+ /**
+ * 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.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat;
+ 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.PlaceholderFormat;
+ 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.
*
@@ -179366,1869 +179517,1827 @@ declare namespace PowerPoint {
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
- }): PowerPoint.PlaceholderFormat;
+ }): 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.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.
+ * 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.PlaceholderFormatData;
+ toJSON(): PowerPoint.Interfaces.TextRangeData;
}
/**
- * Represents a collection of hyperlinks.
+ * Specifies the type of object that a hyperlink is applied to.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum HyperlinkType {
+ /**
+ * Specifies that the hyperlink is applied to a TextRange.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ textRange = "TextRange",
+ /**
+ * Specifies that the hyperlink is applied to a Shape.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ shape = "Shape",
+ }
+ /**
+ * Represents a single hyperlink.
*
* @remarks
* [Api set: PowerPointApi 1.6]
*/
- class HyperlinkCollection extends OfficeExtension.ClientObject {
+ 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;
- /** Gets the loaded child items in this collection. */
- readonly items: PowerPoint.Hyperlink[];
/**
- * Gets the number of hyperlinks in the collection.
+ * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
*
* @remarks
* [Api set: PowerPointApi 1.6]
- * @returns The number of hyperlinks in the collection.
*/
- getCount(): OfficeExtension.ClientResult;
+ address: string;
/**
- * Gets a hyperlink using its zero-based index in the collection.
- Throws an `InvalidArgument` exception if the index is out of range.
+ * Specifies the string displayed when hovering over the hyperlink.
*
* @remarks
* [Api set: PowerPointApi 1.6]
+ */
+ screenTip: string;
+ /**
+ * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
- * @param index The index of the hyperlink in the collection.
- * @returns The hyperlink at the given index.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- getItemAt(index: number): PowerPoint.Hyperlink;
+ readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";
+ /**
+ * Deletes the hyperlink.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ delete(): void;
+ /**
+ * Returns the {@link PowerPoint.Shape} object that the hyperlink is applied to.
+ If the hyperlink is not of type `shape`, or it is within a domain that does not currently support a {@link PowerPoint.Shape}, 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.10]
+ */
+ getLinkedShapeOrNullObject(): PowerPoint.Shape;
+ /**
+ * Returns the {@link PowerPoint.TextRange} object that the hyperlink is applied to.
+ If the hyperlink is not of type `textRange`, or it is within a domain that does not currently support a {@link PowerPoint.TextRange}, 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.10]
+ */
+ getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;
/**
* 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;
+ 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.HyperlinkCollection;
+ 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?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;
+ 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.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;
+ * 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;
}
/**
- * Specifies the connector type for line shapes.
+ * Specifies the type of a placeholder.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- enum ConnectorType {
+ enum PlaceholderType {
/**
- * Straight connector type
+ * The placeholder is unsupported.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- straight = "Straight",
+ unsupported = "Unsupported",
/**
- * Elbow connector type
+ * The placeholder is for a date.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- elbow = "Elbow",
+ date = "Date",
/**
- * Curve connector type
+ * The placeholder is for a slide number.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- curve = "Curve",
- }
- /**
- * Specifies the shape type for a `GeometricShape` object.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- enum GeometricShapeType {
+ slideNumber = "SlideNumber",
/**
- * Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape
+ * The placeholder is for a footer.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- lineInverse = "LineInverse",
+ footer = "Footer",
/**
- * Isosceles Triangle
+ * The placeholder is for a header.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- triangle = "Triangle",
+ header = "Header",
/**
- * Right Triangle
+ * The placeholder is for a title.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- rightTriangle = "RightTriangle",
+ title = "Title",
/**
- * Rectangle
+ * The placeholder is for a body.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- rectangle = "Rectangle",
+ body = "Body",
/**
- * Diamond
+ * The placeholder is for a center title.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- diamond = "Diamond",
+ centerTitle = "CenterTitle",
/**
- * Parallelogram
+ * The placeholder is for a subtitle.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- parallelogram = "Parallelogram",
+ subtitle = "Subtitle",
/**
- * Trapezoid
+ * The placeholder is for a vertical title.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- trapezoid = "Trapezoid",
+ verticalTitle = "VerticalTitle",
/**
- * Trapezoid which may have Non-Equal Sides
+ * The placeholder is for a vertical body.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid",
+ verticalBody = "VerticalBody",
/**
- * Pentagon
+ * The placeholder is for generic content.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- pentagon = "Pentagon",
+ content = "Content",
/**
- * Hexagon
+ * The placeholder is for a chart.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- hexagon = "Hexagon",
+ chart = "Chart",
/**
- * Heptagon
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- heptagon = "Heptagon",
- /**
- * Octagon
+ * The placeholder is for a table.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- octagon = "Octagon",
+ table = "Table",
/**
- * Decagon
+ * The placeholder is for an online picture.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- decagon = "Decagon",
+ onlinePicture = "OnlinePicture",
/**
- * Dodecagon
+ * The placeholder is for a SmartArt.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- dodecagon = "Dodecagon",
+ smartArt = "SmartArt",
/**
- * Star: 4 Points
+ * The placeholder is for media.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- star4 = "Star4",
+ media = "Media",
/**
- * Star: 5 Points
+ * The placeholder is for generic vertical content.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- star5 = "Star5",
+ verticalContent = "VerticalContent",
/**
- * Star: 6 Points
+ * The placeholder is for a picture.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- star6 = "Star6",
+ picture = "Picture",
/**
- * Star: 7 Points
+ * The placeholder is for a cameo.
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- star7 = "Star7",
+ cameo = "Cameo",
+ }
+ /**
+ * Specifies the type of a shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ enum ShapeType {
/**
- * Star: 8 Points
+ * The given shape's type is unsupported.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- star8 = "Star8",
+ unsupported = "Unsupported",
/**
- * Star: 10 Points
+ * The shape is an image.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- star10 = "Star10",
+ image = "Image",
/**
- * Star: 12 Points
+ * The shape is a geometric shape such as rectangle.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- star12 = "Star12",
+ geometricShape = "GeometricShape",
/**
- * Star: 16 Points
+ * The shape is a group shape which contains sub-shapes.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- star16 = "Star16",
+ group = "Group",
/**
- * Star: 24 Points
+ * The shape is a line.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- star24 = "Star24",
+ line = "Line",
/**
- * Star: 32 Points
+ * The shape is a table.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- star32 = "Star32",
+ table = "Table",
/**
- * Rectangle: Rounded Corners
+ * The shape is a callout.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- roundRectangle = "RoundRectangle",
+ callout = "Callout",
/**
- * Rectangle: Single Corner Rounded
+ * The shape is a chart.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- round1Rectangle = "Round1Rectangle",
+ chart = "Chart",
/**
- * Rectangle: Top Corners Rounded
+ * The shape is a content Office Add-in.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- round2SameRectangle = "Round2SameRectangle",
+ contentApp = "ContentApp",
/**
- * Rectangle: Diagonal Corners Rounded
+ * The shape is a diagram.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- round2DiagonalRectangle = "Round2DiagonalRectangle",
+ diagram = "Diagram",
/**
- * Rectangle: Top Corners One Rounded and One Snipped
+ * The shape is a freeform object.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- snipRoundRectangle = "SnipRoundRectangle",
+ freeform = "Freeform",
/**
- * Rectangle: Single Corner Snipped
+ * The shape is a graphic.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- snip1Rectangle = "Snip1Rectangle",
+ graphic = "Graphic",
/**
- * Rectangle: Top Corners Snipped
+ * The shape is an ink object.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- snip2SameRectangle = "Snip2SameRectangle",
+ ink = "Ink",
/**
- * Rectangle: Diagonal Corners Snipped
+ * The shape is a media object.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- snip2DiagonalRectangle = "Snip2DiagonalRectangle",
+ media = "Media",
/**
- * Plaque
+ * The shape is a 3D model.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- plaque = "Plaque",
+ model3D = "Model3D",
/**
- * Oval
+ * The shape is an OLE (Object Linking and Embedding) object.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- ellipse = "Ellipse",
+ ole = "Ole",
/**
- * Teardrop
+ * The shape is a placeholder.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- teardrop = "Teardrop",
+ placeholder = "Placeholder",
/**
- * Arrow: Pentagon
+ * The shape is a SmartArt graphic.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- homePlate = "HomePlate",
+ smartArt = "SmartArt",
/**
- * Arrow: Chevron
+ * The shape is a text box.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- chevron = "Chevron",
+ 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;
/**
- * Partial Circle
+ * 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.4]
+ * [Api set: PowerPointApi 1.8]
*/
- pieWedge = "PieWedge",
+ readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
/**
- * Partial Circle with Adjustable Spanning Area
+ * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details.
+ *
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.8]
*/
- pie = "Pie",
+ readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo";
/**
- * Block Arc
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- blockArc = "BlockArc",
+ load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat;
/**
- * Circle: Hollow
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- donut = "Donut",
+ load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat;
/**
- * "Not Allowed" Symbol
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- noSmoking = "NoSmoking",
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.PlaceholderFormat;
/**
- * Arrow: Right
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- rightArrow = "RightArrow",
+ * 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 collection of hyperlinks.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.6]
+ */
+ class HyperlinkCollection extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /** Gets the loaded child items in this collection. */
+ readonly items: PowerPoint.Hyperlink[];
/**
- * Arrow: Left
+ * Adds a hyperlink to the specified target with the given options. If the target already contains any hyperlinks, they will be deleted.
+ The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end.
+ *
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param target The target to add the hyperlink to. Can be a {@link PowerPoint.TextRange} or a {@link PowerPoint.Shape}.
+ * @param options Optional. The options for the hyperlink.
+ * @returns The newly created {@link PowerPoint.Hyperlink} object.
*/
- leftArrow = "LeftArrow",
+ add(target: TextRange | Shape, options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
/**
- * Arrow: Up
+ * Gets the number of hyperlinks in the collection.
+ *
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.6]
+ * @returns The number of hyperlinks in the collection.
*/
- upArrow = "UpArrow",
+ getCount(): OfficeExtension.ClientResult;
/**
- * Arrow: Down
+ * Gets a hyperlink using its zero-based index in the collection.
+ Throws an `InvalidArgument` exception if the index is out of range.
+ *
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.6]
+ *
+ * @param index The index of the hyperlink in the collection.
+ * @returns The hyperlink at the given index.
*/
- downArrow = "DownArrow",
+ getItemAt(index: number): PowerPoint.Hyperlink;
/**
- * Arrow: Striped Right
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- stripedRightArrow = "StripedRightArrow",
+ load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;
/**
- * Arrow: Notched Right
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- notchedRightArrow = "NotchedRightArrow",
+ load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection;
/**
- * Arrow: Bent-Up
- * @remarks
- * [Api set: PowerPointApi 1.4]
+ * 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.
*/
- bentUpArrow = "BentUpArrow",
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;
/**
- * Arrow: Left-Right
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- leftRightArrow = "LeftRightArrow",
+ * 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 {
/**
- * Arrow: Up-Down
+ * Straight connector type
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- upDownArrow = "UpDownArrow",
+ straight = "Straight",
/**
- * Arrow: Left-Up
+ * Elbow connector type
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftUpArrow = "LeftUpArrow",
+ elbow = "Elbow",
/**
- * Arrow: Left-Right-Up
+ * Curve connector type
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftRightUpArrow = "LeftRightUpArrow",
+ curve = "Curve",
+ }
+ /**
+ * Specifies the shape type for a `GeometricShape` object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ enum GeometricShapeType {
/**
- * Arrow: Quad
+ * Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- quadArrow = "QuadArrow",
+ lineInverse = "LineInverse",
/**
- * Callout: Left Arrow
+ * Isosceles Triangle
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftArrowCallout = "LeftArrowCallout",
+ triangle = "Triangle",
/**
- * Callout: Right Arrow
+ * Right Triangle
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- rightArrowCallout = "RightArrowCallout",
+ rightTriangle = "RightTriangle",
/**
- * Callout: Up Arrow
+ * Rectangle
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- upArrowCallout = "UpArrowCallout",
+ rectangle = "Rectangle",
/**
- * Callout: Down Arrow
+ * Diamond
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- downArrowCallout = "DownArrowCallout",
+ diamond = "Diamond",
/**
- * Callout: Left-Right Arrow
+ * Parallelogram
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftRightArrowCallout = "LeftRightArrowCallout",
+ parallelogram = "Parallelogram",
/**
- * Callout: Up-Down Arrow
+ * Trapezoid
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- upDownArrowCallout = "UpDownArrowCallout",
+ trapezoid = "Trapezoid",
/**
- * Callout: Quad Arrow
+ * Trapezoid which may have Non-Equal Sides
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- quadArrowCallout = "QuadArrowCallout",
+ nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid",
/**
- * Arrow: Bent
+ * Pentagon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- bentArrow = "BentArrow",
+ pentagon = "Pentagon",
/**
- * Arrow: U-Turn
+ * Hexagon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- uturnArrow = "UturnArrow",
+ hexagon = "Hexagon",
/**
- * Arrow: Circular
+ * Heptagon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- circularArrow = "CircularArrow",
+ heptagon = "Heptagon",
/**
- * Arrow: Circular with Opposite Arrow Direction
+ * Octagon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftCircularArrow = "LeftCircularArrow",
+ octagon = "Octagon",
/**
- * Arrow: Circular with Two Arrows in Both Directions
+ * Decagon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftRightCircularArrow = "LeftRightCircularArrow",
+ decagon = "Decagon",
/**
- * Arrow: Curved Right
+ * Dodecagon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- curvedRightArrow = "CurvedRightArrow",
+ dodecagon = "Dodecagon",
/**
- * Arrow: Curved Left
+ * Star: 4 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- curvedLeftArrow = "CurvedLeftArrow",
+ star4 = "Star4",
/**
- * Arrow: Curved Up
+ * Star: 5 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- curvedUpArrow = "CurvedUpArrow",
+ star5 = "Star5",
/**
- * Arrow: Curved Down
+ * Star: 6 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- curvedDownArrow = "CurvedDownArrow",
+ star6 = "Star6",
/**
- * Arrow: Curved Right Arrow with Varying Width
+ * Star: 7 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- swooshArrow = "SwooshArrow",
+ star7 = "Star7",
/**
- * Cube
+ * Star: 8 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- cube = "Cube",
+ star8 = "Star8",
/**
- * Cylinder
+ * Star: 10 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- can = "Can",
+ star10 = "Star10",
/**
- * Lightning Bolt
+ * Star: 12 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- lightningBolt = "LightningBolt",
+ star12 = "Star12",
/**
- * Heart
+ * Star: 16 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- heart = "Heart",
+ star16 = "Star16",
/**
- * Sun
+ * Star: 24 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- sun = "Sun",
+ star24 = "Star24",
/**
- * Moon
+ * Star: 32 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- moon = "Moon",
+ star32 = "Star32",
/**
- * Smiley Face
+ * Rectangle: Rounded Corners
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- smileyFace = "SmileyFace",
+ roundRectangle = "RoundRectangle",
/**
- * Explosion: 8 Points
+ * Rectangle: Single Corner Rounded
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- irregularSeal1 = "IrregularSeal1",
+ round1Rectangle = "Round1Rectangle",
/**
- * Explosion: 14 Points
+ * Rectangle: Top Corners Rounded
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- irregularSeal2 = "IrregularSeal2",
+ round2SameRectangle = "Round2SameRectangle",
/**
- * Rectangle: Folded Corner
+ * Rectangle: Diagonal Corners Rounded
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- foldedCorner = "FoldedCorner",
+ round2DiagonalRectangle = "Round2DiagonalRectangle",
/**
- * Rectangle: Beveled
+ * Rectangle: Top Corners One Rounded and One Snipped
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- bevel = "Bevel",
+ snipRoundRectangle = "SnipRoundRectangle",
/**
- * Frame
+ * Rectangle: Single Corner Snipped
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- frame = "Frame",
+ snip1Rectangle = "Snip1Rectangle",
/**
- * Half Frame
+ * Rectangle: Top Corners Snipped
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- halfFrame = "HalfFrame",
+ snip2SameRectangle = "Snip2SameRectangle",
/**
- * L-Shape
+ * Rectangle: Diagonal Corners Snipped
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- corner = "Corner",
+ snip2DiagonalRectangle = "Snip2DiagonalRectangle",
/**
- * Diagonal Stripe
+ * Plaque
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- diagonalStripe = "DiagonalStripe",
+ plaque = "Plaque",
/**
- * Chord
+ * Oval
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- chord = "Chord",
+ ellipse = "Ellipse",
/**
- * Arc
+ * Teardrop
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- arc = "Arc",
+ teardrop = "Teardrop",
/**
- * Left Bracket
+ * Arrow: Pentagon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftBracket = "LeftBracket",
+ homePlate = "HomePlate",
/**
- * Right Bracket
+ * Arrow: Chevron
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- rightBracket = "RightBracket",
+ chevron = "Chevron",
/**
- * Left Brace
+ * Partial Circle
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftBrace = "LeftBrace",
+ pieWedge = "PieWedge",
/**
- * Right Brace
+ * Partial Circle with Adjustable Spanning Area
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- rightBrace = "RightBrace",
+ pie = "Pie",
/**
- * Double Bracket
+ * Block Arc
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- bracketPair = "BracketPair",
+ blockArc = "BlockArc",
/**
- * Double Brace
+ * Circle: Hollow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- bracePair = "BracePair",
+ donut = "Donut",
/**
- * Callout: Line with No Border
+ * "Not Allowed" Symbol
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- callout1 = "Callout1",
+ noSmoking = "NoSmoking",
/**
- * Callout: Bent Line with No Border
+ * Arrow: Right
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- callout2 = "Callout2",
+ rightArrow = "RightArrow",
/**
- * Callout: Double Bent Line with No Border
+ * Arrow: Left
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- callout3 = "Callout3",
+ leftArrow = "LeftArrow",
/**
- * Callout: Line with Accent Bar
+ * Arrow: Up
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- accentCallout1 = "AccentCallout1",
+ upArrow = "UpArrow",
/**
- * Callout: Bent Line with Accent Bar
+ * Arrow: Down
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- accentCallout2 = "AccentCallout2",
+ downArrow = "DownArrow",
/**
- * Callout: Double Bent Line with Accent Bar
+ * Arrow: Striped Right
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- accentCallout3 = "AccentCallout3",
+ stripedRightArrow = "StripedRightArrow",
/**
- * Callout: Line
+ * Arrow: Notched Right
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- borderCallout1 = "BorderCallout1",
+ notchedRightArrow = "NotchedRightArrow",
/**
- * Callout: Bent Line
+ * Arrow: Bent-Up
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- borderCallout2 = "BorderCallout2",
+ bentUpArrow = "BentUpArrow",
/**
- * Callout: Double Bent Line
+ * Arrow: Left-Right
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- borderCallout3 = "BorderCallout3",
+ leftRightArrow = "LeftRightArrow",
/**
- * Callout: Line with Border and Accent Bar
+ * Arrow: Up-Down
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- accentBorderCallout1 = "AccentBorderCallout1",
+ upDownArrow = "UpDownArrow",
/**
- * Callout: Bent Line with Border and Accent Bar
+ * Arrow: Left-Up
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- accentBorderCallout2 = "AccentBorderCallout2",
+ leftUpArrow = "LeftUpArrow",
/**
- * Callout: Double Bent Line with Border and Accent Bar
+ * Arrow: Left-Right-Up
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- accentBorderCallout3 = "AccentBorderCallout3",
+ leftRightUpArrow = "LeftRightUpArrow",
/**
- * Speech Bubble: Rectangle
+ * Arrow: Quad
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- wedgeRectCallout = "WedgeRectCallout",
+ quadArrow = "QuadArrow",
/**
- * Speech Bubble: Rectangle with Corners Rounded
+ * Callout: Left Arrow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- wedgeRRectCallout = "WedgeRRectCallout",
+ leftArrowCallout = "LeftArrowCallout",
/**
- * Speech Bubble: Oval
+ * Callout: Right Arrow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- wedgeEllipseCallout = "WedgeEllipseCallout",
+ rightArrowCallout = "RightArrowCallout",
/**
- * Thought Bubble: Cloud
+ * Callout: Up Arrow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- cloudCallout = "CloudCallout",
+ upArrowCallout = "UpArrowCallout",
/**
- * Cloud
+ * Callout: Down Arrow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- cloud = "Cloud",
+ downArrowCallout = "DownArrowCallout",
/**
- * Ribbon: Tilted Down
+ * Callout: Left-Right Arrow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- ribbon = "Ribbon",
+ leftRightArrowCallout = "LeftRightArrowCallout",
/**
- * Ribbon: Tilted Up
+ * Callout: Up-Down Arrow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- ribbon2 = "Ribbon2",
+ upDownArrowCallout = "UpDownArrowCallout",
/**
- * Ribbon: Curved and Tilted Down
+ * Callout: Quad Arrow
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- ellipseRibbon = "EllipseRibbon",
+ quadArrowCallout = "QuadArrowCallout",
/**
- * Ribbon: Curved and Tilted Up
+ * Arrow: Bent
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- ellipseRibbon2 = "EllipseRibbon2",
+ bentArrow = "BentArrow",
/**
- * Ribbon: Straight with Both Left and Right Arrows
+ * Arrow: U-Turn
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- leftRightRibbon = "LeftRightRibbon",
+ uturnArrow = "UturnArrow",
/**
- * Scroll: Vertical
+ * Arrow: Circular
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- verticalScroll = "VerticalScroll",
+ circularArrow = "CircularArrow",
/**
- * Scroll: Horizontal
+ * Arrow: Circular with Opposite Arrow Direction
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- horizontalScroll = "HorizontalScroll",
+ leftCircularArrow = "LeftCircularArrow",
/**
- * Wave
+ * Arrow: Circular with Two Arrows in Both Directions
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- wave = "Wave",
+ leftRightCircularArrow = "LeftRightCircularArrow",
/**
- * Double Wave
+ * Arrow: Curved Right
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- doubleWave = "DoubleWave",
+ curvedRightArrow = "CurvedRightArrow",
/**
- * Cross
+ * Arrow: Curved Left
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- plus = "Plus",
+ curvedLeftArrow = "CurvedLeftArrow",
/**
- * Flowchart: Process
+ * Arrow: Curved Up
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartProcess = "FlowChartProcess",
+ curvedUpArrow = "CurvedUpArrow",
/**
- * Flowchart: Decision
+ * Arrow: Curved Down
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartDecision = "FlowChartDecision",
+ curvedDownArrow = "CurvedDownArrow",
/**
- * Flowchart: Data
+ * Arrow: Curved Right Arrow with Varying Width
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartInputOutput = "FlowChartInputOutput",
+ swooshArrow = "SwooshArrow",
/**
- * Flowchart: Predefined Process
+ * Cube
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartPredefinedProcess = "FlowChartPredefinedProcess",
+ cube = "Cube",
/**
- * Flowchart: Internal Storage
+ * Cylinder
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartInternalStorage = "FlowChartInternalStorage",
+ can = "Can",
/**
- * Flowchart: Document
+ * Lightning Bolt
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartDocument = "FlowChartDocument",
+ lightningBolt = "LightningBolt",
/**
- * Flowchart: Multidocument
+ * Heart
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartMultidocument = "FlowChartMultidocument",
+ heart = "Heart",
/**
- * Flowchart: Terminator
+ * Sun
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartTerminator = "FlowChartTerminator",
+ sun = "Sun",
/**
- * Flowchart: Preparation
+ * Moon
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartPreparation = "FlowChartPreparation",
+ moon = "Moon",
/**
- * Flowchart: Manual Input
+ * Smiley Face
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartManualInput = "FlowChartManualInput",
+ smileyFace = "SmileyFace",
/**
- * Flowchart: Manual Operation
+ * Explosion: 8 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartManualOperation = "FlowChartManualOperation",
+ irregularSeal1 = "IrregularSeal1",
/**
- * Flowchart: Connector
+ * Explosion: 14 Points
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartConnector = "FlowChartConnector",
+ irregularSeal2 = "IrregularSeal2",
/**
- * Flowchart: Card
+ * Rectangle: Folded Corner
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartPunchedCard = "FlowChartPunchedCard",
+ foldedCorner = "FoldedCorner",
/**
- * Flowchart: Punched Tape
+ * Rectangle: Beveled
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartPunchedTape = "FlowChartPunchedTape",
+ bevel = "Bevel",
/**
- * Flowchart: Summing Junction
+ * Frame
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartSummingJunction = "FlowChartSummingJunction",
+ frame = "Frame",
/**
- * Flowchart: Or
+ * Half Frame
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartOr = "FlowChartOr",
+ halfFrame = "HalfFrame",
/**
- * Flowchart: Collate
+ * L-Shape
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartCollate = "FlowChartCollate",
+ corner = "Corner",
/**
- * Flowchart: Sort
+ * Diagonal Stripe
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartSort = "FlowChartSort",
+ diagonalStripe = "DiagonalStripe",
/**
- * Flowchart: Extract
+ * Chord
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartExtract = "FlowChartExtract",
+ chord = "Chord",
/**
- * Flowchart: Merge
+ * Arc
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartMerge = "FlowChartMerge",
+ arc = "Arc",
/**
- * FlowChart: Offline Storage
+ * Left Bracket
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartOfflineStorage = "FlowChartOfflineStorage",
+ leftBracket = "LeftBracket",
/**
- * Flowchart: Stored Data
+ * Right Bracket
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartOnlineStorage = "FlowChartOnlineStorage",
+ rightBracket = "RightBracket",
/**
- * Flowchart: Sequential Access Storage
+ * Left Brace
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartMagneticTape = "FlowChartMagneticTape",
+ leftBrace = "LeftBrace",
/**
- * Flowchart: Magnetic Disk
+ * Right Brace
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartMagneticDisk = "FlowChartMagneticDisk",
+ rightBrace = "RightBrace",
/**
- * Flowchart: Direct Access Storage
+ * Double Bracket
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartMagneticDrum = "FlowChartMagneticDrum",
+ bracketPair = "BracketPair",
/**
- * Flowchart: Display
+ * Double Brace
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartDisplay = "FlowChartDisplay",
+ bracePair = "BracePair",
/**
- * Flowchart: Delay
+ * Callout: Line with No Border
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartDelay = "FlowChartDelay",
+ callout1 = "Callout1",
/**
- * Flowchart: Alternate Process
+ * Callout: Bent Line with No Border
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartAlternateProcess = "FlowChartAlternateProcess",
+ callout2 = "Callout2",
/**
- * Flowchart: Off-page Connector
+ * Callout: Double Bent Line with No Border
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- flowChartOffpageConnector = "FlowChartOffpageConnector",
+ callout3 = "Callout3",
/**
- * Action Button: Blank
+ * Callout: Line with Accent Bar
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonBlank = "ActionButtonBlank",
+ accentCallout1 = "AccentCallout1",
/**
- * Action Button: Go Home
+ * Callout: Bent Line with Accent Bar
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonHome = "ActionButtonHome",
+ accentCallout2 = "AccentCallout2",
/**
- * Action Button: Help
+ * Callout: Double Bent Line with Accent Bar
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonHelp = "ActionButtonHelp",
+ accentCallout3 = "AccentCallout3",
/**
- * Action Button: Get Information
+ * Callout: Line
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonInformation = "ActionButtonInformation",
+ borderCallout1 = "BorderCallout1",
/**
- * Action Button: Go Forward or Next
+ * Callout: Bent Line
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonForwardNext = "ActionButtonForwardNext",
+ borderCallout2 = "BorderCallout2",
/**
- * Action Button: Go Back or Previous
+ * Callout: Double Bent Line
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonBackPrevious = "ActionButtonBackPrevious",
+ borderCallout3 = "BorderCallout3",
/**
- * Action Button: Go to End
+ * Callout: Line with Border and Accent Bar
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonEnd = "ActionButtonEnd",
+ accentBorderCallout1 = "AccentBorderCallout1",
/**
- * Action Button: Go to Beginning
+ * Callout: Bent Line with Border and Accent Bar
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonBeginning = "ActionButtonBeginning",
+ accentBorderCallout2 = "AccentBorderCallout2",
/**
- * Action Button: Return
+ * Callout: Double Bent Line with Border and Accent Bar
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonReturn = "ActionButtonReturn",
+ accentBorderCallout3 = "AccentBorderCallout3",
/**
- * Action Button: Document
+ * Speech Bubble: Rectangle
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonDocument = "ActionButtonDocument",
+ wedgeRectCallout = "WedgeRectCallout",
/**
- * Action Button: Sound
+ * Speech Bubble: Rectangle with Corners Rounded
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonSound = "ActionButtonSound",
+ wedgeRRectCallout = "WedgeRRectCallout",
/**
- * Action Button: Video
+ * Speech Bubble: Oval
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- actionButtonMovie = "ActionButtonMovie",
+ wedgeEllipseCallout = "WedgeEllipseCallout",
/**
- * Gear: A Gear with Six Teeth
+ * Thought Bubble: Cloud
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- gear6 = "Gear6",
+ cloudCallout = "CloudCallout",
/**
- * Gear: A Gear with Nine Teeth
+ * Cloud
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- gear9 = "Gear9",
+ cloud = "Cloud",
/**
- * Funnel
+ * Ribbon: Tilted Down
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- funnel = "Funnel",
+ ribbon = "Ribbon",
/**
- * Plus Sign
+ * Ribbon: Tilted Up
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- mathPlus = "MathPlus",
+ ribbon2 = "Ribbon2",
/**
- * Minus Sign
+ * Ribbon: Curved and Tilted Down
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- mathMinus = "MathMinus",
+ ellipseRibbon = "EllipseRibbon",
/**
- * Multiplication Sign
+ * Ribbon: Curved and Tilted Up
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- mathMultiply = "MathMultiply",
+ ellipseRibbon2 = "EllipseRibbon2",
/**
- * Division Sign
+ * Ribbon: Straight with Both Left and Right Arrows
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- mathDivide = "MathDivide",
+ leftRightRibbon = "LeftRightRibbon",
/**
- * Equals
+ * Scroll: Vertical
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- mathEqual = "MathEqual",
+ verticalScroll = "VerticalScroll",
/**
- * Not Equal
+ * Scroll: Horizontal
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- mathNotEqual = "MathNotEqual",
+ horizontalScroll = "HorizontalScroll",
/**
- * Four Right Triangles that Define a Rectangular Shape
+ * Wave
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- cornerTabs = "CornerTabs",
+ wave = "Wave",
/**
- * Four Small Squares that Define a Rectangular Shape.
+ * Double Wave
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- squareTabs = "SquareTabs",
+ doubleWave = "DoubleWave",
/**
- * Four Quarter Circles that Define a Rectangular Shape.
+ * Cross
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- plaqueTabs = "PlaqueTabs",
+ plus = "Plus",
/**
- * A Rectangle Divided into Four Parts Along Diagonal Lines.
+ * Flowchart: Process
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- chartX = "ChartX",
+ flowChartProcess = "FlowChartProcess",
/**
- * A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal Lines.
+ * Flowchart: Decision
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- chartStar = "ChartStar",
+ flowChartDecision = "FlowChartDecision",
/**
- * A Rectangle Divided Vertically and Horizontally into Four Quarters.
+ * Flowchart: Data
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- chartPlus = "ChartPlus",
- }
- /**
- * Represents the available options when adding shapes.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- interface ShapeAddOptions {
+ flowChartInputOutput = "FlowChartInputOutput",
/**
- * 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.
- *
+ * Flowchart: Predefined Process
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- height?: number;
+ flowChartPredefinedProcess = "FlowChartPredefinedProcess",
/**
- * 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.
- *
+ * Flowchart: Internal Storage
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- left?: number;
+ flowChartInternalStorage = "FlowChartInternalStorage",
/**
- * 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.
- *
+ * Flowchart: Document
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- top?: number;
+ flowChartDocument = "FlowChartDocument",
/**
- * 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.
- *
+ * Flowchart: Multidocument
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- width?: number;
- }
- /**
- * Specifies the dash style for a line.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- enum ShapeLineDashStyle {
+ flowChartMultidocument = "FlowChartMultidocument",
/**
- * The dash line pattern.
+ * Flowchart: Terminator
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- dash = "Dash",
+ flowChartTerminator = "FlowChartTerminator",
/**
- * The dash-dot line pattern.
+ * Flowchart: Preparation
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- dashDot = "DashDot",
+ flowChartPreparation = "FlowChartPreparation",
/**
- * The dash-dot-dot line pattern.
+ * Flowchart: Manual Input
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- dashDotDot = "DashDotDot",
+ flowChartManualInput = "FlowChartManualInput",
/**
- * The long dash line pattern.
+ * Flowchart: Manual Operation
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- longDash = "LongDash",
+ flowChartManualOperation = "FlowChartManualOperation",
/**
- * The long dash-dot line pattern.
+ * Flowchart: Connector
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- longDashDot = "LongDashDot",
+ flowChartConnector = "FlowChartConnector",
/**
- * The round dot line pattern.
+ * Flowchart: Card
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- roundDot = "RoundDot",
+ flowChartPunchedCard = "FlowChartPunchedCard",
/**
- * The solid line pattern.
+ * Flowchart: Punched Tape
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- solid = "Solid",
+ flowChartPunchedTape = "FlowChartPunchedTape",
/**
- * The square dot line pattern.
+ * Flowchart: Summing Junction
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- squareDot = "SquareDot",
+ flowChartSummingJunction = "FlowChartSummingJunction",
/**
- * The long dash-dot-dot line pattern.
+ * Flowchart: Or
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- longDashDotDot = "LongDashDotDot",
+ flowChartOr = "FlowChartOr",
/**
- * The system dash line pattern.
+ * Flowchart: Collate
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- systemDash = "SystemDash",
+ flowChartCollate = "FlowChartCollate",
/**
- * The system dot line pattern.
+ * Flowchart: Sort
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- systemDot = "SystemDot",
+ flowChartSort = "FlowChartSort",
/**
- * The system dash-dot line pattern.
+ * Flowchart: Extract
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- systemDashDot = "SystemDashDot",
- }
- /**
- * Represents the properties for a table cell border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- class Border 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;
+ flowChartExtract = "FlowChartExtract",
/**
- * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
- *
+ * Flowchart: Merge
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- color: string | undefined;
+ flowChartMerge = "FlowChartMerge",
/**
- * Represents the dash style of the line.
- *
+ * FlowChart: Offline Storage
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
+ flowChartOfflineStorage = "FlowChartOfflineStorage",
/**
- * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
- *
+ * Flowchart: Stored Data
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- transparency: number | undefined;
+ flowChartOnlineStorage = "FlowChartOnlineStorage",
/**
- * Represents the weight of the line, in points.
- *
+ * Flowchart: Sequential Access Storage
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- weight: number | undefined;
+ flowChartMagneticTape = "FlowChartMagneticTape",
/**
- * 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.
+ * Flowchart: Magnetic Disk
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(options?: PowerPoint.Interfaces.BorderLoadOptions): PowerPoint.Border;
+ flowChartMagneticDisk = "FlowChartMagneticDisk",
/**
- * 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.
+ * Flowchart: Direct Access Storage
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNames?: string | string[]): PowerPoint.Border;
+ flowChartMagneticDrum = "FlowChartMagneticDrum",
/**
- * 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.
+ * Flowchart: Display
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.Border;
- /**
- * 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.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object.
- */
- toJSON(): PowerPoint.Interfaces.BorderData;
- }
- /**
- * Represents the borders for a table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- class Borders 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;
+ flowChartDisplay = "FlowChartDisplay",
/**
- * Gets the bottom border.
- *
+ * Flowchart: Delay
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly bottom: PowerPoint.Border;
+ flowChartDelay = "FlowChartDelay",
/**
- * Gets the diagonal border (top-left to bottom-right).
- *
+ * Flowchart: Alternate Process
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly diagonalDown: PowerPoint.Border;
+ flowChartAlternateProcess = "FlowChartAlternateProcess",
/**
- * Gets the diagonal border (bottom-left to top-right).
- *
+ * Flowchart: Off-page Connector
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly diagonalUp: PowerPoint.Border;
+ flowChartOffpageConnector = "FlowChartOffpageConnector",
/**
- * Gets the left border.
- *
+ * Action Button: Blank
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly left: PowerPoint.Border;
+ actionButtonBlank = "ActionButtonBlank",
/**
- * Gets the right border.
- *
+ * Action Button: Go Home
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly right: PowerPoint.Border;
+ actionButtonHome = "ActionButtonHome",
/**
- * Gets the top border.
- *
+ * Action Button: Help
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly top: PowerPoint.Border;
+ actionButtonHelp = "ActionButtonHelp",
/**
- * 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.
+ * Action Button: Get Information
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(options?: PowerPoint.Interfaces.BordersLoadOptions): PowerPoint.Borders;
+ actionButtonInformation = "ActionButtonInformation",
/**
- * 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.
+ * Action Button: Go Forward or Next
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNames?: string | string[]): PowerPoint.Borders;
+ actionButtonForwardNext = "ActionButtonForwardNext",
/**
- * 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.
+ * Action Button: Go Back or Previous
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.Borders;
+ actionButtonBackPrevious = "ActionButtonBackPrevious",
/**
- * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
+ * Action Button: Go to End
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- toJSON(): PowerPoint.Interfaces.BordersData;
- }
- /**
- * Represents the margins of a table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- class Margins 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;
+ actionButtonEnd = "ActionButtonEnd",
/**
- * Specifies the bottom margin in points.
- *
+ * Action Button: Go to Beginning
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- bottom: number | undefined;
+ actionButtonBeginning = "ActionButtonBeginning",
/**
- * Specifies the left margin in points.
- *
+ * Action Button: Return
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- left: number | undefined;
+ actionButtonReturn = "ActionButtonReturn",
/**
- * Specifies the right margin in points.
- *
+ * Action Button: Document
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- right: number | undefined;
+ actionButtonDocument = "ActionButtonDocument",
/**
- * Specifies the top margin in points.
- *
+ * Action Button: Sound
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- top: number | undefined;
+ actionButtonSound = "ActionButtonSound",
/**
- * 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.
+ * Action Button: Video
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(options?: PowerPoint.Interfaces.MarginsLoadOptions): PowerPoint.Margins;
+ actionButtonMovie = "ActionButtonMovie",
/**
- * 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.
+ * Gear: A Gear with Six Teeth
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNames?: string | string[]): PowerPoint.Margins;
+ gear6 = "Gear6",
/**
- * 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.
+ * Gear: A Gear with Nine Teeth
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.Margins;
+ gear9 = "Gear9",
/**
- * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
+ * Funnel
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- toJSON(): PowerPoint.Interfaces.MarginsData;
- }
- /**
- * Specifies a shape's fill type.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- enum ShapeFillType {
+ funnel = "Funnel",
/**
- * Specifies that the shape should have no fill.
+ * Plus Sign
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- noFill = "NoFill",
+ mathPlus = "MathPlus",
/**
- * Specifies that the shape should have regular solid fill.
+ * Minus Sign
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- solid = "Solid",
+ mathMinus = "MathMinus",
/**
- * Specifies that the shape should have gradient fill.
+ * Multiplication Sign
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- gradient = "Gradient",
+ mathMultiply = "MathMultiply",
/**
- * Specifies that the shape should have pattern fill.
+ * Division Sign
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- pattern = "Pattern",
+ mathDivide = "MathDivide",
/**
- * Specifies that the shape should have picture or texture fill.
+ * Equals
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- pictureAndTexture = "PictureAndTexture",
+ mathEqual = "MathEqual",
/**
- * Specifies that the shape should have slide background fill.
+ * Not Equal
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- slideBackground = "SlideBackground",
- }
- /**
- * Represents the fill formatting of a shape object.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
- 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;
+ mathNotEqual = "MathNotEqual",
/**
- * 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").
- *
+ * Four Right Triangles that Define a Rectangular Shape
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- foregroundColor: string;
+ cornerTabs = "CornerTabs",
/**
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
- *
+ * Four Small Squares that Define a Rectangular Shape.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- transparency: number;
+ squareTabs = "SquareTabs",
/**
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
- *
+ * Four Quarter Circles that Define a Rectangular Shape.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
+ plaqueTabs = "PlaqueTabs",
/**
- * Clears the fill formatting of this shape.
- *
+ * A Rectangle Divided into Four Parts Along Diagonal Lines.
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- clear(): void;
+ chartX = "ChartX",
/**
- * Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`.
- *
+ * A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal Lines.
* @remarks
- * [Api set: PowerPointApi 1.8]
- *
- * @param base64EncodedImage A string that is a Base64 encoding of the image data.
+ * [Api set: PowerPointApi 1.4]
*/
- setImage(base64EncodedImage: string): void;
+ chartStar = "ChartStar",
/**
- * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
- *
+ * A Rectangle Divided Vertically and Horizontally into Four Quarters.
* @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;
+ chartPlus = "ChartPlus",
+ }
+ /**
+ * Represents the available options when adding shapes.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ interface ShapeAddOptions {
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * 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.
*
- * @param options Provides options for which properties of the object to load.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
+ height?: number;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * 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.
*
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
+ left?: number;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * 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.
*
- * @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.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.ShapeFill;
+ top?: number;
/**
- * 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;
+ * 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;
}
/**
- * Represents the font attributes, such as font name, size, and color.
+ * Specifies the dash style for a line.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- interface FontProperties {
+ enum ShapeLineDashStyle {
/**
- * Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
- *
+ * The dash line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- allCaps?: boolean | undefined;
+ dash = "Dash",
/**
- * Represents the bold status of font.
- *
+ * The dash-dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- bold?: boolean | undefined;
+ dashDot = "DashDot",
/**
- * Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").
- *
+ * The dash-dot-dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- color?: string | undefined;
+ dashDotDot = "DashDotDot",
/**
- * Represents the double-strikethrough status of the font.
- *
+ * The long dash line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- doubleStrikethrough?: boolean | undefined;
+ longDash = "LongDash",
/**
- * Represents the italic status of font.
- *
+ * The long dash-dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- italic?: boolean | undefined;
+ longDashDot = "LongDashDot",
/**
- * 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.
- *
+ * The round dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- name?: string | undefined;
+ roundDot = "RoundDot",
/**
- * Represents the font size in points (e.g., 11).
- *
+ * The solid line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- 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;
+ solid = "Solid",
/**
- * Represents the subscript status of the font.
- *
+ * The square dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- subscript?: boolean | undefined;
+ squareDot = "SquareDot",
/**
- * Represents the superscript status of the font.
- *
+ * The long dash-dot-dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- superscript?: boolean | undefined;
+ longDashDotDot = "LongDashDotDot",
/**
- * Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
- *
+ * The system dash line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [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" | undefined;
- }
- /**
- * Represents a sequence of one or more characters with the same font attributes.
- *
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- interface TextRun {
+ systemDash = "SystemDash",
/**
- * The font attributes (such as font name, font size, and color) applied to this text run.
- *
+ * The system dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- font?: PowerPoint.FontProperties;
+ systemDot = "SystemDot",
/**
- * The text of this text run.
- *
+ * The system dash-dot line pattern.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.4]
*/
- text: string;
+ systemDashDot = "SystemDashDot",
}
/**
- * Represents a table.
+ * Represents the properties for a table cell border.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.9]
*/
- class TableCell extends OfficeExtension.ClientObject {
+ class Border extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
/**
- * Gets the collection of borders for the table cell.
+ * 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.9]
*/
- readonly borders: PowerPoint.Borders;
+ color: string | undefined;
/**
- * Gets the fill color of the table cell.
+ * Represents the dash style of the line.
*
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- readonly fill: PowerPoint.ShapeFill;
+ dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
/**
- * Gets the font of the table cell.
+ * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- readonly font: PowerPoint.ShapeFont;
+ transparency: number | undefined;
/**
- * Gets the set of margins in the table cell.
+ * Represents the weight of the line, in points.
*
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- readonly margins: PowerPoint.Margins;
- /**
- * 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;
+ weight: number | undefined;
/**
- * Gets the zero-based column index of the cell within the table.
+ * 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.8]
+ * @param options Provides options for which properties of the object to load.
*/
- readonly columnIndex: number;
+ load(options?: PowerPoint.Interfaces.BorderLoadOptions): PowerPoint.Border;
/**
- * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments.
+ * 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.9]
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
*/
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+ load(propertyNames?: string | string[]): PowerPoint.Border;
/**
- * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels.
+ * 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.9]
+ * @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.
*/
- indentLevel: number | null;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Border;
/**
- * 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;
+ * 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.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.BorderData;
+ }
+ /**
+ * Represents the borders for a table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ class Borders 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 zero-based row index of the cell within the table.
+ * Gets the bottom border.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.9]
*/
- readonly rowIndex: number;
+ readonly bottom: PowerPoint.Border;
/**
- * Specifies the text content of the table cell.
+ * Gets the diagonal border (top-left to bottom-right).
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.9]
*/
- text: string;
+ readonly diagonalDown: PowerPoint.Border;
/**
- * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
- Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ * Gets the diagonal border (bottom-left to top-right).
*
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- textRuns: PowerPoint.TextRun[];
+ readonly diagonalUp: PowerPoint.Border;
/**
- * Specifies the vertical alignment of the text in the table cell.
+ * Gets the left border.
*
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
+ readonly left: PowerPoint.Border;
/**
- * Resizes the table cell to span across a specified number of rows and columns.
- If rowCount or columnCount are greater than 1, the cell will become a merged area. If the cell
- is already a merged area and rowCount and columnCount are set to 1, the cell will no longer be
- a merged area.
+ * Gets the right border.
*
* @remarks
* [Api set: PowerPointApi 1.9]
- *
- * @param rowCount The number of rows the cell will span across. Must be greater than 0.
- * @param columnCount The number of columns the cell will span across. Must be greater than 0.
*/
- resize(rowCount: number, columnCount: number): void;
+ readonly right: PowerPoint.Border;
/**
- * Splits the cell into the specified number of rows and columns.
+ * Gets the top border.
*
* @remarks
* [Api set: PowerPointApi 1.9]
- *
- * @param rowCount The number of rows to split into. Must be greater than 0.
- * @param columnCount The number of columns to split into. Must be greater than 0.
*/
- split(rowCount: number, columnCount: number): void;
+ readonly top: PowerPoint.Border;
/**
* 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;
+ load(options?: PowerPoint.Interfaces.BordersLoadOptions): PowerPoint.Borders;
/**
* 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;
+ load(propertyNames?: string | string[]): PowerPoint.Borders;
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -181237,1591 +181346,2933 @@ declare namespace PowerPoint {
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
- }): PowerPoint.TableCell;
+ }): PowerPoint.Borders;
/**
- * 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;
+ * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.BordersData;
}
/**
- * Represents a collection of table cells.
+ * Represents the margins of a table cell.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.9]
*/
- class TableCellCollection extends OfficeExtension.ClientObject {
+ class Margins 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.
+ * Specifies the bottom margin in points.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
- * @returns The number of table cells in the collection.
+ * [Api set: PowerPointApi 1.9]
*/
- getCount(): OfficeExtension.ClientResult;
+ bottom: number | undefined;
/**
- * Gets the table cell using its zero-based index in the collection. If the `TableCell` 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}.
+ * Specifies the left margin in points.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.9]
+ */
+ left: number | undefined;
+ /**
+ * Specifies the right margin in points.
*
- * @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.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
*/
- getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell;
+ right: number | undefined;
+ /**
+ * Specifies the top margin in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ top: number | undefined;
/**
* 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;
+ load(options?: PowerPoint.Interfaces.MarginsLoadOptions): PowerPoint.Margins;
/**
* 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;
+ load(propertyNames?: string | string[]): PowerPoint.Margins;
/**
* 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;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.Margins;
/**
- * 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;
+ * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.MarginsData;
}
/**
- * Represents a column in a table.
+ * Specifies a shape's fill type.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- class TableColumn 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;
+ enum ShapeFillType {
/**
- * Returns the index number of the column within the column collection of the table. Zero-indexed.
- *
+ * Specifies that the shape should have no fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- readonly columnIndex: number;
+ noFill = "NoFill",
/**
- * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width.
- *
+ * Specifies that the shape should have regular solid fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- width: number;
+ solid = "Solid",
/**
- * Deletes the column.
- *
+ * Specifies that the shape should have gradient fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
- */
- 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.
+ * [Api set: PowerPointApi 1.4]
*/
- load(options?: PowerPoint.Interfaces.TableColumnLoadOptions): PowerPoint.TableColumn;
+ gradient = "Gradient",
/**
- * 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.
+ * Specifies that the shape should have pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNames?: string | string[]): PowerPoint.TableColumn;
+ pattern = "Pattern",
/**
- * 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.
+ * Specifies that the shape should have picture or texture fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.TableColumn;
+ pictureAndTexture = "PictureAndTexture",
/**
- * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
+ * Specifies that the shape should have slide background fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- toJSON(): PowerPoint.Interfaces.TableColumnData;
+ slideBackground = "SlideBackground",
}
/**
- * Represents a collection of table columns.
+ * Represents the fill formatting of a shape object.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*/
- class TableColumnCollection extends OfficeExtension.ClientObject {
+ 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;
- /** Gets the loaded child items in this collection. */
- readonly items: PowerPoint.TableColumn[];
/**
- * Adds one or more columns to the table.
+ * 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.9]
+ * [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 doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
*
- * @param index Optional. Specifies the zero-based index where the new columns are added. Existing columns starting at the index location are shifted right. If the index value is undefined, null, -1, or greater than the number of columns in the table, the new columns are added at the end of the table.
- * @param count Optional. The number of columns to add. If the value is undefined or 0, only one column is added.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- // eslint-disable-next-line @definitelytyped/redundant-undefined
- add(index?: number | null | undefined, count?: number | undefined): void;
+ transparency: number;
/**
- * Deletes the specified columns from the collection.
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
+ */
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
+ /**
+ * Clears the fill formatting of this shape.
*
- * @param columns An array of `TableColumn` objects representing the columns to be deleted.
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
*/
- deleteColumns(columns: PowerPoint.TableColumn[]): void;
+ clear(): void;
/**
- * Gets the number of columns in the collection.
+ * Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
- * @returns The number of columns in the collection.
+ * [Api set: PowerPointApi 1.8]
+ *
+ * @param base64EncodedImage A string that is a Base64 encoding of the image data.
*/
- getCount(): OfficeExtension.ClientResult;
+ setImage(base64EncodedImage: string): void;
/**
- * Gets the column using its zero-based index in the collection.
+ * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.4]
*
- * @param index Index value of the column to be retrieved, as a zero-based index.
- * @returns The column object.
+ * @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").
*/
- getItemAt(index: number): PowerPoint.TableColumn;
+ 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.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableColumnCollection;
+ 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.TableColumnCollection;
+ 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?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
+ 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
- toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
+ * 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;
}
/**
- * Represents the available options when clearing a table.
+ * Represents the font attributes, such as font name, size, and color.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- interface TableClearOptions {
+ interface FontProperties {
/**
- * Specifies if both values and formatting of the table should be cleared.
+ * Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- all?: boolean;
+ allCaps?: boolean | undefined;
/**
- * Specifies if the formatting of the table should be cleared.
+ * Represents the bold status of font.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- format?: boolean;
+ bold?: boolean | undefined;
/**
- * Specifies if the values of the table should be cleared.
+ * 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.9]
+ * [Api set: PowerPointApi 1.8]
*/
- text?: boolean;
- }
- /**
- * Represents a row in a table.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- class TableRow 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;
+ color?: string | undefined;
/**
- * Retrieves the current height of the row in points.
+ * Represents the double-strikethrough status of the font.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- readonly currentHeight: number;
+ doubleStrikethrough?: boolean | undefined;
/**
- * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
+ * Represents the italic status of font.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- height: number;
+ italic?: boolean | undefined;
/**
- * Returns the index number of the row within the rows collection of the table. Zero-indexed.
+ * 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.9]
+ * [Api set: PowerPointApi 1.8]
*/
- readonly rowIndex: number;
+ name?: string | undefined;
/**
- * Deletes the row.
+ * Represents the font size in points (e.g., 11).
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- delete(): void;
+ size?: number | undefined;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.
*
- * @param options Provides options for which properties of the object to load.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
*/
- load(options?: PowerPoint.Interfaces.TableRowLoadOptions): PowerPoint.TableRow;
+ smallCaps?: boolean | undefined;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * Represents the strikethrough status of the font.
*
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
*/
- load(propertyNames?: string | string[]): PowerPoint.TableRow;
+ strikethrough?: boolean | undefined;
/**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * Represents the subscript status of the font.
*
- * @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.
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.TableRow;
+ subscript?: boolean | undefined;
/**
- * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
+ * Represents the superscript status of the font.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
*/
- toJSON(): PowerPoint.Interfaces.TableRowData;
+ 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 collection of table rows.
+ * Represents a sequence of one or more characters with the same font attributes.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- class TableRowCollection 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.TableRow[];
+ interface TextRun {
/**
- * Adds one or more rows to the table.
+ * The font attributes (such as font name, font size, and color) applied to this text run.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
- *
- * @param index Optional. Specifies the zero-based index where the new rows are added. Existing rows starting at the index location are shifted down. If the index value is undefined, null, -1, or greater than the number of rows in the table, the new rows are added at the end of the table.
- * @param count Optional. The number of rows to add. If the value is undefined or 0, only one row is added.
+ * [Api set: PowerPointApi 1.8]
*/
- // eslint-disable-next-line @definitelytyped/redundant-undefined
- add(index?: number | null | undefined, count?: number | undefined): void;
+ font?: PowerPoint.FontProperties;
/**
- * Deletes the specified rows from the collection.
+ * The text of this text run.
*
* @remarks
- * [Api set: PowerPointApi 1.9]
- *
- * @param rows An array of `TableRow` objects representing the rows to be deleted.
+ * [Api set: PowerPointApi 1.8]
*/
- deleteRows(rows: PowerPoint.TableRow[]): void;
+ text: string;
+ }
+ /**
+ * Represents a table.
+ *
+ * @remarks
+ * [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. */
+ context: RequestContext;
/**
- * Gets the number of rows in the collection.
+ * Gets the collection of borders for the table cell.
*
* @remarks
* [Api set: PowerPointApi 1.9]
- * @returns The number of rows in the collection.
*/
- getCount(): OfficeExtension.ClientResult;
+ readonly borders: PowerPoint.Borders;
/**
- * Gets the row using its zero-based index in the collection.
+ * Gets the fill color of the table cell.
*
* @remarks
* [Api set: PowerPointApi 1.9]
- *
- * @param index Index value of the row to be retrieved, as a zero-based index.
- * @returns The row object.
*/
- getItemAt(index: number): PowerPoint.TableRow;
+ readonly fill: PowerPoint.ShapeFill;
/**
- * 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.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableRowCollection;
- /**
- * 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.TableRowCollection;
- /**
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ * Gets the font of the table cell.
*
- * @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.TableRowCollection;
- /**
- * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
- toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
- }
- /**
- * Represents the available built-in table styles.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- enum TableStyle {
- /**
- * Specifies the style "No style, No grid" in UI.
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- noStyleNoGrid = "NoStyleNoGrid",
+ readonly font: PowerPoint.ShapeFont;
/**
- * Specifies the style "Themed style 1 - Accent 1" in UI.
+ * Gets the set of margins in the table cell.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- themedStyle1Accent1 = "ThemedStyle1Accent1",
+ readonly margins: PowerPoint.Margins;
/**
- * Specifies the style "Themed style 1 - Accent 2" in UI.
+ * Gets the number of table columns this cell spans across.
+ Will be greater than or equal to 1.
+ *
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- themedStyle1Accent2 = "ThemedStyle1Accent2",
+ readonly columnCount: number;
/**
- * Specifies the style "Themed style 1 - Accent 3" in UI.
+ * Gets the zero-based column index of the cell within the table.
+ *
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- themedStyle1Accent3 = "ThemedStyle1Accent3",
+ readonly columnIndex: number;
/**
- * Specifies the style "Themed style 1 - Accent 4" in UI.
+ * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- themedStyle1Accent4 = "ThemedStyle1Accent4",
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
/**
- * Specifies the style "Themed style 1 - Accent 5" in UI.
+ * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- themedStyle1Accent5 = "ThemedStyle1Accent5",
+ indentLevel: number | null;
/**
- * Specifies the style "Themed style 1 - Accent 6" in UI.
+ * Gets the number of table rows this cell spans across.
+ Will be greater than or equal to 1.
+ *
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- themedStyle1Accent6 = "ThemedStyle1Accent6",
+ readonly rowCount: number;
/**
- * Specifies the style "No style, Table grid" in UI.
+ * Gets the zero-based row index of the cell within the table.
+ *
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- noStyleTableGrid = "NoStyleTableGrid",
+ readonly rowIndex: number;
/**
- * Specifies the style "Themed style 2 - Accent 1" in UI.
+ * Specifies the text content of the table cell.
+ *
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
*/
- themedStyle2Accent1 = "ThemedStyle2Accent1",
+ text: string;
/**
- * Specifies the style "Themed style 2 - Accent 2" in UI.
+ * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
+ Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- themedStyle2Accent2 = "ThemedStyle2Accent2",
+ textRuns: PowerPoint.TextRun[];
/**
- * Specifies the style "Themed style 2 - Accent 3" in UI.
+ * Specifies the vertical alignment of the text in the table cell.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- themedStyle2Accent3 = "ThemedStyle2Accent3",
+ verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
/**
- * Specifies the style "Themed style 2 - Accent 4" in UI.
+ * Resizes the table cell to span across a specified number of rows and columns.
+ If rowCount or columnCount are greater than 1, the cell will become a merged area. If the cell
+ is already a merged area and rowCount and columnCount are set to 1, the cell will no longer be
+ a merged area.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param rowCount The number of rows the cell will span across. Must be greater than 0.
+ * @param columnCount The number of columns the cell will span across. Must be greater than 0.
*/
- themedStyle2Accent4 = "ThemedStyle2Accent4",
+ resize(rowCount: number, columnCount: number): void;
/**
- * Specifies the style "Themed style 2 - Accent 5" in UI.
+ * Splits the cell into the specified number of rows and columns.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param rowCount The number of rows to split into. Must be greater than 0.
+ * @param columnCount The number of columns to split into. Must be greater than 0.
*/
- themedStyle2Accent5 = "ThemedStyle2Accent5",
+ split(rowCount: number, columnCount: number): void;
/**
- * Specifies the style "Themed style 2 - Accent 6" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- themedStyle2Accent6 = "ThemedStyle2Accent6",
+ load(options?: PowerPoint.Interfaces.TableCellLoadOptions): PowerPoint.TableCell;
/**
- * Specifies the style "Light Style 1" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle1 = "LightStyle1",
+ load(propertyNames?: string | string[]): PowerPoint.TableCell;
/**
- * Specifies the style "Light style 1 - Accent 1" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle1Accent1 = "LightStyle1Accent1",
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.TableCell;
/**
- * Specifies the style "Light style 1 - Accent 2" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- lightStyle1Accent2 = "LightStyle1Accent2",
+ * 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[];
/**
- * Specifies the style "Light style 1 - Accent 3" in UI.
+ * Gets the number of table cells in the collection.
+ *
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.8]
+ * @returns The number of table cells in the collection.
*/
- lightStyle1Accent3 = "LightStyle1Accent3",
+ getCount(): OfficeExtension.ClientResult;
/**
- * Specifies the style "Light style 1 - Accent 4" in UI.
+ * Gets the table cell using its zero-based index in the collection. If the `TableCell` 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.9]
+ * [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.
*/
- lightStyle1Accent4 = "LightStyle1Accent4",
+ getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell;
/**
- * Specifies the style "Light style 1 - Accent 5" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle1Accent5 = "LightStyle1Accent5",
+ load(options?: PowerPoint.Interfaces.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection;
/**
- * Specifies the style "Light style 1 - Accent 6" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle1Accent6 = "LightStyle1Accent6",
+ load(propertyNames?: string | string[]): PowerPoint.TableCellCollection;
/**
- * Specifies the style "Light Style 2" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle2 = "LightStyle2",
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection;
/**
- * Specifies the style "Light style 2 - Accent 1" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- lightStyle2Accent1 = "LightStyle2Accent1",
+ * 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 a column in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ class TableColumn 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 style "Light style 2 - Accent 2" in UI.
+ * Returns the index number of the column within the column collection of the table. Zero-indexed.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- lightStyle2Accent2 = "LightStyle2Accent2",
+ readonly columnIndex: number;
/**
- * Specifies the style "Light style 2 - Accent 3" in UI.
+ * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- lightStyle2Accent3 = "LightStyle2Accent3",
+ width: number;
/**
- * Specifies the style "Light style 2 - Accent 4" in UI.
+ * Deletes the column.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- lightStyle2Accent4 = "LightStyle2Accent4",
+ delete(): void;
/**
- * Specifies the style "Light style 2 - Accent 5" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle2Accent5 = "LightStyle2Accent5",
+ load(options?: PowerPoint.Interfaces.TableColumnLoadOptions): PowerPoint.TableColumn;
/**
- * Specifies the style "Light style 2 - Accent 6" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle2Accent6 = "LightStyle2Accent6",
+ load(propertyNames?: string | string[]): PowerPoint.TableColumn;
/**
- * Specifies the style "Light Style 3" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle3 = "LightStyle3",
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.TableColumn;
/**
- * Specifies the style "Light style 3 - Accent 1" in UI.
+ * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableColumnData;
+ }
+ /**
+ * Represents a collection of table columns.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ class TableColumnCollection 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.TableColumn[];
+ /**
+ * Adds one or more columns to the table.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param index Optional. Specifies the zero-based index where the new columns are added. Existing columns starting at the index location are shifted right. If the index value is undefined, null, -1, or greater than the number of columns in the table, the new columns are added at the end of the table.
+ * @param count Optional. The number of columns to add. If the value is undefined or 0, only one column is added.
*/
- lightStyle3Accent1 = "LightStyle3Accent1",
+ // eslint-disable-next-line @definitelytyped/redundant-undefined
+ add(index?: number | null | undefined, count?: number | undefined): void;
/**
- * Specifies the style "Light style 3 - Accent 2" in UI.
+ * Deletes the specified columns from the collection.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param columns An array of `TableColumn` objects representing the columns to be deleted.
*/
- lightStyle3Accent2 = "LightStyle3Accent2",
+ deleteColumns(columns: PowerPoint.TableColumn[]): void;
/**
- * Specifies the style "Light style 3 - Accent 3" in UI.
+ * Gets the number of columns in the collection.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ * @returns The number of columns in the collection.
*/
- lightStyle3Accent3 = "LightStyle3Accent3",
+ getCount(): OfficeExtension.ClientResult;
/**
- * Specifies the style "Light style 3 - Accent 4" in UI.
+ * Gets the column using its zero-based index in the collection.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param index Index value of the column to be retrieved, as a zero-based index.
+ * @returns The column object.
*/
- lightStyle3Accent4 = "LightStyle3Accent4",
+ getItemAt(index: number): PowerPoint.TableColumn;
/**
- * Specifies the style "Light style 3 - Accent 5" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle3Accent5 = "LightStyle3Accent5",
+ load(options?: PowerPoint.Interfaces.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableColumnCollection;
/**
- * Specifies the style "Light style 3 - Accent 6" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- lightStyle3Accent6 = "LightStyle3Accent6",
+ load(propertyNames?: string | string[]): PowerPoint.TableColumnCollection;
/**
- * Specifies the style "Medium Style 1" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- mediumStyle1 = "MediumStyle1",
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
/**
- * Specifies the style "Medium style 1 - Accent 1" in UI.
+ * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
+ }
+ /**
+ * Represents the available options when clearing a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ interface TableClearOptions {
+ /**
+ * Specifies if both values and formatting of the table should be cleared.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle1Accent1 = "MediumStyle1Accent1",
+ all?: boolean;
/**
- * Specifies the style "Medium style 1 - Accent 2" in UI.
+ * Specifies if the formatting of the table should be cleared.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle1Accent2 = "MediumStyle1Accent2",
+ format?: boolean;
/**
- * Specifies the style "Medium style 1 - Accent 3" in UI.
+ * Specifies if the values of the table should be cleared.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle1Accent3 = "MediumStyle1Accent3",
+ text?: boolean;
+ }
+ /**
+ * Represents a row in a table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ class TableRow 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 style "Medium style 1 - Accent 4" in UI.
+ * Retrieves the current height of the row in points.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle1Accent4 = "MediumStyle1Accent4",
+ readonly currentHeight: number;
/**
- * Specifies the style "Medium style 1 - Accent 5" in UI.
+ * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle1Accent5 = "MediumStyle1Accent5",
+ height: number;
/**
- * Specifies the style "Medium style 1 - Accent 6" in UI.
+ * Returns the index number of the row within the rows collection of the table. Zero-indexed.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle1Accent6 = "MediumStyle1Accent6",
+ readonly rowIndex: number;
/**
- * Specifies the style "Medium Style 2" in UI.
+ * Deletes the row.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle2 = "MediumStyle2",
+ delete(): void;
/**
- * Specifies the style "Medium style 2 - Accent 1" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- mediumStyle2Accent1 = "MediumStyle2Accent1",
+ load(options?: PowerPoint.Interfaces.TableRowLoadOptions): PowerPoint.TableRow;
/**
- * Specifies the style "Medium style 2 - Accent 2" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- mediumStyle2Accent2 = "MediumStyle2Accent2",
+ load(propertyNames?: string | string[]): PowerPoint.TableRow;
/**
- * Specifies the style "Medium style 2 - Accent 3" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- mediumStyle2Accent3 = "MediumStyle2Accent3",
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.TableRow;
/**
- * Specifies the style "Medium style 2 - Accent 4" in UI.
+ * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableRowData;
+ }
+ /**
+ * Represents a collection of table rows.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ class TableRowCollection 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.TableRow[];
+ /**
+ * Adds one or more rows to the table.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param index Optional. Specifies the zero-based index where the new rows are added. Existing rows starting at the index location are shifted down. If the index value is undefined, null, -1, or greater than the number of rows in the table, the new rows are added at the end of the table.
+ * @param count Optional. The number of rows to add. If the value is undefined or 0, only one row is added.
*/
- mediumStyle2Accent4 = "MediumStyle2Accent4",
+ // eslint-disable-next-line @definitelytyped/redundant-undefined
+ add(index?: number | null | undefined, count?: number | undefined): void;
/**
- * Specifies the style "Medium style 2 - Accent 5" in UI.
+ * Deletes the specified rows from the collection.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param rows An array of `TableRow` objects representing the rows to be deleted.
*/
- mediumStyle2Accent5 = "MediumStyle2Accent5",
+ deleteRows(rows: PowerPoint.TableRow[]): void;
/**
- * Specifies the style "Medium style 2 - Accent 6" in UI.
+ * Gets the number of rows in the collection.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ * @returns The number of rows in the collection.
*/
- mediumStyle2Accent6 = "MediumStyle2Accent6",
+ getCount(): OfficeExtension.ClientResult;
/**
- * Specifies the style "Medium Style 3" in UI.
+ * Gets the row using its zero-based index in the collection.
+ *
* @remarks
* [Api set: PowerPointApi 1.9]
+ *
+ * @param index Index value of the row to be retrieved, as a zero-based index.
+ * @returns The row object.
*/
- mediumStyle3 = "MediumStyle3",
+ getItemAt(index: number): PowerPoint.TableRow;
/**
- * Specifies the style "Medium style 3 - Accent 1" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- mediumStyle3Accent1 = "MediumStyle3Accent1",
+ load(options?: PowerPoint.Interfaces.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableRowCollection;
/**
- * Specifies the style "Medium style 3 - Accent 2" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- mediumStyle3Accent2 = "MediumStyle3Accent2",
+ load(propertyNames?: string | string[]): PowerPoint.TableRowCollection;
/**
- * Specifies the style "Medium style 3 - Accent 3" in UI.
- * @remarks
- * [Api set: PowerPointApi 1.9]
+ * 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.
*/
- mediumStyle3Accent3 = "MediumStyle3Accent3",
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection;
/**
- * Specifies the style "Medium style 3 - Accent 4" in UI.
+ * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
+ }
+ /**
+ * Represents the available built-in table styles.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ enum TableStyle {
+ /**
+ * Specifies the style "No style, No grid" in UI.
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle3Accent4 = "MediumStyle3Accent4",
+ noStyleNoGrid = "NoStyleNoGrid",
/**
- * Specifies the style "Medium style 3 - Accent 5" in UI.
+ * Specifies the style "Themed style 1 - Accent 1" in UI.
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle3Accent5 = "MediumStyle3Accent5",
+ themedStyle1Accent1 = "ThemedStyle1Accent1",
/**
- * Specifies the style "Medium style 3 - Accent 6" in UI.
+ * Specifies the style "Themed style 1 - Accent 2" in UI.
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle3Accent6 = "MediumStyle3Accent6",
+ themedStyle1Accent2 = "ThemedStyle1Accent2",
/**
- * Specifies the style "Medium Style 4" in UI.
+ * Specifies the style "Themed style 1 - Accent 3" in UI.
* @remarks
* [Api set: PowerPointApi 1.9]
*/
- mediumStyle4 = "MediumStyle4",
+ themedStyle1Accent3 = "ThemedStyle1Accent3",
+ /**
+ * Specifies the style "Themed style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent4 = "ThemedStyle1Accent4",
+ /**
+ * Specifies the style "Themed style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent5 = "ThemedStyle1Accent5",
+ /**
+ * Specifies the style "Themed style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle1Accent6 = "ThemedStyle1Accent6",
+ /**
+ * Specifies the style "No style, Table grid" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ noStyleTableGrid = "NoStyleTableGrid",
+ /**
+ * Specifies the style "Themed style 2 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent1 = "ThemedStyle2Accent1",
+ /**
+ * Specifies the style "Themed style 2 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent2 = "ThemedStyle2Accent2",
+ /**
+ * Specifies the style "Themed style 2 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent3 = "ThemedStyle2Accent3",
+ /**
+ * Specifies the style "Themed style 2 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent4 = "ThemedStyle2Accent4",
+ /**
+ * Specifies the style "Themed style 2 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent5 = "ThemedStyle2Accent5",
+ /**
+ * Specifies the style "Themed style 2 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ themedStyle2Accent6 = "ThemedStyle2Accent6",
+ /**
+ * Specifies the style "Light Style 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1 = "LightStyle1",
+ /**
+ * Specifies the style "Light style 1 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent1 = "LightStyle1Accent1",
+ /**
+ * Specifies the style "Light style 1 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent2 = "LightStyle1Accent2",
+ /**
+ * Specifies the style "Light style 1 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent3 = "LightStyle1Accent3",
+ /**
+ * Specifies the style "Light style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent4 = "LightStyle1Accent4",
+ /**
+ * Specifies the style "Light style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent5 = "LightStyle1Accent5",
+ /**
+ * Specifies the style "Light style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle1Accent6 = "LightStyle1Accent6",
+ /**
+ * Specifies the style "Light Style 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2 = "LightStyle2",
+ /**
+ * Specifies the style "Light style 2 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent1 = "LightStyle2Accent1",
+ /**
+ * Specifies the style "Light style 2 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent2 = "LightStyle2Accent2",
+ /**
+ * Specifies the style "Light style 2 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent3 = "LightStyle2Accent3",
+ /**
+ * Specifies the style "Light style 2 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent4 = "LightStyle2Accent4",
+ /**
+ * Specifies the style "Light style 2 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent5 = "LightStyle2Accent5",
+ /**
+ * Specifies the style "Light style 2 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle2Accent6 = "LightStyle2Accent6",
+ /**
+ * Specifies the style "Light Style 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3 = "LightStyle3",
+ /**
+ * Specifies the style "Light style 3 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent1 = "LightStyle3Accent1",
+ /**
+ * Specifies the style "Light style 3 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent2 = "LightStyle3Accent2",
+ /**
+ * Specifies the style "Light style 3 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent3 = "LightStyle3Accent3",
+ /**
+ * Specifies the style "Light style 3 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent4 = "LightStyle3Accent4",
+ /**
+ * Specifies the style "Light style 3 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent5 = "LightStyle3Accent5",
+ /**
+ * Specifies the style "Light style 3 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ lightStyle3Accent6 = "LightStyle3Accent6",
+ /**
+ * Specifies the style "Medium Style 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1 = "MediumStyle1",
+ /**
+ * Specifies the style "Medium style 1 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent1 = "MediumStyle1Accent1",
+ /**
+ * Specifies the style "Medium style 1 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent2 = "MediumStyle1Accent2",
+ /**
+ * Specifies the style "Medium style 1 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent3 = "MediumStyle1Accent3",
+ /**
+ * Specifies the style "Medium style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent4 = "MediumStyle1Accent4",
+ /**
+ * Specifies the style "Medium style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent5 = "MediumStyle1Accent5",
+ /**
+ * Specifies the style "Medium style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle1Accent6 = "MediumStyle1Accent6",
+ /**
+ * Specifies the style "Medium Style 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2 = "MediumStyle2",
+ /**
+ * Specifies the style "Medium style 2 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent1 = "MediumStyle2Accent1",
+ /**
+ * Specifies the style "Medium style 2 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent2 = "MediumStyle2Accent2",
+ /**
+ * Specifies the style "Medium style 2 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent3 = "MediumStyle2Accent3",
+ /**
+ * Specifies the style "Medium style 2 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent4 = "MediumStyle2Accent4",
+ /**
+ * Specifies the style "Medium style 2 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent5 = "MediumStyle2Accent5",
+ /**
+ * Specifies the style "Medium style 2 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle2Accent6 = "MediumStyle2Accent6",
+ /**
+ * Specifies the style "Medium Style 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3 = "MediumStyle3",
+ /**
+ * Specifies the style "Medium style 3 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent1 = "MediumStyle3Accent1",
+ /**
+ * Specifies the style "Medium style 3 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent2 = "MediumStyle3Accent2",
+ /**
+ * Specifies the style "Medium style 3 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent3 = "MediumStyle3Accent3",
+ /**
+ * Specifies the style "Medium style 3 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent4 = "MediumStyle3Accent4",
+ /**
+ * Specifies the style "Medium style 3 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent5 = "MediumStyle3Accent5",
+ /**
+ * Specifies the style "Medium style 3 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle3Accent6 = "MediumStyle3Accent6",
+ /**
+ * Specifies the style "Medium Style 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4 = "MediumStyle4",
+ /**
+ * Specifies the style "Medium style 4 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent1 = "MediumStyle4Accent1",
+ /**
+ * Specifies the style "Medium style 4 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent2 = "MediumStyle4Accent2",
+ /**
+ * Specifies the style "Medium style 4 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent3 = "MediumStyle4Accent3",
+ /**
+ * Specifies the style "Medium style 4 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent4 = "MediumStyle4Accent4",
+ /**
+ * Specifies the style "Medium style 4 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent5 = "MediumStyle4Accent5",
+ /**
+ * Specifies the style "Medium style 4 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ mediumStyle4Accent6 = "MediumStyle4Accent6",
+ /**
+ * Specifies the style "Dark Style 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1 = "DarkStyle1",
+ /**
+ * Specifies the style "Dark style 1 - Accent 1" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent1 = "DarkStyle1Accent1",
+ /**
+ * Specifies the style "Dark style 1 - Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent2 = "DarkStyle1Accent2",
+ /**
+ * Specifies the style "Dark style 1 - Accent 3" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent3 = "DarkStyle1Accent3",
+ /**
+ * Specifies the style "Dark style 1 - Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent4 = "DarkStyle1Accent4",
+ /**
+ * Specifies the style "Dark style 1 - Accent 5" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent5 = "DarkStyle1Accent5",
+ /**
+ * Specifies the style "Dark style 1 - Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle1Accent6 = "DarkStyle1Accent6",
+ /**
+ * Specifies the style "Dark Style 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2 = "DarkStyle2",
+ /**
+ * Specifies the style "Dark style 2 - Accent 1/Accent 2" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2Accent1 = "DarkStyle2Accent1",
+ /**
+ * Specifies the style "Dark style 2 - Accent 3/Accent 4" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2Accent2 = "DarkStyle2Accent2",
+ /**
+ * Specifies the style "Dark style 2 - Accent 5/Accent 6" in UI.
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ darkStyle2Accent3 = "DarkStyle2Accent3",
+ }
+ /**
+ * Represents the available table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ class TableStyleSettings 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 columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areColumnsBanded: boolean;
+ /**
+ * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ areRowsBanded: boolean;
+ /**
+ * Specifies if the first column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstColumnHighlighted: boolean;
+ /**
+ * Specifies if the first row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isFirstRowHighlighted: boolean;
+ /**
+ * Specifies if the last column contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastColumnHighlighted: boolean;
+ /**
+ * Specifies if the last row contains special formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ isLastRowHighlighted: boolean;
+ /**
+ * Specifies the table style.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ style: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ /**
+ * 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.TableStyleSettingsLoadOptions): PowerPoint.TableStyleSettings;
+ /**
+ * 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.TableStyleSettings;
+ /**
+ * 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.TableStyleSettings;
+ /**
+ * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;
+ }
+ /**
+ * 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 collection of columns in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly columns: PowerPoint.TableColumnCollection;
+ /**
+ * Gets the collection of rows in the table.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly rows: PowerPoint.TableRowCollection;
+ /**
+ * Gets the table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ readonly styleSettings: PowerPoint.TableStyleSettings;
+ /**
+ * 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[][];
+ /**
+ * Clears table values and formatting.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param options Provides options for clearing the table.
+ */
+ clear(options?: PowerPoint.TableClearOptions): void;
+ /**
+ * 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. 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}.
+ */
+ 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;
+ /**
+ * Creates a merged area starting at the cell specified by rowIndex and columnIndex. The merged area spans across a specified number of rows and columns.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ *
+ * @param rowIndex The zero-based row index of the cell to start the merged area.
+ * @param columnIndex The zero-based column index of the cell to start the merged area.
+ * @param rowCount The number of rows to merge with the starting cell. Must be greater than 0.
+ * @param columnCount The number of columns to merge with the starting cell. Must be greater than 0.
+ */
+ mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): 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.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;
+ }
+ /**
+ * 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;
+ /**
+ * Specifies the horizontal alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
+ /**
+ * Specifies 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 PowerPoint.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[];
+ /**
+ * Specifies the vertical alignment of the text in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
+ verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
+ }
+ /**
+ * 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 doesn't 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 doesn't 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 isn't provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+
+ Note: If the table height isn't evenly divisible by the number of rows, PowerPoint sets it to the nearest possible value.
+ For example, a height of 400 for 3 rows may result in an actual height of 399.9999.
+ *
+ * @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 isn't 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 a 2D array with the same number of rows and columns as the table.
+ If a cell doesn't 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 value that represents the table style.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ /**
+ * 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 isn't 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 don't 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 isn't provided.
+ Throws an `InvalidArgument` exception when set with a negative value.
+
+ Note: If the table width isn't evenly divisible by the number of columns, PowerPoint sets it to the nearest possible value.
+ For example, a width of 400 for 3 columns may result in an actual width of 399.9999.
+ *
+ * @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;
+ /**
+ * 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: "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 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?: "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 doesn't 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 doesn't 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 doesn't 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 shape.
+ * @returns The shape with the unique ID. If such a shape doesn't 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;
+ }
+ /**
+ * Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum SlideBackgroundGradientFillType {
+ /**
+ * Unsupported gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ unsupported = "Unsupported",
+ /**
+ * Linear gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ linear = "Linear",
+ /**
+ * Radial gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ radial = "Radial",
+ /**
+ * Rectangular gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rectangular = "Rectangular",
+ /**
+ * Path gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ path = "Path",
+ /**
+ * Shade from title gradient fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ shadeFromTitle = "ShadeFromTitle",
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} gradient fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class SlideBackgroundGradientFill 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 type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ /**
+ * 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.SlideBackgroundGradientFillLoadOptions): PowerPoint.SlideBackgroundGradientFill;
+ /**
+ * 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.SlideBackgroundGradientFill;
+ /**
+ * 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.SlideBackgroundGradientFill;
+ /**
+ * 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.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;
+ }
+ /**
+ * Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundGradientFillOptions {
/**
- * Specifies the style "Medium style 4 - Accent 1" in UI.
+ * If provided, specifies the type of gradient fill.
+ *
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- mediumStyle4Accent1 = "MediumStyle4Accent1",
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ }
+ /**
+ * Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum SlideBackgroundPatternFillType {
/**
- * Specifies the style "Medium style 4 - Accent 2" in UI.
+ * Unsupported pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- mediumStyle4Accent2 = "MediumStyle4Accent2",
+ unsupported = "Unsupported",
/**
- * Specifies the style "Medium style 4 - Accent 3" in UI.
+ * 5 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- mediumStyle4Accent3 = "MediumStyle4Accent3",
+ percent5 = "Percent5",
/**
- * Specifies the style "Medium style 4 - Accent 4" in UI.
+ * 10 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- mediumStyle4Accent4 = "MediumStyle4Accent4",
+ percent10 = "Percent10",
/**
- * Specifies the style "Medium style 4 - Accent 5" in UI.
+ * 20 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- mediumStyle4Accent5 = "MediumStyle4Accent5",
+ percent20 = "Percent20",
/**
- * Specifies the style "Medium style 4 - Accent 6" in UI.
+ * 25 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- mediumStyle4Accent6 = "MediumStyle4Accent6",
+ percent25 = "Percent25",
/**
- * Specifies the style "Dark Style 1" in UI.
+ * 30 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle1 = "DarkStyle1",
+ percent30 = "Percent30",
/**
- * Specifies the style "Dark style 1 - Accent 1" in UI.
+ * 40 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle1Accent1 = "DarkStyle1Accent1",
+ percent40 = "Percent40",
/**
- * Specifies the style "Dark style 1 - Accent 2" in UI.
+ * 50 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle1Accent2 = "DarkStyle1Accent2",
+ percent50 = "Percent50",
/**
- * Specifies the style "Dark style 1 - Accent 3" in UI.
+ * 60 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle1Accent3 = "DarkStyle1Accent3",
+ percent60 = "Percent60",
/**
- * Specifies the style "Dark style 1 - Accent 4" in UI.
+ * 70 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle1Accent4 = "DarkStyle1Accent4",
+ percent70 = "Percent70",
/**
- * Specifies the style "Dark style 1 - Accent 5" in UI.
+ * 75 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle1Accent5 = "DarkStyle1Accent5",
+ percent75 = "Percent75",
/**
- * Specifies the style "Dark style 1 - Accent 6" in UI.
+ * 80 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle1Accent6 = "DarkStyle1Accent6",
+ percent80 = "Percent80",
/**
- * Specifies the style "Dark Style 2" in UI.
+ * 90 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle2 = "DarkStyle2",
+ percent90 = "Percent90",
/**
- * Specifies the style "Dark style 2 - Accent 1/Accent 2" in UI.
+ * Horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle2Accent1 = "DarkStyle2Accent1",
+ horizontal = "Horizontal",
/**
- * Specifies the style "Dark style 2 - Accent 3/Accent 4" in UI.
+ * Vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle2Accent2 = "DarkStyle2Accent2",
+ vertical = "Vertical",
/**
- * Specifies the style "Dark style 2 - Accent 5/Accent 6" in UI.
+ * Light horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- darkStyle2Accent3 = "DarkStyle2Accent3",
- }
- /**
- * Represents the available table style settings.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- class TableStyleSettings 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;
+ lightHorizontal = "LightHorizontal",
/**
- * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
- *
+ * Light vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- areColumnsBanded: boolean;
+ lightVertical = "LightVertical",
/**
- * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
- *
+ * Dark horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- areRowsBanded: boolean;
+ darkHorizontal = "DarkHorizontal",
/**
- * Specifies if the first column contains special formatting.
- *
+ * Dark vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- isFirstColumnHighlighted: boolean;
+ darkVertical = "DarkVertical",
/**
- * Specifies if the first row contains special formatting.
- *
+ * Narrow horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- isFirstRowHighlighted: boolean;
+ narrowHorizontal = "NarrowHorizontal",
/**
- * Specifies if the last column contains special formatting.
- *
+ * Narrow vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- isLastColumnHighlighted: boolean;
+ narrowVertical = "NarrowVertical",
/**
- * Specifies if the last row contains special formatting.
- *
+ * Dashed horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- isLastRowHighlighted: boolean;
+ dashedHorizontal = "DashedHorizontal",
/**
- * Specifies the table style.
- *
+ * Dashed vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
- */
- style: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
- /**
- * 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.TableStyleSettingsLoadOptions): PowerPoint.TableStyleSettings;
- /**
- * 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.TableStyleSettings;
- /**
- * 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.TableStyleSettings;
- /**
- * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
+ * [Api set: PowerPointApi 1.10]
*/
- toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;
- }
- /**
- * 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;
+ dashedVertical = "DashedVertical",
/**
- * Gets the collection of columns in the table.
- *
+ * Cross pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly columns: PowerPoint.TableColumnCollection;
+ cross = "Cross",
/**
- * Gets the collection of rows in the table.
- *
+ * Downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly rows: PowerPoint.TableRowCollection;
+ downwardDiagonal = "DownwardDiagonal",
/**
- * Gets the table style settings.
- *
+ * Upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly styleSettings: PowerPoint.TableStyleSettings;
+ upwardDiagonal = "UpwardDiagonal",
/**
- * Gets the number of columns in the table.
- *
+ * Light downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly columnCount: number;
+ lightDownwardDiagonal = "LightDownwardDiagonal",
/**
- * Gets the number of rows in the table.
- *
+ * Light upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly rowCount: number;
+ lightUpwardDiagonal = "LightUpwardDiagonal",
/**
- * Gets all of the values in the table.
- *
+ * Dark downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- readonly values: string[][];
+ darkDownwardDiagonal = "DarkDownwardDiagonal",
/**
- * Clears table values and formatting.
- *
+ * Dark upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
- *
- * @param options Provides options for clearing the table.
+ * [Api set: PowerPointApi 1.10]
*/
- clear(options?: PowerPoint.TableClearOptions): void;
+ darkUpwardDiagonal = "DarkUpwardDiagonal",
/**
- * Gets the cell at the specified `rowIndex` and `columnIndex`.
- *
+ * Wide downward diagonal pattern fill.
* @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. 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}.
+ * [Api set: PowerPointApi 1.10]
*/
- getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
+ wideDownwardDiagonal = "WideDownwardDiagonal",
/**
- * Gets a collection of cells that represent the merged areas of the table.
- *
+ * Wide upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
- * @returns a `TableCellCollection` with cells that represent the merged areas of the table.
+ * [Api set: PowerPointApi 1.10]
*/
- getMergedAreas(): PowerPoint.TableCellCollection;
+ wideUpwardDiagonal = "WideUpwardDiagonal",
/**
- * Gets the shape object for the table.
- *
+ * Dashed downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- getShape(): PowerPoint.Shape;
+ dashedDownwardDiagonal = "DashedDownwardDiagonal",
/**
- * Creates a merged area starting at the cell specified by rowIndex and columnIndex. The merged area spans across a specified number of rows and columns.
- *
+ * Dashed upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.9]
- *
- * @param rowIndex The zero-based row index of the cell to start the merged area.
- * @param columnIndex The zero-based column index of the cell to start the merged area.
- * @param rowCount The number of rows to merge with the starting cell. Must be greater than 0.
- * @param columnCount The number of columns to merge with the starting cell. Must be greater than 0.
+ * [Api set: PowerPointApi 1.10]
*/
- mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void;
+ dashedUpwardDiagonal = "DashedUpwardDiagonal",
/**
- * 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.
+ * Diagonal cross pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;
+ diagonalCross = "DiagonalCross",
/**
- * 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.
+ * Small checker board pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNames?: string | string[]): PowerPoint.Table;
+ smallCheckerBoard = "SmallCheckerBoard",
/**
- * 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.
+ * Large checker board pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- load(propertyNamesAndPaths?: {
- select?: string;
- expand?: string;
- }): PowerPoint.Table;
+ largeCheckerBoard = "LargeCheckerBoard",
/**
- * 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;
- }
- /**
- * Represents the fill formatting of a table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- interface FillProperties {
+ * Small grid pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ smallGrid = "SmallGrid",
/**
- * Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
- *
+ * Large grid pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- color?: string | undefined;
+ largeGrid = "LargeGrid",
/**
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
- *
+ * Dotted grid pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- transparency?: number | undefined;
- }
- /**
- * Represents the properties for a table cell border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- interface BorderProperties {
+ dottedGrid = "DottedGrid",
/**
- * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
- *
+ * Small confetti pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- color?: string | undefined;
+ smallConfetti = "SmallConfetti",
/**
- * Represents the dash style of the line.
- *
+ * Large confetti pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
+ largeConfetti = "LargeConfetti",
/**
- * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
- *
+ * Horizontal brick pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- transparency?: number | undefined;
+ horizontalBrick = "HorizontalBrick",
/**
- * Represents the weight of the line, in points.
- *
+ * Diagonal brick pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- weight?: number | undefined;
- }
- /**
- * Represents the borders of a table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- interface TableCellBorders {
+ diagonalBrick = "DiagonalBrick",
/**
- * Represents the bottom border.
- *
+ * Solid diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- bottom?: PowerPoint.BorderProperties;
+ solidDiamond = "SolidDiamond",
/**
- * Represents the diagonal border (top-left to bottom-right).
- *
+ * Outlined diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- diagonalDown?: PowerPoint.BorderProperties;
+ outlinedDiamond = "OutlinedDiamond",
/**
- * Represents the diagonal border (bottom-left to top-right).
- *
+ * Dotted diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- diagonalUp?: PowerPoint.BorderProperties;
+ dottedDiamond = "DottedDiamond",
/**
- * Represents the left border.
- *
+ * Plaid pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- left?: PowerPoint.BorderProperties;
+ plaid = "Plaid",
/**
- * Represents the right border.
- *
+ * Sphere pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- right?: PowerPoint.BorderProperties;
+ sphere = "Sphere",
/**
- * Represents the top border.
- *
+ * Weave pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- top?: PowerPoint.BorderProperties;
- }
- /**
- * Represents the margins of a table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- interface TableCellMargins {
+ weave = "Weave",
/**
- * Specifies the bottom margin in points.
- *
+ * Divot pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- bottom?: number | undefined;
+ divot = "Divot",
/**
- * Specifies the left margin in points.
- *
+ * Shingle pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- left?: number | undefined;
+ shingle = "Shingle",
/**
- * Specifies the right margin in points.
- *
+ * Wave pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- right?: number | undefined;
+ wave = "Wave",
/**
- * Specifies the top margin in points.
- *
+ * Trellis pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- top?: number | undefined;
+ trellis = "Trellis",
+ /**
+ * Zig zag pattern fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ zigZag = "ZigZag",
}
/**
- * Represents the table cell properties to update.
+ * Represents {@link PowerPoint.SlideBackground} pattern fill properties.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- interface TableCellProperties {
+ class SlideBackgroundPatternFill 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 border formatting of the table cell.
+ * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- borders?: PowerPoint.TableCellBorders;
+ backgroundColor: string;
/**
- * Specifies the fill formatting of the table cell.
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- fill?: PowerPoint.FillProperties;
+ foregroundColor: string;
/**
- * Specifies the font formatting of the table cell.
+ * Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- font?: PowerPoint.FontProperties;
+ pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
/**
- * Specifies the horizontal alignment of the text in the table cell.
+ * 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.8]
+ * @param options Provides options for which properties of the object to load.
*/
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
+ load(options?: PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions): PowerPoint.SlideBackgroundPatternFill;
/**
- * Specifies the indent level of the text in the table cell.
+ * 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.8]
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
*/
- indentLevel?: number | undefined;
+ load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPatternFill;
/**
- * Specifies the margin settings in the table cell.
+ * 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.8]
+ * @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.
*/
- margins?: PowerPoint.TableCellMargins;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideBackgroundPatternFill;
/**
- * Specifies the text content of the table cell.
-
- If a portion of the text requires different formatting, use the `textRuns` property instead.
+ * 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.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;
+ }
+ /**
+ * Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundPatternFillOptions {
+ /**
+ * If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- text?: string;
+ backgroundColor?: string;
/**
- * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
- Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
+ * If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- textRuns?: PowerPoint.TextRun[];
+ foregroundColor?: string;
/**
- * Specifies the vertical alignment of the text in the table cell.
+ * If provided, specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
}
/**
- * Provides the table column properties.
+ * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- interface TableColumnProperties {
+ class SlideBackgroundPictureOrTextureFill 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 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 doesn't have a defined width,
- a default column width will be used.
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- columnWidth?: number | undefined;
- }
- /**
- * Represents the properties of a merged area of cells in a table.
- *
- * @remarks
- * [Api set: PowerPointApi 1.8]
- */
- interface TableMergedAreaProperties {
+ transparency: number;
/**
- * Specifies the number of columns for the merged cells area.
- Must be 1 or greater.
+ * Sets the image used to fill.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param base64EncodedImage A string that is a Base64 encoding of the image data.
*/
- columnCount: number;
+ setImage(base64EncodedImage: string): void;
/**
- * Specifies the zero-based index of the column of the top left cell of the merged area.
+ * 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.8]
+ * @param options Provides options for which properties of the object to load.
*/
- columnIndex: number;
+ load(options?: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions): PowerPoint.SlideBackgroundPictureOrTextureFill;
/**
- * Specifies the number of rows for the merged cells area.
- Must be 1 or greater.
+ * 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.8]
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
*/
- rowCount: number;
+ load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPictureOrTextureFill;
/**
- * Specifies the zero-based index of the row of the top left cell of the merged area.
+ * 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.8]
+ * @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.
*/
- rowIndex: number;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideBackgroundPictureOrTextureFill;
+ /**
+ * 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.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;
}
/**
- * Provides the table row properties.
+ * Represents {@link PowerPoint.SlideBackground} picture or texture fill options.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- interface TableRowProperties {
+ interface SlideBackgroundPictureOrTextureFillOptions {
/**
- * 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 doesn't have a defined height,
- a default row height will be used.
+ * If provided, specifies the Base64-encoded image data for the fill.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- rowHeight?: number | undefined;
+ imageBase64?: string;
+ /**
+ * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency: number;
}
/**
- * Represents the available options when adding a table.
+ * Specifies the fill type for a {@link PowerPoint.SlideBackground}.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- interface TableAddOptions {
+ enum SlideBackgroundFillType {
/**
- * 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.
- *
+ * Unsupported slide background fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- columns?: PowerPoint.TableColumnProperties[];
+ unsupported = "Unsupported",
/**
- * Specifies the height, in points, of the table.
- A default value is used when this parameter isn't provided.
- Throws an `InvalidArgument` exception when set with a negative value.
-
- Note: If the table height isn't evenly divisible by the number of rows, PowerPoint sets it to the nearest possible value.
- For example, a height of 400 for 3 rows may result in an actual height of 399.9999.
- *
+ * Specifies that the slide background should have regular solid fill.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ solid = "Solid",
+ /**
+ * Specifies that the slide background should have gradient fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- height?: number | undefined;
+ gradient = "Gradient",
/**
- * 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 isn't provided.
- *
+ * Specifies that the slide background should have picture or texture fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- left?: number | undefined;
+ pictureOrTexture = "PictureOrTexture",
/**
- * If specified, represents an rectangular area where multiple cells appear as a single cell.
- *
+ * Specifies that the slide background should have pattern fill.
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- mergedAreas?: PowerPoint.TableMergedAreaProperties[];
+ pattern = "Pattern",
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} solid fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class SlideBackgroundSolidFill 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;
/**
- * 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.
+ * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- rows?: PowerPoint.TableRowProperties[];
+ color: string;
/**
- * If provided, specifies properties for each cell in the table.
-
- This should be a 2D array with the same number of rows and columns as the table.
- If a cell doesn't 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.
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- specificCellProperties?: PowerPoint.TableCellProperties[][];
+ transparency: number;
/**
- * Specifies value that represents the table style.
+ * 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.9]
+ * @param options Provides options for which properties of the object to load.
*/
- style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3";
+ load(options?: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions): PowerPoint.SlideBackgroundSolidFill;
/**
- * 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 isn't provided.
+ * 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.8]
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
*/
- top?: number | undefined;
+ load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundSolidFill;
/**
- * 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 don't specify `specificCellProperties`.
+ * 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.8]
+ * @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.
*/
- uniformCellProperties?: PowerPoint.TableCellProperties;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideBackgroundSolidFill;
/**
- * 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.
+ * 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.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;
+ }
+ /**
+ * Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundSolidFillOptions {
+ /**
+ * If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- values?: string[][];
+ color?: string;
/**
- * Specifies the width, in points, of the table.
- A default value is used when this parameter isn't provided.
- Throws an `InvalidArgument` exception when set with a negative value.
-
- Note: If the table width isn't evenly divisible by the number of columns, PowerPoint sets it to the nearest possible value.
- For example, a width of 400 for 3 columns may result in an actual width of 399.9999.
+ * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- width?: number | undefined;
+ transparency?: number;
}
/**
- * Represents the collection of shapes.
+ * Represents the fill formatting of a slide background object.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.10]
*/
- class ShapeCollection extends OfficeExtension.ClientObject {
+ class SlideBackgroundFill 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.
+ * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
*
* @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.10]
*/
- addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
+ readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
/**
- * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
+ * Gets the gradient fill properties. If the fill type is not `gradient`, 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.4]
+ * [Api set: PowerPointApi 1.10]
+ */
+ getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;
+ /**
+ * Gets the pattern fill properties. If the fill type is not `pattern`, 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}.
*
- * @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.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- 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;
+ getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;
/**
- * Create a shape group for several shapes.
+ * Gets the picture or texture fill properties. If the fill type is not `pictureOrTexture`, 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.8]
+ * [Api set: PowerPointApi 1.10]
+ */
+ getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;
+ /**
+ * Gets the solid fill properties. If the fill type is not `solid`, 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}.
*
- * @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.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- addGroup(values: Array): PowerPoint.Shape;
+ getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;
/**
- * Adds a line to the slide. Returns a `Shape` object that represents the new line.
+ * Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*
- * @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.
+ * @param options Options for the gradient fill.
*/
- addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
+ setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions): void;
/**
- * Adds a line to the slide. Returns a `Shape` object that represents the new line.
+ * Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*
- * @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.
+ * @param options Options for the pattern fill.
*/
- addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
+ setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions): void;
/**
- * 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.
+ * Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*
- * @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.
+ * @param options Options for the picture or texture fill.
*/
- addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape;
+ setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void;
/**
- * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
+ * Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*
- * @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.
+ * @param options Options for the solid fill.
*/
- addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
+ setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions): void;
/**
- * Gets the number of shapes in the collection.
+ * 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.3]
- * @returns The number of shapes in the collection.
+ * @param options Provides options for which properties of the object to load.
*/
- getCount(): OfficeExtension.ClientResult;
+ load(options?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions): PowerPoint.SlideBackgroundFill;
/**
- * Gets a shape using its unique ID. An error is thrown if the shape doesn't exist.
+ * 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.3]
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundFill;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
- * @param key The ID of the shape.
- * @returns The shape with the unique ID. If such a shape doesn't exist, an error is thrown.
+ * @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.
*/
- getItem(key: string): PowerPoint.Shape;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideBackgroundFill;
/**
- * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
+ * 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.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;
+ }
+ /**
+ * Represents a background of a slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class SlideBackground extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns the fill formatting of the background.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly fill: PowerPoint.SlideBackgroundFill;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
- * @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.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- getItemAt(index: number): PowerPoint.Shape;
+ areBackgroundGraphicsHidden: boolean;
/**
- * Gets a shape using its unique ID. If such a shape doesn't 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}.
+ * Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed: boolean;
+ /**
+ * Resets the fill formatting of the slide background.
*
- * @param id The ID of the shape.
- * @returns The shape with the unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
*/
- getItemOrNullObject(id: string): PowerPoint.Shape;
+ reset(): 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.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
+ load(options?: PowerPoint.Interfaces.SlideBackgroundLoadOptions): PowerPoint.SlideBackground;
/**
* 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;
+ load(propertyNames?: string | string[]): PowerPoint.SlideBackground;
/**
* 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;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideBackground;
/**
- * 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;
+ * 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.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideBackgroundData;
}
/**
* Represents the available options when getting an image of a slide.
@@ -182833,17 +184284,81 @@ declare namespace PowerPoint {
/**
* The desired height of the resulting image in pixels.
*
- * @remarks
- * [Api set: PowerPointApi 1.8]
+ * @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;
+ }
+ /**
+ * Represents the background of a slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class SlideLayoutBackground extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly fill: PowerPoint.SlideBackgroundFill;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden: boolean;
+ /**
+ * Specifies if the slide layout background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed: boolean;
+ /**
+ * Resets the fill formatting of the slide layout background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ reset(): 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.SlideLayoutBackgroundLoadOptions): PowerPoint.SlideLayoutBackground;
+ /**
+ * 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.
*/
- height?: number;
+ load(propertyNames?: string | string[]): PowerPoint.SlideLayoutBackground;
/**
- * The desired width of the resulting image in pixels.
+ * 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.8]
+ * @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.
*/
- width?: number;
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): PowerPoint.SlideLayoutBackground;
+ /**
+ * 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.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;
}
/**
* Specifies the type of a slide layout.
@@ -183075,6 +184590,155 @@ declare namespace PowerPoint {
*/
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
}
+ /**
+ * Specifies the theme colors used in PowerPoint.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum ThemeColor {
+ /**
+ * Specifies a mixed theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ mixed = "Mixed",
+ /**
+ * Specifies no theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ none = "None",
+ /**
+ * Specifies the Accent 1 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent1 = "Accent1",
+ /**
+ * Specifies the Accent 2 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent2 = "Accent2",
+ /**
+ * Specifies the Accent 3 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent3 = "Accent3",
+ /**
+ * Specifies the Accent 4 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent4 = "Accent4",
+ /**
+ * Specifies the Accent 5 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent5 = "Accent5",
+ /**
+ * Specifies the Accent 6 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ accent6 = "Accent6",
+ /**
+ * Specifies the Dark 1 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dark1 = "Dark1",
+ /**
+ * Specifies the Dark 2 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ dark2 = "Dark2",
+ /**
+ * Specifies the clicked hyperlink theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ followedHyperlink = "FollowedHyperlink",
+ /**
+ * Specifies the hyperlink theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ hyperlink = "Hyperlink",
+ /**
+ * Specifies the Light 1 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ light1 = "Light1",
+ /**
+ * Specifies the Light 2 theme color.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ light2 = "Light2",
+ }
+ /**
+ * Represents a theme color scheme.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class ThemeColorScheme 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 color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color The theme color.
+ * @returns The color value in #RRGGBB format (e.g., "FFA500").
+ */
+ getThemeColor(color: PowerPoint.ThemeColor): OfficeExtension.ClientResult;
+ /**
+ * Gets the color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color The theme color.
+ * @returns The color value in #RRGGBB format (e.g., "FFA500").
+ */
+ getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"): OfficeExtension.ClientResult;
+ /**
+ * Sets the color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color The theme color.
+ * @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
+ */
+ setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;
+ /**
+ * Sets the color value for the specified `ThemeColor`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param color The theme color.
+ * @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
+ */
+ setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;
+ /**
+ * 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.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): {
+ [key: string]: string;
+ };
+ }
/**
* Represents the layout of a slide.
*
@@ -183084,6 +184748,13 @@ declare namespace PowerPoint {
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;
+ /**
+ * Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly background: PowerPoint.SlideLayoutBackground;
/**
* Returns a collection of custom XML parts in the slide layout.
*
@@ -183098,6 +184769,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+ /**
+ * Returns the `ThemeColorScheme` of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
* Gets the unique ID of the slide layout.
*
@@ -183141,9 +184819,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -183215,11 +184893,54 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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 background of a slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class SlideMasterBackground extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly fill: PowerPoint.SlideBackgroundFill;
+ /**
+ * 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.SlideMasterBackgroundLoadOptions): PowerPoint.SlideMasterBackground;
+ /**
+ * 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.SlideMasterBackground;
+ /**
+ * 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.SlideMasterBackground;
+ /**
+ * 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.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData;
+ }
/**
* Represents the Slide Master of a slide.
*
@@ -183229,6 +184950,13 @@ declare namespace PowerPoint {
class SlideMaster extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+ /**
+ * Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly background: PowerPoint.SlideMasterBackground;
/**
* Returns a collection of custom XML parts in the Slide Master.
*
@@ -183250,6 +184978,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly shapes: PowerPoint.ShapeCollection;
+ /**
+ * Returns the `ThemeColorScheme` of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
* Gets the unique ID of the Slide Master.
*
@@ -183286,9 +185021,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -183336,9 +185071,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -183428,9 +185163,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -183442,6 +185177,13 @@ declare namespace PowerPoint {
class Slide extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
context: RequestContext;
+ /**
+ * Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly background: PowerPoint.SlideBackground;
/**
* Returns a collection of custom XML parts in the slide.
*
@@ -183484,6 +185226,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly tags: PowerPoint.TagCollection;
+ /**
+ * Returns the `ThemeColorScheme` of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
* Gets the unique ID of the slide.
*
@@ -183575,11 +185324,59 @@ declare namespace PowerPoint {
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.
- */
+ * 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 the format of an image.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ enum ShapeGetImageFormatType {
+ /**
+ * The picture is in PNG format.
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ png = "Png",
+ }
+ /**
+ * Represents the available options when getting an image of a shape.
+ The image is scaled to fit into the desired dimensions. If width and height aren't specified, the true size of the shape is used.
+ If only one of either width or height is specified, the other will be calculated to preserve aspect ratio.
+ The resulting dimensions will automatically be clamped to the maximum supported size if too large.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface ShapeGetImageOptions {
+ /**
+ * The desired format of the resulting image.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ format?: PowerPoint.ShapeGetImageFormatType | "Png";
+ /**
+ * The desired height of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
+ Throws an `InvalidArgument` exception when set with a non-positive integer.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ height?: number;
+ /**
+ * The desired width of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
+ Throws an `InvalidArgument` exception when set with a non-positive integer.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ width?: number;
+ }
/**
* Represents a collection of shapes.
*
@@ -183657,9 +185454,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -183685,6 +185482,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.8]
*/
readonly shapes: PowerPoint.ShapeScopedCollection;
+ /**
+ * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly creationId: string | null;
/**
* Gets the unique ID of the shape group.
*
@@ -183837,9 +185641,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -183883,6 +185687,13 @@ declare namespace PowerPoint {
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 an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly adjustments: PowerPoint.Adjustments;
/**
* Returns a collection of custom XML parts in the shape.
*
@@ -183942,6 +185753,34 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
readonly textFrame: PowerPoint.TextFrame;
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription: string;
+ /**
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle: string;
+ /**
+ * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ readonly creationId: string | null;
/**
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -183956,6 +185795,16 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
readonly id: string;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative: boolean;
/**
* The distance, in points, from the left side of the shape to the left side of the slide.
*
@@ -183983,6 +185832,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
name: string;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation: number;
/**
* The distance, in points, from the top edge of the shape to the top edge of the slide.
*
@@ -183997,6 +185854,13 @@ declare namespace PowerPoint {
* [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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible: boolean;
/**
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -184019,6 +185883,16 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
delete(): void;
+ /**
+ * Renders an image of the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options Optional. Options to specify the desired output image properties.
+ * @returns A Base64-encoded string of the shape image in the specified format.
+ */
+ getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions): OfficeExtension.ClientResult;
/**
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
*
@@ -184068,6 +185942,24 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.8]
*/
getTable(): PowerPoint.Table;
+ /**
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. If the shape doesn't support a `TextFrame`, 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.10]
+ */
+ getTextFrameOrNullObject(): PowerPoint.TextFrame;
+ /**
+ * Sets a hyperlink on this `Shape` with the specified options. This will delete any existing hyperlink on this `Shape`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param options Optional. The options for the hyperlink.
+ * @returns The newly created {@link PowerPoint.Hyperlink} object.
+ */
+ setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;
/**
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
*
@@ -184108,9 +186000,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -184383,9 +186275,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -184436,6 +186328,17 @@ declare namespace PowerPoint {
* 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 zero-based index in the collection.
+ Throws an `InvalidArgument` exception when the index is out of range.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param index The index of the custom property in the collection.
+ * @returns The custom property at the given index.
+ */
+ getItemAt(index: number): 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`.
@@ -184467,9 +186370,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -184587,9 +186490,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -184647,6 +186550,56 @@ declare namespace PowerPoint {
*/
targetSlideId?: string;
}
+ /**
+ * Represents the page setup information for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ class PageSetup 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 height of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideHeight: number;
+ /**
+ * Specifies the width of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth: 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.PageSetupLoadOptions): PowerPoint.PageSetup;
+ /**
+ * 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.PageSetup;
+ /**
+ * 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.PageSetup;
+ /**
+ * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): PowerPoint.Interfaces.PageSetupData;
+ }
/**
* Represents the collection of slides in the presentation.
*
@@ -184667,6 +186620,17 @@ declare namespace PowerPoint {
* @param options Optional. Options for configuring the properties of the new slide.
*/
add(options?: PowerPoint.AddSlideOptions): void;
+ /**
+ * Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.
+ Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ *
+ * @param values An array of slide IDs or `Slide` objects.
+ * @returns A Base64-encoded string.
+ */
+ exportAsBase64Presentation(values: Array): OfficeExtension.ClientResult;
/**
* Gets the number of slides in the collection.
*
@@ -184726,9 +186690,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -184742,6 +186706,14 @@ declare namespace PowerPoint {
context: RequestContext;
/** Gets the loaded child items in this collection. */
readonly items: PowerPoint.Slide[];
+ /**
+ * Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ * @returns A Base64-encoded string.
+ */
+ exportAsBase64Presentation(): OfficeExtension.ClientResult;
/**
* Gets the number of slides in the collection.
*
@@ -184800,9 +186772,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -184874,9 +186846,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -184904,8 +186876,28 @@ declare namespace PowerPoint {
interface CustomXmlPartCollectionUpdateData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */
+ interface HyperlinkScopedCollectionUpdateData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
interface BulletFormatUpdateData {
+ /**
+ * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ /**
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -184923,17 +186915,24 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+ /**
+ * Represents the indent level of the paragraph.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ indentLevel?: number;
}
/** 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -184942,11 +186941,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -184962,11 +186961,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -184975,11 +186974,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -185002,11 +187001,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185015,11 +187014,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185028,11 +187027,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185041,11 +187040,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185364,6 +187363,101 @@ declare namespace PowerPoint {
interface ShapeCollectionUpdateData {
items?: PowerPoint.Interfaces.ShapeData[];
}
+ /** An interface for updating data on the `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
+ interface SlideBackgroundGradientFillUpdateData {
+ /**
+ * Specifies the type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ }
+ /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
+ interface SlideBackgroundPatternFillUpdateData {
+ /**
+ * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor?: string;
+ /**
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor?: string;
+ /**
+ * Specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
+ }
+ /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
+ interface SlideBackgroundPictureOrTextureFillUpdateData {
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
+ interface SlideBackgroundSolidFillUpdateData {
+ /**
+ * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color?: string;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
+ interface SlideBackgroundUpdateData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
+ interface SlideLayoutBackgroundUpdateData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide layout background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
interface SlideLayoutCollectionUpdateData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
@@ -185433,6 +187527,27 @@ declare namespace PowerPoint {
}
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
interface ShapeUpdateData {
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription?: string;
+ /**
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: string;
/**
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -185440,6 +187555,16 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
height?: number;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: boolean;
/**
* The distance, in points, from the left side of the shape to the left side of the slide.
*
@@ -185454,6 +187579,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
name?: string;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: number;
/**
* The distance, in points, from the top edge of the shape to the top edge of the slide.
*
@@ -185461,6 +187594,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
top?: number;
+ /**
+ * Specifies if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: boolean;
/**
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -185554,6 +187694,23 @@ declare namespace PowerPoint {
*/
title?: string;
}
+ /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
+ interface PageSetupUpdateData {
+ /**
+ * Specifies the height of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideHeight?: number;
+ /**
+ * Specifies the width of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth?: number;
+ }
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
interface SlideCollectionUpdateData {
items?: PowerPoint.Interfaces.SlideData[];
@@ -185583,6 +187740,16 @@ declare namespace PowerPoint {
*/
title?: string;
}
+ /** An interface describing the data returned by calling `adjustments.toJSON()`. */
+ interface AdjustmentsData {
+ /**
+ * Specifies the number of adjustment points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ count?: number;
+ }
/** An interface describing the data returned by calling `customXmlPart.toJSON()`. */
interface CustomXmlPartData {
/**
@@ -185608,8 +187775,28 @@ declare namespace PowerPoint {
interface CustomXmlPartCollectionData {
items?: PowerPoint.Interfaces.CustomXmlPartData[];
}
+ /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */
+ interface HyperlinkScopedCollectionData {
+ items?: PowerPoint.Interfaces.HyperlinkData[];
+ }
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
interface BulletFormatData {
+ /**
+ * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
+ /**
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -185627,17 +187814,24 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
+ /**
+ * Represents the indent level of the paragraph.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ indentLevel?: number;
}
/** 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185646,11 +187840,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -185666,11 +187860,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185679,11 +187873,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -185706,11 +187900,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185719,11 +187913,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185732,11 +187926,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185745,11 +187939,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -185864,6 +188058,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: string;
+ /**
+ * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";
}
/** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */
interface PlaceholderFormatData {
@@ -186178,6 +188379,111 @@ declare namespace PowerPoint {
interface ShapeCollectionData {
items?: PowerPoint.Interfaces.ShapeData[];
}
+ /** An interface describing the data returned by calling `slideBackgroundGradientFill.toJSON()`. */
+ interface SlideBackgroundGradientFillData {
+ /**
+ * Specifies the type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
+ interface SlideBackgroundPatternFillData {
+ /**
+ * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor?: string;
+ /**
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor?: string;
+ /**
+ * Specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
+ }
+ /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
+ interface SlideBackgroundPictureOrTextureFillData {
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
+ interface SlideBackgroundSolidFillData {
+ /**
+ * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color?: string;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: number;
+ }
+ /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
+ interface SlideBackgroundFillData {
+ /**
+ * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
+ }
+ /** An interface describing the data returned by calling `slideBackground.toJSON()`. */
+ interface SlideBackgroundData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
+ interface SlideLayoutBackgroundData {
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide layout background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
interface SlideLayoutData {
/**
@@ -186206,6 +188512,9 @@ declare namespace PowerPoint {
interface SlideLayoutCollectionData {
items?: PowerPoint.Interfaces.SlideLayoutData[];
}
+ /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
+ interface SlideMasterBackgroundData {
+ }
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
interface SlideMasterData {
/**
@@ -186267,6 +188576,13 @@ declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
interface ShapeGroupData {
+ /**
+ * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: string | null;
/**
* Gets the unique ID of the shape group.
*
@@ -186322,6 +188638,34 @@ declare namespace PowerPoint {
}
/** An interface describing the data returned by calling `shape.toJSON()`. */
interface ShapeData {
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextDescription?: string;
+ /**
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: string;
+ /**
+ * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: string | null;
/**
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -186336,6 +188680,16 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
id?: string;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: boolean;
/**
* The distance, in points, from the left side of the shape to the left side of the slide.
*
@@ -186363,6 +188717,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
name?: string;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: number;
/**
* The distance, in points, from the top edge of the shape to the top edge of the slide.
*
@@ -186377,6 +188739,13 @@ declare namespace PowerPoint {
* [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 if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: boolean;
/**
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -186523,6 +188892,23 @@ declare namespace PowerPoint {
*/
title?: string;
}
+ /** An interface describing the data returned by calling `pageSetup.toJSON()`. */
+ interface PageSetupData {
+ /**
+ * Specifies the height of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideHeight?: number;
+ /**
+ * Specifies the width of the slides in the presentation, in points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth?: number;
+ }
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
interface SlideCollectionData {
items?: PowerPoint.Interfaces.SlideData[];
@@ -186549,11 +188935,18 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the properties of the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi 1.7]
- */
+ * Returns the page setup information whose properties control slide setup attributes for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;
+ /**
+ * Gets the properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
/**
* Gets the ID of the presentation.
@@ -186570,6 +188963,25 @@ declare namespace PowerPoint {
*/
title?: boolean;
}
+ /**
+ * Represents the adjustment values for a shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface AdjustmentsLoadOptions {
+ /**
+ 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 number of adjustment points.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ count?: boolean;
+ }
/**
* Represents a custom XML part object.
*
@@ -186650,6 +189062,39 @@ declare namespace PowerPoint {
*/
namespaceUri?: boolean;
}
+ /**
+ * Represents a scoped collection of hyperlinks.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface HyperlinkScopedCollectionLoadOptions {
+ /**
+ 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 address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
+ *
+ * @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;
+ /**
+ * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
+ }
/**
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
*
@@ -186661,6 +189106,22 @@ 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 the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ style?: boolean;
+ /**
+ * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
+ Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
/**
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
*
@@ -186694,6 +189155,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
horizontalAlignment?: boolean;
+ /**
+ * Represents the indent level of the paragraph.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ indentLevel?: boolean;
}
/**
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -186988,6 +189456,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+ /**
+ * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
}
/**
* Represents the properties of a `placeholder` shape.
@@ -187041,6 +189516,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.6]
*/
screenTip?: boolean;
+ /**
+ * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
}
/**
* Represents the properties for a table cell border.
@@ -187094,46 +189576,46 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the bottom border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
bottom?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (top-left to bottom-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (bottom-left to top-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the left border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
left?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the right border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
- right?: PowerPoint.Interfaces.BorderLoadOptions;
- /**
- * Gets the top border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
+ right?: PowerPoint.Interfaces.BorderLoadOptions;
+ /**
+ * Gets the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
top?: PowerPoint.Interfaces.BorderLoadOptions;
}
/**
@@ -187221,32 +189703,32 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* Gets the number of table columns this cell spans across.
@@ -187327,32 +189809,32 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
@@ -187612,11 +190094,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the table style settings.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions;
/**
* Gets the number of columns in the table.
@@ -187652,11 +190134,18 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
+ /**
+ * 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.
@@ -187667,11 +190156,11 @@ declare namespace PowerPoint {
*/
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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.
@@ -187691,11 +190180,39 @@ declare namespace PowerPoint {
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ /**
+ * For EACH ITEM in the collection: The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ altTextDescription?: boolean;
+ /**
+ * For EACH ITEM in the collection: The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ altTextTitle?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: boolean;
/**
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -187710,6 +190227,16 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
id?: boolean;
+ /**
+ * For EACH ITEM in the collection: Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: 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.
*
@@ -187737,6 +190264,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
name?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: 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.
*
@@ -187750,22 +190285,211 @@ declare namespace PowerPoint {
* @remarks
* [Api set: PowerPointApi 1.4]
*/
- type?: boolean;
+ type?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: 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 {@link PowerPoint.SlideBackground} gradient fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundGradientFillLoadOptions {
+ /**
+ 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 type of gradient fill.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} pattern fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundPatternFillLoadOptions {
+ /**
+ 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 background color in HTML color format (e.g., "#FFFFFF" or "white").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ backgroundColor?: boolean;
+ /**
+ * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ foregroundColor?: boolean;
+ /**
+ * Specifies the pattern type.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ pattern?: boolean;
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundPictureOrTextureFillLoadOptions {
+ /**
+ 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 transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: boolean;
+ }
+ /**
+ * Represents {@link PowerPoint.SlideBackground} solid fill properties.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundSolidFillLoadOptions {
+ /**
+ 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 fill color in HTML color format (e.g., "#FFA500" or "orange").
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ color?: boolean;
+ /**
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ transparency?: boolean;
+ }
+ /**
+ * Represents the fill formatting of a slide background object.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundFillLoadOptions {
+ /**
+ 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 type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ type?: boolean;
+ }
+ /**
+ * Represents a background of a slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideBackgroundLoadOptions {
+ /**
+ 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 the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ areBackgroundGraphicsHidden?: boolean;
+ /**
+ * Specifies if the slide background follows the slide master background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isMasterBackgroundFollowed?: boolean;
+ }
+ /**
+ * Represents the background of a slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideLayoutBackgroundLoadOptions {
+ /**
+ 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 width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
+ /**
+ * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- width?: boolean;
+ areBackgroundGraphicsHidden?: 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.
+ * Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- zOrderPosition?: boolean;
+ isMasterBackgroundFollowed?: boolean;
}
/**
* Represents the layout of a slide.
@@ -187778,6 +190502,13 @@ 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;
+ /**
+ * Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
/**
* Gets the unique ID of the slide layout.
*
@@ -187811,6 +190542,13 @@ 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;
+ /**
+ * For EACH ITEM in the collection: Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
*
@@ -187833,6 +190571,25 @@ declare namespace PowerPoint {
*/
type?: boolean;
}
+ /**
+ * Represents the background of a slide master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ interface SlideMasterBackgroundLoadOptions {
+ /**
+ 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 the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
+ }
/**
* Represents the Slide Master of a slide.
*
@@ -187844,6 +190601,13 @@ 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;
+ /**
+ * Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
/**
* Gets the unique ID of the Slide Master.
*
@@ -187923,6 +190687,13 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
+ * Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
+ /**
* Gets the layout of the slide.
*
* @remarks
@@ -187963,50 +190734,85 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
+ /**
+ * 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.
+ * 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]
- */
+ *
+ * @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]
- */
+ * 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.
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ /**
+ * For EACH ITEM in the collection: The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ altTextDescription?: boolean;
/**
- * 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.
+ * For EACH ITEM in the collection: The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
+ altTextTitle?: boolean;
/**
- * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi 1.5]
+ * [Api set: PowerPointApi 1.10]
*/
- textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ creationId?: boolean;
/**
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -188021,6 +190827,16 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
id?: boolean;
+ /**
+ * For EACH ITEM in the collection: Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: 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.
*
@@ -188048,6 +190864,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
name?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: 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.
*
@@ -188062,6 +190886,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
type?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: 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.
*
@@ -188096,6 +190927,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.8]
*/
shape?: PowerPoint.Interfaces.ShapeLoadOptions;
+ /**
+ * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ creationId?: boolean;
/**
* Gets the unique ID of the shape group.
*
@@ -188170,50 +191008,85 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
+ /**
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the `ShapeGroup` associated with the shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the parent group of this shape.
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
+ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ /**
+ * The alt text description of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
+ altTextDescription?: boolean;
/**
- * Returns the properties that apply specifically to this placeholder.
- If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
+ * The alt text title of the Shape.
+
+ Alt text provides alternative, text-based representations of the information contained in the Shape.
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi 1.8]
+ * [Api set: PowerPointApi 1.10]
*/
- placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
+ altTextTitle?: boolean;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi 1.4]
+ * [Api set: PowerPointApi 1.10]
*/
- textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
+ creationId?: boolean;
/**
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -188228,6 +191101,16 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.3]
*/
id?: boolean;
+ /**
+ * Represents whether the shape is decorative or not.
+
+ Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
+ People using screen readers will hear these are decorative so they know they aren't missing any important information.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ isDecorative?: boolean;
/**
* The distance, in points, from the left side of the shape to the left side of the slide.
*
@@ -188255,6 +191138,14 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
name?: boolean;
+ /**
+ * Specifies the rotation, in degrees, of the shape around the z-axis.
+ A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ rotation?: boolean;
/**
* The distance, in points, from the top edge of the shape to the top edge of the slide.
*
@@ -188269,6 +191160,13 @@ declare namespace PowerPoint {
* [Api set: PowerPointApi 1.4]
*/
type?: boolean;
+ /**
+ * Specifies if the shape is visible.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ visible?: boolean;
/**
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
*
@@ -188495,29 +191393,62 @@ declare namespace PowerPoint {
title?: boolean;
}
/**
- * Represents the collection of slides in the presentation.
+ * Represents the page setup information for the presentation.
*
* @remarks
- * [Api set: PowerPointApi 1.2]
+ * [Api set: PowerPointApi 1.10]
*/
- interface SlideCollectionLoadOptions {
+ interface PageSetupLoadOptions {
/**
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.
+ * Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.10]
*/
- layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
+ slideHeight?: boolean;
/**
- * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
+ * Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi 1.3]
+ * [Api set: PowerPointApi 1.10]
+ */
+ slideWidth?: boolean;
+ }
+ /**
+ * Represents the collection of slides in the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.2]
+ */
+ 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 background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
+ /**
+ * 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.
@@ -188546,18 +191477,25 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
+ /**
+ * 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]
- */
+ * 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.
@@ -188585,6 +191523,13 @@ 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;
+ /**
+ * For EACH ITEM in the collection: Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
+ background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
*
diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts
index 28655ba690..02efeb4972 100644
--- a/generate-docs/script-inputs/office_preview.d.ts
+++ b/generate-docs/script-inputs/office_preview.d.ts
@@ -186959,9 +186959,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
};
@@ -186995,8 +186995,7 @@ declare namespace PowerPoint {
* Returns the page setup information whose properties control slide setup attributes for the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly pageSetup: PowerPoint.PageSetup;
/**
@@ -187126,9 +187125,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -187162,8 +187161,7 @@ declare namespace PowerPoint {
* Represents the adjustment values for a shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class Adjustments extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -187172,8 +187170,7 @@ declare namespace PowerPoint {
* Specifies the number of adjustment points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly count: number;
/**
@@ -187181,8 +187178,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index The index of the adjustment to retrieve.
* @returns The adjustment value at the given index.
@@ -187193,8 +187189,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index The index of the adjustment to set.
* @param value The adjustment value to set.
@@ -187222,9 +187217,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Adjustments;
/**
- * 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.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.AdjustmentsData;
}
/**
@@ -187309,9 +187304,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -187349,8 +187344,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index The index of the custom XML part in the collection.
* @returns The custom XML part at the given index.
@@ -187402,9 +187396,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -187458,8 +187452,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index The index of the custom XML part in the collection.
* @returns The custom XML part at the given index.
@@ -187495,33 +187488,30 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
* Represents the available options when adding a {@link PowerPoint.Hyperlink}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface HyperlinkAddOptions {
/**
* Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
address?: string;
/**
* Specifies the string displayed when hovering over the hyperlink.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
screenTip?: string;
}
@@ -187529,8 +187519,7 @@ declare namespace PowerPoint {
* Represents a scoped collection of hyperlinks.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class HyperlinkScopedCollection extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -187541,8 +187530,7 @@ declare namespace PowerPoint {
* Gets the number of hyperlinks in the collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
* @returns The number of hyperlinks in the collection.
*/
getCount(): OfficeExtension.ClientResult;
@@ -187551,8 +187539,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index The index of the hyperlink in the collection.
* @returns The hyperlink at the given index.
@@ -187577,9 +187564,9 @@ declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkScopedCollection;
/**
- * 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.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData;
}
/**
@@ -187636,302 +187623,259 @@ declare namespace PowerPoint {
* Specifies the style of a bullet.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum BulletStyle {
/**
* Style is unsupported.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* Lowercase alphabetical characters with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetLowercasePeriod = "AlphabetLowercasePeriod",
/**
* Uppercase alphabetical characters with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetUppercasePeriod = "AlphabetUppercasePeriod",
/**
* Arabic numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight",
/**
* Arabic numerals with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralPeriod = "ArabicNumeralPeriod",
/**
* Lowercase Roman numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth",
/**
* Lowercase Roman numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight",
/**
* Lowercase Roman numerals with period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanLowercasePeriod = "RomanLowercasePeriod",
/**
* Uppercase Roman numerals with period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanUppercasePeriod = "RomanUppercasePeriod",
/**
* Lowercase alphabetical characters with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth",
/**
* Lowercase alphabetical characters with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight",
/**
* Uppercase alphabetical characters with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth",
/**
* Uppercase alphabetical characters with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight",
/**
* Arabic numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth",
/**
* Arabic numerals.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicNumeralPlain = "ArabicNumeralPlain",
/**
* Uppercase Roman numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth",
/**
* Uppercase Roman numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight",
/**
* Simplified Chinese without a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
simplifiedChinesePlain = "SimplifiedChinesePlain",
/**
* Simplified Chinese with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
simplifiedChinesePeriod = "SimplifiedChinesePeriod",
/**
* Double-byte circled number for values up to 10.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain",
/**
* Text colored number with same color circle drawn around it.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain",
/**
* Shadow color number with circular background of normal text color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain",
/**
* Traditional Chinese without a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
traditionalChinesePlain = "TraditionalChinesePlain",
/**
* Traditional Chinese with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
traditionalChinesePeriod = "TraditionalChinesePeriod",
/**
* Arabic alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicAlphabetDash = "ArabicAlphabetDash",
/**
* Arabic Abjad alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicAbjadDash = "ArabicAbjadDash",
/**
* Hebrew alphabet with a dash.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hebrewAlphabetDash = "HebrewAlphabetDash",
/**
* Japanese/Korean numbers without a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
kanjiKoreanPlain = "KanjiKoreanPlain",
/**
* Japanese/Korean numbers with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
kanjiKoreanPeriod = "KanjiKoreanPeriod",
/**
* Double-byte Arabic numbering scheme (no punctuation).
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicDoubleBytePlain = "ArabicDoubleBytePlain",
/**
* Double-byte Arabic numbering scheme with double-byte period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
arabicDoubleBytePeriod = "ArabicDoubleBytePeriod",
/**
* Thai alphabet with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiAlphabetPeriod = "ThaiAlphabetPeriod",
/**
* Thai alphabet with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight",
/**
* Thai alphabet with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth",
/**
* Thai numerals with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiNumeralPeriod = "ThaiNumeralPeriod",
/**
* Thai numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight",
/**
* Thai numerals with both parentheses.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth",
/**
* Hindi alphabet (vowels) with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiAlphabetPeriod = "HindiAlphabetPeriod",
/**
* Hindi numerals with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiNumeralPeriod = "HindiNumeralPeriod",
/**
* Kanji Simplified Chinese with double-byte period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod",
/**
* Hindi numerals with closing parenthesis.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight",
/**
* Hindi alphabet (consonants) with a period.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hindiAlphabet1Period = "HindiAlphabet1Period",
}
@@ -187939,36 +187883,31 @@ declare namespace PowerPoint {
* Specifies the type of a bullet.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum BulletType {
/**
* Type is unsupported.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* No bullets.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
none = "None",
/**
* Numbered bullet (e.g., 1, 2, 3 or a, b, c).
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
numbered = "Numbered",
/**
* Symbol-based bullet (e.g., disc, circle, square).
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unnumbered = "Unnumbered",
}
@@ -187986,8 +187925,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
/**
@@ -187995,8 +187933,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
@@ -188028,9 +187965,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -188060,8 +187997,7 @@ declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel: number;
/**
@@ -188086,9 +188022,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -188364,9 +188300,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -188555,9 +188491,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -188580,8 +188516,7 @@ declare namespace PowerPoint {
* Returns a collection of hyperlinks that exist on this `TextRange`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;
/**
@@ -188635,8 +188570,7 @@ declare namespace PowerPoint {
* Sets a hyperlink on this `TextRange` with the specified options. This will delete all existing hyperlinks on this `TextRange`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options Optional. The options for the hyperlink.
* @returns The newly created {@link PowerPoint.Hyperlink} object.
@@ -188671,31 +188605,28 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
* Specifies the type of object that a hyperlink is applied to.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum HyperlinkType {
/**
* Specifies that the hyperlink is applied to a TextRange.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
textRange = "TextRange",
/**
* Specifies that the hyperlink is applied to a Shape.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
shape = "Shape",
}
@@ -188726,16 +188657,14 @@ declare namespace PowerPoint {
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";
/**
* Deletes the hyperlink.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
delete(): void;
/**
@@ -188744,8 +188673,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.10]
*/
getLinkedShapeOrNullObject(): PowerPoint.Shape;
/**
@@ -188754,8 +188682,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.10]
*/
getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;
/**
@@ -188780,9 +188707,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -189081,9 +189008,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -189102,8 +189029,7 @@ declare namespace PowerPoint {
The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param target The target to add the hyperlink to. Can be a {@link PowerPoint.TextRange} or a {@link PowerPoint.Shape}.
* @param options Optional. The options for the hyperlink.
@@ -189148,9 +189074,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -190508,9 +190434,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Borders;
/**
- * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.BordersData;
}
/**
@@ -190572,9 +190498,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.Margins;
/**
- * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.MarginsData;
}
/**
@@ -190965,9 +190891,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -191019,9 +190945,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -191076,9 +191002,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableColumn;
/**
- * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableColumnData;
}
/**
@@ -191149,9 +191075,9 @@ declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
/**
- * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
}
/**
@@ -191242,9 +191168,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableRow;
/**
- * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableRowData;
}
/**
@@ -191315,9 +191241,9 @@ declare namespace PowerPoint {
*/
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection;
/**
- * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
- */
+ * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
}
/**
@@ -191852,9 +191778,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.TableStyleSettings;
/**
- * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.TableStyleSettingsData;
}
/**
@@ -191977,9 +191903,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -192544,59 +192470,52 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
* Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum SlideBackgroundGradientFillType {
/**
* Unsupported gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* Linear gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
linear = "Linear",
/**
* Radial gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
radial = "Radial",
/**
* Rectangular gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rectangular = "Rectangular",
/**
* Path gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
path = "Path",
/**
* Shade from title gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
shadeFromTitle = "ShadeFromTitle",
}
@@ -192604,8 +192523,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideBackgroundGradientFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -192614,8 +192532,7 @@ declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
/**
@@ -192640,25 +192557,23 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundGradientFill;
/**
- * 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.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;
}
/**
* Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundGradientFillOptions {
/**
* If provided, specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
}
@@ -192666,393 +192581,337 @@ declare namespace PowerPoint {
* Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum SlideBackgroundPatternFillType {
/**
* Unsupported pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* 5 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent5 = "Percent5",
/**
* 10 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent10 = "Percent10",
/**
* 20 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent20 = "Percent20",
/**
* 25 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent25 = "Percent25",
/**
* 30 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent30 = "Percent30",
/**
* 40 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent40 = "Percent40",
/**
* 50 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent50 = "Percent50",
/**
* 60 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent60 = "Percent60",
/**
* 70 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent70 = "Percent70",
/**
* 75 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent75 = "Percent75",
/**
* 80 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent80 = "Percent80",
/**
* 90 percent pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
percent90 = "Percent90",
/**
* Horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
horizontal = "Horizontal",
/**
* Vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
vertical = "Vertical",
/**
* Light horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightHorizontal = "LightHorizontal",
/**
* Light vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightVertical = "LightVertical",
/**
* Dark horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkHorizontal = "DarkHorizontal",
/**
* Dark vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkVertical = "DarkVertical",
/**
* Narrow horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
narrowHorizontal = "NarrowHorizontal",
/**
* Narrow vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
narrowVertical = "NarrowVertical",
/**
* Dashed horizontal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedHorizontal = "DashedHorizontal",
/**
* Dashed vertical pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedVertical = "DashedVertical",
/**
* Cross pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
cross = "Cross",
/**
* Downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
downwardDiagonal = "DownwardDiagonal",
/**
* Upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
upwardDiagonal = "UpwardDiagonal",
/**
* Light downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightDownwardDiagonal = "LightDownwardDiagonal",
/**
* Light upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
lightUpwardDiagonal = "LightUpwardDiagonal",
/**
* Dark downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkDownwardDiagonal = "DarkDownwardDiagonal",
/**
* Dark upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
darkUpwardDiagonal = "DarkUpwardDiagonal",
/**
* Wide downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
wideDownwardDiagonal = "WideDownwardDiagonal",
/**
* Wide upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
wideUpwardDiagonal = "WideUpwardDiagonal",
/**
* Dashed downward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedDownwardDiagonal = "DashedDownwardDiagonal",
/**
* Dashed upward diagonal pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dashedUpwardDiagonal = "DashedUpwardDiagonal",
/**
* Diagonal cross pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
diagonalCross = "DiagonalCross",
/**
* Small checker board pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
smallCheckerBoard = "SmallCheckerBoard",
/**
* Large checker board pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
largeCheckerBoard = "LargeCheckerBoard",
/**
* Small grid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
smallGrid = "SmallGrid",
/**
* Large grid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
largeGrid = "LargeGrid",
/**
* Dotted grid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dottedGrid = "DottedGrid",
/**
* Small confetti pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
smallConfetti = "SmallConfetti",
/**
* Large confetti pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
largeConfetti = "LargeConfetti",
/**
* Horizontal brick pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
horizontalBrick = "HorizontalBrick",
/**
* Diagonal brick pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
diagonalBrick = "DiagonalBrick",
/**
* Solid diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
solidDiamond = "SolidDiamond",
/**
* Outlined diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
outlinedDiamond = "OutlinedDiamond",
/**
* Dotted diamond pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dottedDiamond = "DottedDiamond",
/**
* Plaid pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
plaid = "Plaid",
/**
* Sphere pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
sphere = "Sphere",
/**
* Weave pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
weave = "Weave",
/**
* Divot pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
divot = "Divot",
/**
* Shingle pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
shingle = "Shingle",
/**
* Wave pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
wave = "Wave",
/**
* Trellis pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
trellis = "Trellis",
/**
* Zig zag pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
zigZag = "ZigZag",
}
@@ -193060,8 +192919,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideBackgroundPatternFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -193070,24 +192928,21 @@ declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor: string;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor: string;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
/**
@@ -193112,41 +192967,37 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundPatternFill;
/**
- * 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.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;
}
/**
* Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundPatternFillOptions {
/**
* If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: string;
/**
* If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: string;
/**
* If provided, specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
}
@@ -193154,8 +193005,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideBackgroundPictureOrTextureFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -193164,16 +193014,14 @@ declare namespace PowerPoint {
* 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.10]
*/
transparency: number;
/**
* Sets the image used to fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param base64EncodedImage A string that is a Base64 encoding of the image data.
*/
@@ -193200,33 +193048,30 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundPictureOrTextureFill;
/**
- * 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.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;
}
/**
* Represents {@link PowerPoint.SlideBackground} picture or texture fill options.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundPictureOrTextureFillOptions {
/**
* If provided, specifies the Base64-encoded image data for the fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
imageBase64?: string;
/**
* If provided, 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.10]
*/
transparency: number;
}
@@ -193234,43 +193079,37 @@ declare namespace PowerPoint {
* Specifies the fill type for a {@link PowerPoint.SlideBackground}.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum SlideBackgroundFillType {
/**
* Unsupported slide background fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
unsupported = "Unsupported",
/**
* Specifies that the slide background should have regular solid fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
solid = "Solid",
/**
* Specifies that the slide background should have gradient fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
gradient = "Gradient",
/**
* Specifies that the slide background should have picture or texture fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pictureOrTexture = "PictureOrTexture",
/**
* Specifies that the slide background should have pattern fill.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern = "Pattern",
}
@@ -193278,8 +193117,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideBackgroundSolidFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -193288,16 +193126,14 @@ declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color: string;
/**
* 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.10]
*/
transparency: number;
/**
@@ -193322,33 +193158,30 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundSolidFill;
/**
- * 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.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;
}
/**
* Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundSolidFillOptions {
/**
* If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: string;
/**
* If provided, 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.10]
*/
transparency?: number;
}
@@ -193356,8 +193189,7 @@ declare namespace PowerPoint {
* Represents the fill formatting of a slide background object.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideBackgroundFill extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -193366,8 +193198,7 @@ declare namespace PowerPoint {
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
/**
@@ -193375,8 +193206,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.10]
*/
getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;
/**
@@ -193384,8 +193214,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.10]
*/
getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;
/**
@@ -193393,8 +193222,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.10]
*/
getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;
/**
@@ -193402,16 +193230,14 @@ 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.10]
*/
getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;
/**
* Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options Options for the gradient fill.
*/
@@ -193420,8 +193246,7 @@ declare namespace PowerPoint {
* Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options Options for the pattern fill.
*/
@@ -193430,8 +193255,7 @@ declare namespace PowerPoint {
* Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options Options for the picture or texture fill.
*/
@@ -193440,8 +193264,7 @@ declare namespace PowerPoint {
* Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options Options for the solid fill.
*/
@@ -193468,17 +193291,16 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackgroundFill;
/**
- * 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.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;
}
/**
* Represents a background of a slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideBackground extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -193487,32 +193309,28 @@ declare namespace PowerPoint {
* Returns the fill formatting of the background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly fill: PowerPoint.SlideBackgroundFill;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed: boolean;
/**
* Resets the fill formatting of the slide background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
reset(): void;
/**
@@ -193537,9 +193355,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideBackground;
/**
- * 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.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideBackgroundData;
}
/**
@@ -193568,8 +193386,7 @@ declare namespace PowerPoint {
* Represents the background of a slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideLayoutBackground extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -193578,32 +193395,28 @@ declare namespace PowerPoint {
* Returns the fill formatting of the background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly fill: PowerPoint.SlideBackgroundFill;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed: boolean;
/**
* Resets the fill formatting of the slide layout background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
reset(): void;
/**
@@ -193628,9 +193441,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideLayoutBackground;
/**
- * 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.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;
}
/**
@@ -193867,106 +193680,91 @@ declare namespace PowerPoint {
* Specifies the theme colors used in PowerPoint.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum ThemeColor {
/**
* Specifies a mixed theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
mixed = "Mixed",
/**
* Specifies no theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
none = "None",
/**
* Specifies the Accent 1 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent1 = "Accent1",
/**
* Specifies the Accent 2 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent2 = "Accent2",
/**
* Specifies the Accent 3 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent3 = "Accent3",
/**
* Specifies the Accent 4 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent4 = "Accent4",
/**
* Specifies the Accent 5 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent5 = "Accent5",
/**
* Specifies the Accent 6 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
accent6 = "Accent6",
/**
* Specifies the Dark 1 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dark1 = "Dark1",
/**
* Specifies the Dark 2 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
dark2 = "Dark2",
/**
* Specifies the clicked hyperlink theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
followedHyperlink = "FollowedHyperlink",
/**
* Specifies the hyperlink theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
hyperlink = "Hyperlink",
/**
* Specifies the Light 1 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
light1 = "Light1",
/**
* Specifies the Light 2 theme color.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
light2 = "Light2",
}
@@ -193974,8 +193772,7 @@ declare namespace PowerPoint {
* Represents a theme color scheme.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class ThemeColorScheme extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -193984,8 +193781,7 @@ declare namespace PowerPoint {
* Gets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color The theme color.
* @returns The color value in #RRGGBB format (e.g., "FFA500").
@@ -193995,8 +193791,7 @@ declare namespace PowerPoint {
* Gets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color The theme color.
* @returns The color value in #RRGGBB format (e.g., "FFA500").
@@ -194006,8 +193801,7 @@ declare namespace PowerPoint {
* Sets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color The theme color.
* @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
@@ -194017,17 +193811,16 @@ declare namespace PowerPoint {
* Sets the color value for the specified `ThemeColor`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param color The theme color.
* @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
*/
setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;
/**
- * 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.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): {
[key: string]: string;
};
@@ -194045,8 +193838,7 @@ declare namespace PowerPoint {
* Gets the background of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly background: PowerPoint.SlideLayoutBackground;
/**
@@ -194067,8 +193859,7 @@ declare namespace PowerPoint {
* Returns the `ThemeColorScheme` of the slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
@@ -194114,9 +193905,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -194188,17 +193979,16 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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 background of a slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class SlideMasterBackground extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -194207,8 +193997,7 @@ declare namespace PowerPoint {
* Returns the fill formatting of the background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly fill: PowerPoint.SlideBackgroundFill;
/**
@@ -194233,9 +194022,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.SlideMasterBackground;
/**
- * 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.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData;
}
/**
@@ -194251,8 +194040,7 @@ declare namespace PowerPoint {
* Gets the background of the Slide Master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly background: PowerPoint.SlideMasterBackground;
/**
@@ -194280,8 +194068,7 @@ declare namespace PowerPoint {
* Returns the `ThemeColorScheme` of the Slide Master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
@@ -194320,9 +194107,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -194370,9 +194157,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -194462,9 +194249,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -194480,8 +194267,7 @@ declare namespace PowerPoint {
* Gets the background of the slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly background: PowerPoint.SlideBackground;
/**
@@ -194530,8 +194316,7 @@ declare namespace PowerPoint {
* Returns the `ThemeColorScheme` of the slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
/**
@@ -194625,24 +194410,22 @@ declare namespace PowerPoint {
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.
- */
+ * 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 the format of an image.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
enum ShapeGetImageFormatType {
/**
* The picture is in PNG format.
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
png = "Png",
}
@@ -194653,16 +194436,14 @@ declare namespace PowerPoint {
The resulting dimensions will automatically be clamped to the maximum supported size if too large.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface ShapeGetImageOptions {
/**
* The desired format of the resulting image.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
format?: PowerPoint.ShapeGetImageFormatType | "Png";
/**
@@ -194670,8 +194451,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a non-positive integer.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
height?: number;
/**
@@ -194679,8 +194459,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when set with a non-positive integer.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
width?: number;
}
@@ -194761,9 +194540,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -194793,8 +194572,7 @@ declare namespace PowerPoint {
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly creationId: string | null;
/**
@@ -194833,9 +194611,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -194949,9 +194727,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -194999,8 +194777,7 @@ declare namespace PowerPoint {
* Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly adjustments: PowerPoint.Adjustments;
/**
@@ -195069,8 +194846,7 @@ declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription: string;
/**
@@ -195081,16 +194857,14 @@ declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle: string;
/**
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
readonly creationId: string | null;
/**
@@ -195114,8 +194888,7 @@ declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative: boolean;
/**
@@ -195150,8 +194923,7 @@ declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation: number;
/**
@@ -195172,8 +194944,7 @@ declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible: boolean;
/**
@@ -195202,8 +194973,7 @@ declare namespace PowerPoint {
* Renders an image of the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options Optional. Options to specify the desired output image properties.
* @returns A Base64-encoded string of the shape image in the specified format.
@@ -195263,16 +195033,14 @@ 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.10]
*/
getTextFrameOrNullObject(): PowerPoint.TextFrame;
/**
* Sets a hyperlink on this `Shape` with the specified options. This will delete any existing hyperlink on this `Shape`.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param options Optional. The options for the hyperlink.
* @returns The newly created {@link PowerPoint.Hyperlink} object.
@@ -195318,9 +195086,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -195382,9 +195150,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -195496,9 +195264,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -195593,9 +195361,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -195651,8 +195419,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception when the index is out of range.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param index The index of the custom property in the collection.
* @returns The custom property at the given index.
@@ -195689,9 +195456,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -195809,9 +195576,9 @@ declare namespace PowerPoint {
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.
- */
+ * 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;
}
/**
@@ -195873,8 +195640,7 @@ declare namespace PowerPoint {
* Represents the page setup information for the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
class PageSetup extends OfficeExtension.ClientObject {
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -195883,16 +195649,14 @@ declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight: number;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth: number;
/**
@@ -195917,9 +195681,9 @@ declare namespace PowerPoint {
expand?: string;
}): PowerPoint.PageSetup;
/**
- * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
- */
+ * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
+ */
toJSON(): PowerPoint.Interfaces.PageSetupData;
}
/**
@@ -195947,8 +195711,7 @@ declare namespace PowerPoint {
Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*
* @param values An array of slide IDs or `Slide` objects.
* @returns A Base64-encoded string.
@@ -196013,9 +195776,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -196033,8 +195796,7 @@ declare namespace PowerPoint {
* Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
* @returns A Base64-encoded string.
*/
exportAsBase64Presentation(): OfficeExtension.ClientResult;
@@ -196096,9 +195858,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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;
}
/**
@@ -196170,9 +195932,9 @@ declare namespace PowerPoint {
*/
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.
- */
+ * 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 {
@@ -196211,8 +195973,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
/**
@@ -196220,8 +195981,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
@@ -196245,8 +196005,7 @@ declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel?: number;
}
@@ -196255,11 +196014,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -196268,11 +196027,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -196288,11 +196047,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -196301,11 +196060,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -196328,11 +196087,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -196341,11 +196100,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -196354,11 +196113,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -196367,11 +196126,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -196696,8 +196455,7 @@ declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
}
@@ -196707,24 +196465,21 @@ declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: string;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: string;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
}
@@ -196734,8 +196489,7 @@ declare namespace PowerPoint {
* 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.10]
*/
transparency?: number;
}
@@ -196745,16 +196499,14 @@ declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: string;
/**
* 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.10]
*/
transparency?: number;
}
@@ -196764,16 +196516,14 @@ declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -196783,16 +196533,14 @@ declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -196872,8 +196620,7 @@ declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: string;
/**
@@ -196884,8 +196631,7 @@ declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: string;
/**
@@ -196902,8 +196648,7 @@ declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -196925,8 +196670,7 @@ declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: number;
/**
@@ -196940,8 +196684,7 @@ declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -197043,16 +196786,14 @@ declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight?: number;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth?: number;
}
@@ -197091,8 +196832,7 @@ declare namespace PowerPoint {
* Specifies the number of adjustment points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
count?: number;
}
@@ -197132,8 +196872,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
/**
@@ -197141,8 +196880,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
/**
@@ -197166,8 +196904,7 @@ declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel?: number;
}
@@ -197176,11 +196913,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **All Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -197189,11 +196926,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
- - `true`: All the text is bold.
+ - `true`: All the text is bold.
- - `false`: None of the text is bold.
+ - `false`: None of the text is bold.
- - `null`: Returned if some, but not all, of the text is bold.
+ - `null`: Returned if some, but not all, of the text is bold.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -197209,11 +196946,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Double strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -197222,11 +196959,11 @@ declare namespace PowerPoint {
/**
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
- - `true`: All the text is italicized.
+ - `true`: All the text is italicized.
- - `false`: None of the text is italicized.
+ - `false`: None of the text is italicized.
- - `null`: Returned if some, but not all, of the text is italicized.
+ - `null`: Returned if some, but not all, of the text is italicized.
*
* @remarks
* [Api set: PowerPointApi 1.4]
@@ -197249,11 +196986,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Small Caps** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -197262,11 +196999,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Strikethrough** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -197275,11 +197012,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Subscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -197288,11 +197025,11 @@ declare namespace PowerPoint {
/**
* 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.
+ - `true`: All the text has the **Superscript** attribute.
- - `false`: None of 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.
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
*
* @remarks
* [Api set: PowerPointApi 1.8]
@@ -197411,8 +197148,7 @@ declare namespace PowerPoint {
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.HyperlinkType | "TextRange" | "Shape";
}
@@ -197735,8 +197471,7 @@ declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
}
@@ -197746,24 +197481,21 @@ declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: string;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: string;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
}
@@ -197773,8 +197505,7 @@ declare namespace PowerPoint {
* 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.10]
*/
transparency?: number;
}
@@ -197784,16 +197515,14 @@ declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: string;
/**
* 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.10]
*/
transparency?: number;
}
@@ -197803,8 +197532,7 @@ declare namespace PowerPoint {
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
}
@@ -197814,16 +197542,14 @@ declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -197833,16 +197559,14 @@ declare namespace PowerPoint {
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -197942,8 +197666,7 @@ declare namespace PowerPoint {
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: string | null;
/**
@@ -198008,8 +197731,7 @@ declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: string;
/**
@@ -198020,16 +197742,14 @@ declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: string;
/**
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: string | null;
/**
@@ -198053,8 +197773,7 @@ declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -198089,8 +197808,7 @@ declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: number;
/**
@@ -198111,8 +197829,7 @@ declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -198267,16 +197984,14 @@ declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight?: number;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth?: number;
}
@@ -198306,19 +198021,18 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the page setup information whose properties control slide setup attributes for the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the page setup information whose properties control slide setup attributes for the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;
/**
- * Gets the properties of the presentation.
- *
- * @remarks
- * [Api set: PowerPointApi 1.7]
- */
+ * Gets the properties of the presentation.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.7]
+ */
properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions;
/**
* Gets the ID of the presentation.
@@ -198339,8 +198053,7 @@ declare namespace PowerPoint {
* Represents the adjustment values for a shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface AdjustmentsLoadOptions {
/**
@@ -198351,8 +198064,7 @@ declare namespace PowerPoint {
* Specifies the number of adjustment points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
count?: boolean;
}
@@ -198440,8 +198152,7 @@ declare namespace PowerPoint {
* Represents a scoped collection of hyperlinks.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface HyperlinkScopedCollectionLoadOptions {
/**
@@ -198466,8 +198177,7 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -198487,8 +198197,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
style?: boolean;
/**
@@ -198496,8 +198205,7 @@ declare namespace PowerPoint {
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
/**
@@ -198537,8 +198245,7 @@ declare namespace PowerPoint {
* Represents the indent level of the paragraph.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
indentLevel?: boolean;
}
@@ -198839,8 +198546,7 @@ declare namespace PowerPoint {
* Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -198900,8 +198606,7 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -198957,46 +198662,46 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the bottom border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the bottom border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
bottom?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (top-left to bottom-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (top-left to bottom-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the diagonal border (bottom-left to top-right).
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the diagonal border (bottom-left to top-right).
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the left border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the left border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
left?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the right border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the right border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
right?: PowerPoint.Interfaces.BorderLoadOptions;
/**
- * Gets the top border.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the top border.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
top?: PowerPoint.Interfaces.BorderLoadOptions;
}
/**
@@ -199084,32 +198789,32 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* Gets the number of table columns this cell spans across.
@@ -199190,32 +198895,32 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the collection of borders for the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
borders?: PowerPoint.Interfaces.BordersLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the fill color of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the fill color of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the font of the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the font of the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the set of margins in the table cell.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * For EACH ITEM in the collection: Gets the set of margins in the table cell.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
/**
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
@@ -199475,11 +199180,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the table style settings.
- *
- * @remarks
- * [Api set: PowerPointApi 1.9]
- */
+ * Gets the table style settings.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.9]
+ */
styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions;
/**
* Gets the number of columns in the table.
@@ -199515,57 +199220,56 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
/**
* For EACH ITEM in the collection: The alt text description of the Shape.
@@ -199574,8 +199278,7 @@ declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: boolean;
/**
@@ -199586,16 +199289,14 @@ declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: boolean;
/**
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -199619,8 +199320,7 @@ declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -199655,8 +199355,7 @@ declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: boolean;
/**
@@ -199677,8 +199376,7 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -199701,8 +199399,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundGradientFillLoadOptions {
/**
@@ -199713,8 +199410,7 @@ declare namespace PowerPoint {
* Specifies the type of gradient fill.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -199722,8 +199418,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundPatternFillLoadOptions {
/**
@@ -199734,24 +199429,21 @@ declare namespace PowerPoint {
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
backgroundColor?: boolean;
/**
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
foregroundColor?: boolean;
/**
* Specifies the pattern type.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
pattern?: boolean;
}
@@ -199759,8 +199451,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundPictureOrTextureFillLoadOptions {
/**
@@ -199771,8 +199462,7 @@ declare namespace PowerPoint {
* 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.10]
*/
transparency?: boolean;
}
@@ -199780,8 +199470,7 @@ declare namespace PowerPoint {
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundSolidFillLoadOptions {
/**
@@ -199792,16 +199481,14 @@ declare namespace PowerPoint {
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
color?: boolean;
/**
* 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.10]
*/
transparency?: boolean;
}
@@ -199809,8 +199496,7 @@ declare namespace PowerPoint {
* Represents the fill formatting of a slide background object.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundFillLoadOptions {
/**
@@ -199821,8 +199507,7 @@ declare namespace PowerPoint {
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
type?: boolean;
}
@@ -199830,8 +199515,7 @@ declare namespace PowerPoint {
* Represents a background of a slide.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideBackgroundLoadOptions {
/**
@@ -199839,27 +199523,24 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the fill formatting of the background.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -199867,8 +199548,7 @@ declare namespace PowerPoint {
* Represents the background of a slide layout.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideLayoutBackgroundLoadOptions {
/**
@@ -199876,27 +199556,24 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the fill formatting of the background.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
/**
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
areBackgroundGraphicsHidden?: boolean;
/**
* Specifies if the slide layout background follows the slide master background.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isMasterBackgroundFollowed?: boolean;
}
@@ -199912,12 +199589,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the background of the slide layout.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
/**
* Gets the unique ID of the slide layout.
@@ -199953,12 +199629,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the slide layout.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the slide layout.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
/**
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
@@ -199986,8 +199661,7 @@ declare namespace PowerPoint {
* Represents the background of a slide master.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface SlideMasterBackgroundLoadOptions {
/**
@@ -199995,12 +199669,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Returns the fill formatting of the background.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Returns the fill formatting of the background.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
}
/**
@@ -200015,12 +199688,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the background of the Slide Master.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
/**
* Gets the unique ID of the Slide Master.
@@ -200101,12 +199773,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * Gets the background of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
/**
* Gets the layout of the slide.
@@ -200149,57 +199820,56 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
/**
- * For EACH ITEM in the collection: Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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]
- */
+ * 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.
+ * 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]
- */
+ *
+ * @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]
- */
+ * 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 {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.5]
+ */
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
/**
* For EACH ITEM in the collection: The alt text description of the Shape.
@@ -200208,8 +199878,7 @@ declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: boolean;
/**
@@ -200220,16 +199889,14 @@ declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: boolean;
/**
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -200253,8 +199920,7 @@ declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -200289,8 +199955,7 @@ declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: boolean;
/**
@@ -200311,8 +199976,7 @@ declare namespace PowerPoint {
* For EACH ITEM in the collection: Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -200353,8 +200017,7 @@ declare namespace PowerPoint {
* Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -200434,54 +200097,53 @@ declare namespace PowerPoint {
* Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;
/**
- * Returns the fill formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the fill formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
/**
- * Returns the `ShapeGroup` associated with the shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
/**
- * Returns the line formatting of this shape.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the line formatting of this shape.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
/**
- * Returns the parent group of this shape.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
/**
- * Returns the properties that apply specifically to this placeholder.
+ * 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]
- */
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.8]
+ */
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
/**
- * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
- *
- * @remarks
- * [Api set: PowerPointApi 1.4]
- */
+ * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.4]
+ */
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
/**
* The alt text description of the Shape.
@@ -200490,8 +200152,7 @@ declare namespace PowerPoint {
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextDescription?: boolean;
/**
@@ -200502,16 +200163,14 @@ declare namespace PowerPoint {
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
altTextTitle?: boolean;
/**
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
creationId?: boolean;
/**
@@ -200535,8 +200194,7 @@ declare namespace PowerPoint {
People using screen readers will hear these are decorative so they know they aren't missing any important information.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
isDecorative?: boolean;
/**
@@ -200571,8 +200229,7 @@ declare namespace PowerPoint {
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
rotation?: boolean;
/**
@@ -200593,8 +200250,7 @@ declare namespace PowerPoint {
* Specifies if the shape is visible.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
visible?: boolean;
/**
@@ -200826,8 +200482,7 @@ declare namespace PowerPoint {
* Represents the page setup information for the presentation.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
interface PageSetupLoadOptions {
/**
@@ -200838,16 +200493,14 @@ declare namespace PowerPoint {
* Specifies the height of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideHeight?: boolean;
/**
* Specifies the width of the slides in the presentation, in points.
*
* @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
+ * [Api set: PowerPointApi 1.10]
*/
slideWidth?: boolean;
}
@@ -200863,26 +200516,25 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.3]
- */
+ * 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]
- */
+ * 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.
@@ -200911,26 +200563,25 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the slide.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
/**
- * For EACH ITEM in the collection: Gets the layout of the slide.
- *
- * @remarks
- * [Api set: PowerPointApi 1.5]
- */
+ * 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]
- */
+ * 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.
@@ -200959,12 +200610,11 @@ declare namespace PowerPoint {
*/
$all?: boolean;
/**
- * For EACH ITEM in the collection: Gets the background of the Slide Master.
- *
- * @remarks
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
- * @beta
- */
+ * For EACH ITEM in the collection: Gets the background of the Slide Master.
+ *
+ * @remarks
+ * [Api set: PowerPointApi 1.10]
+ */
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
/**
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
diff --git a/generate-docs/scripts/midprocessor.ts b/generate-docs/scripts/midprocessor.ts
index 0c602f55d0..8bf6b856a5 100644
--- a/generate-docs/scripts/midprocessor.ts
+++ b/generate-docs/scripts/midprocessor.ts
@@ -8,7 +8,7 @@ const CURRENT_EXCEL_RELEASE = 20;
const OLDEST_EXCEL_RELEASE_WITH_CUSTOM_FUNCTIONS = 9;
const CURRENT_OUTLOOK_RELEASE = 15;
const CURRENT_WORD_RELEASE = 9;
-const CURRENT_POWERPOINT_RELEASE = 9;
+const CURRENT_POWERPOINT_RELEASE = 10;
tryCatch(async () => {
// ----
diff --git a/generate-docs/scripts/postprocessor.ts b/generate-docs/scripts/postprocessor.ts
index 10cefff53f..cf4b8c2445 100644
--- a/generate-docs/scripts/postprocessor.ts
+++ b/generate-docs/scripts/postprocessor.ts
@@ -12,7 +12,7 @@ const HOST_VERSION_MAP = [
{ host: "excel", versions: 21 }, // not including online or desktop
{ host: "onenote", versions: 1 },
{ host: "outlook", versions: 16 },
- { host: "powerpoint", versions: 10 },
+ { host: "powerpoint", versions: 11 },
{ 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 70cd707562..e000a1b5d5 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_9/powerpoint.d.ts',
+ '../api-extractor-inputs-powerpoint-release/PowerPoint_1_10/powerpoint.d.ts',
handleCommonImports(dtsBuilder.extractDtsSection(releaseDefinitions, "Begin PowerPoint APIs", "End PowerPoint APIs"), "Other", true),
"powerpoint",
forceRebuild